Unaffiliated

Home Documentation & Help
Steamworks Documentation
ISteamMusicRemote Interface
Allows direct interaction with the Steam Music player.

See Steam Music Player for more information.

Member Functions

Member functions for ISteamMusicRemote are called through the global accessor function SteamMusicRemote().

BActivationSuccess

bool BActivationSuccess( bool bValue );
NameTypeDescription
bValuebool



Returns: bool

BIsCurrentMusicRemote

bool BIsCurrentMusicRemote();


Returns: bool

CurrentEntryDidChange

bool CurrentEntryDidChange();


Returns: bool

CurrentEntryIsAvailable

bool CurrentEntryIsAvailable( bool bAvailable );
NameTypeDescription
bAvailablebool



Returns: bool

CurrentEntryWillChange

bool CurrentEntryWillChange();
Current Entry

Returns: bool

DeregisterSteamMusicRemote

bool DeregisterSteamMusicRemote();


Returns: bool

EnableLooped

bool EnableLooped( bool bValue );
NameTypeDescription
bValuebool



Returns: bool

EnablePlaylists

bool EnablePlaylists( bool bValue );
NameTypeDescription
bValuebool



Returns: bool

EnablePlayNext

bool EnablePlayNext( bool bValue );
NameTypeDescription
bValuebool



Returns: bool

EnablePlayPrevious

bool EnablePlayPrevious( bool bValue );
NameTypeDescription
bValuebool

Abilities for the user interface

Returns: bool

EnableQueue

bool EnableQueue( bool bValue );
NameTypeDescription
bValuebool



Returns: bool

EnableShuffled

bool EnableShuffled( bool bValue );
NameTypeDescription
bValuebool



Returns: bool

PlaylistDidChange

bool PlaylistDidChange();


Returns: bool

PlaylistWillChange

bool PlaylistWillChange();
Playlist

Returns: bool

QueueDidChange

bool QueueDidChange();


Returns: bool

QueueWillChange

bool QueueWillChange();
Queue

Returns: bool

RegisterSteamMusicRemote

bool RegisterSteamMusicRemote( const char *pchName );
NameTypeDescription
pchNameconst char *

Service Definition

Returns: bool

ResetPlaylistEntries

bool ResetPlaylistEntries();


Returns: bool

ResetQueueEntries

bool ResetQueueEntries();


Returns: bool

SetCurrentPlaylistEntry

bool SetCurrentPlaylistEntry( int nID );
NameTypeDescription
nIDint



Returns: bool

SetCurrentQueueEntry

bool SetCurrentQueueEntry( int nID );
NameTypeDescription
nIDint



Returns: bool

SetDisplayName

bool SetDisplayName( const char *pchDisplayName );
NameTypeDescription
pchDisplayNameconst char *



Returns: bool

SetPlaylistEntry

bool SetPlaylistEntry( int nID, int nPosition, const char *pchEntryText );
NameTypeDescription
nIDint
nPositionint
pchEntryTextconst char *



Returns: bool

SetPNGIcon_64x64

bool SetPNGIcon_64x64( void *pvBuffer, uint32 cbBufferLength );
NameTypeDescription
pvBuffervoid *
cbBufferLengthuint32



Returns: bool

SetQueueEntry

bool SetQueueEntry( int nID, int nPosition, const char *pchEntryText );
NameTypeDescription
nIDint
nPositionint
pchEntryTextconst char *



Returns: bool

UpdateCurrentEntryCoverArt

bool UpdateCurrentEntryCoverArt( void *pvBuffer, uint32 cbBufferLength );
NameTypeDescription
pvBuffervoid *
cbBufferLengthuint32



Returns: bool

UpdateCurrentEntryElapsedSeconds

bool UpdateCurrentEntryElapsedSeconds( int nValue );
NameTypeDescription
nValueint



Returns: bool

UpdateCurrentEntryText

bool UpdateCurrentEntryText( const char *pchText );
NameTypeDescription
pchTextconst char *



Returns: bool

UpdateLooped

bool UpdateLooped( bool bValue );
NameTypeDescription
bValuebool



Returns: bool

UpdatePlaybackStatus

bool UpdatePlaybackStatus( AudioPlayback_Status nStatus );
NameTypeDescription
nStatusAudioPlayback_Status

Status

Returns: bool

UpdateShuffled

bool UpdateShuffled( bool bValue );
NameTypeDescription
bValuebool



Returns: bool

UpdateVolume

bool UpdateVolume( float flValue );
NameTypeDescription
flValuefloat



Returns: bool

Callbacks

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 ISteamMusicRemote.

MusicPlayerRemoteToFront_t



This callback has no fields.

MusicPlayerRemoteWillActivate_t



This callback has no fields.

MusicPlayerRemoteWillDeactivate_t



This callback has no fields.

MusicPlayerSelectsPlaylistEntry_t



NameTypeDescription
nIDint

MusicPlayerSelectsQueueEntry_t



NameTypeDescription
nIDint

MusicPlayerWantsLooped_t



NameTypeDescription
m_bLoopedbool

MusicPlayerWantsPause_t



This callback has no fields.

MusicPlayerWantsPlayingRepeatStatus_t



NameTypeDescription
m_nPlayingRepeatStatusint

MusicPlayerWantsPlayNext_t



This callback has no fields.

MusicPlayerWantsPlayPrevious_t



This callback has no fields.

MusicPlayerWantsPlay_t



This callback has no fields.

MusicPlayerWantsShuffled_t



NameTypeDescription
m_bShuffledbool

MusicPlayerWantsVolume_t



NameTypeDescription
m_flNewVolumefloat

MusicPlayerWillQuit_t



This callback has no fields.

Constants

These are constants which are defined for use with ISteamMusicRemote.

NameTypeValueDescription
k_SteamMusicNameMaxLengthint255
k_SteamMusicPNGMaxLengthint65535
STEAMMUSICREMOTE_INTERFACE_VERSIONconst char *"STEAMMUSICREMOTE_INTERFACE_VERSION001"