ISteamMusic - adambiser/agk-steam-plugin GitHub Wiki

IsMusicEnabled

IsMusicEnabled() as integer

Checks if Steam Music is enabled.

Returns: 1 if Steam Music is enabled; otherwise 0.

Reference:
ISteamMusic#BIsEnabled

IsMusicPlaying

IsMusicPlaying() as integer

Checks if Steam Music is active. This does not necessarily mean that a song is currently playing, it may be paused.

Returns: 1 if Steam Music is active; otherwise 0.

Reference:
ISteamMusic#BIsPlaying

GetMusicPlaybackStatus

GetMusicPlaybackStatus() as integer

Gets the current status of the Steam Music player.

Returns: An AudioPlayback_Status value

Reference:
ISteamMusic#GetPlaybackStatus

GetMusicVolume

GetMusicVolume() as float

Gets the current volume of the Steam Music player.

Returns: The volume is returned as a percentage between 0.0 and 1.0.

Reference:
ISteamMusic#GetVolume

PauseMusic

PauseMusic()

Pause the Steam Music player.

Reference:
ISteamMusic#Pause

PlayMusic

PlayMusic()

Have the Steam Music player resume playing.

Reference:
ISteamMusic#Play

PlayNextSong

PlayNextSong()

Have the Steam Music player skip to the next song.

Reference:
ISteamMusic#PlayNext

PlayPreviousSong

PlayPreviousSong()

Have the Steam Music player play the previous song.

Reference:
ISteamMusic#PlayPrevious

SetMusicVolume

SetMusicVolume(volume as float)

• volume - The volume percentage to set from 0.0 to 1.0.

Sets the volume of the Steam Music player.

Reference:
ISteamMusic#SetVolume

HasMusicPlaybackStatusChangedResponse

HasMusicPlaybackStatusChangedResponse() as integer

Notifies the caller that the music playback status has changed since the last call.

Returns: 1 when a change has occurred; otherwise 0.

Reference:
ISteamMusic#PlaybackStatusHasChanged_t

HasMusicVolumeChangedResponse

HasMusicVolumeChangedResponse() as integer

Notifies the caller that the music volume has changed since the last call.

Returns: 1 when a change has occurred; otherwise 0.

Reference:
ISteamMusic#VolumeHasChanged_t