Functions to control music playback in the steam client.
This gives games the opportunity to do things like pause the music or lower the volume, when an important cut scene is shown, and start playing afterwards.
See Steam Music Player
for more information.
Member functions for
are called through the global accessor function
Checks if Steam Music is enabled.Returns:
if it is enabled; otherwise false
Checks if Steam Music is active. This does not necessarily a song is currently playing, it may be paused.
For finer grain control use GetPlaybackStatus
if a song is currently playing, paused, or queued up to play; otherwise false
Gets the current status of the Steam Music player.Returns: AudioPlayback_Status
Gets the current volume of the Steam Music player.Returns:
The volume is returned as a percentage between 0.0
Pause the Steam Music player.
Have the Steam Music player resume playing.
Have the Steam Music player skip to the next song.
Have the Steam Music player play the previous song.
void SetVolume( float flVolume );
|flVolume||float||The volume percentage to set from 0.0 to 1.0.|
Sets the volume of the Steam Music player.
These are callbacks which can be fired by calling SteamAPI_RunCallbacks
. Many of these will be fired directly in response to the member functions of
This callback has no fields.
These are enums which are defined for use with ISteamMusic.
Specifies the current playback status.
|AudioPlayback_Undefined||0||The Steam music interface probably isn't enabled.|
|AudioPlayback_Playing||1||Steam Music is currently playing.|
|AudioPlayback_Paused||2||Steam Music is currently paused.|
|AudioPlayback_Idle||3||Steam Music is currently stopped.|
These are constants which are defined for use with ISteamMusic.
|STEAMMUSIC_INTERFACE_VERSION||const char *||"STEAMMUSIC_INTERFACE_VERSION001"|