ISteamMusic

Note

This documentation is auto-generated. Methods marked with 🤖 are automatically generated bindings. Methods marked with ✍️ are manually implemented and methods marked with ✋ are currently not implemented.

List of Functions

Music.BIsEnabled()
Music.BIsPlaying()
Music.GetPlaybackStatus()
Music.GetVolume()
Music.Pause()
Music.Play()
Music.PlayNext()
Music.PlayPrevious()
Music.SetVolume()

Function Reference

Music.BIsEnabled()

🤖 Auto-generated binding

Returns:: (bool) Return value
SteamWorks:: BIsEnabled

Example:

if Steam.Music.BIsEnabled() then
    print('Steam Music is enabled')
end

Music.BIsPlaying()

🤖 Auto-generated binding

Returns:: (bool) Return value
SteamWorks:: BIsPlaying

Example:

if Steam.Music.BIsPlaying() then
    print('Current status: ' .. Steam.Music.GetPlaybackStatus())
end

Music.GetPlaybackStatus()

🤖 Auto-generated binding

Returns:: (int - AudioPlayback_Status) Return value
SteamWorks:: GetPlaybackStatus

Example:

local status = Steam.Music.GetPlaybackStatus()
-- 0=Undefined, 1=Playing, 2=Paused, 3=Idle
if status == 1 then
    print('Music is playing')
end

Music.GetVolume()

🤖 Auto-generated binding

Returns:: (float) Return value
SteamWorks:: GetVolume

Music.Pause()

🤖 Auto-generated binding

SteamWorks:: Pause

Example:

if Steam.Music.BIsPlaying() then
    Steam.Music.Pause()
end

Music.Play()

🤖 Auto-generated binding

SteamWorks:: Play

Example:

if not Steam.Music.BIsPlaying() then
    Steam.Music.Play()
end

Music.PlayNext()

🤖 Auto-generated binding

SteamWorks:: PlayNext

Example:

Steam.Music.PlayNext()

Music.PlayPrevious()

🤖 Auto-generated binding

SteamWorks:: PlayPrevious

Music.SetVolume(flVolume)

🤖 Auto-generated binding

Parameters:: flVolume (float) –
SteamWorks:: SetVolume

Example:

Steam.Music.SetVolume(0.5)  -- Set to 50%

Callbacks

Music.OnPlaybackStatusHasChanged()

Callback for PlaybackStatusHasChanged_t

callback(data) receives no fields (notification only).

Example:

function Steam.Music.OnPlaybackStatusHasChanged()
    local status = Steam.Music.GetPlaybackStatus()
    print('Music status changed:', status)
end

Music.OnVolumeHasChanged()

Callback for VolumeHasChanged_t

callback(data) receives:

data.m_flNewVolume (float)

Example:

function Steam.Music.OnVolumeHasChanged(data)
    print('Music volume changed to:', data.m_flNewVolume)
end