Allows direct interaction with the Steam Music player.
See
features/music_player for more information.
Member Functions
Member functions for
ISteamMusicRemote are called through the global accessor function
SteamMusicRemote().
BActivationSuccess
bool BActivationSuccess( bool bValue );
| Name | Type | Description |
|---|
| bValue | bool | |
Returns: bool
BIsCurrentMusicRemote
bool BIsCurrentMusicRemote();
Returns: bool
CurrentEntryDidChange
bool CurrentEntryDidChange();
Returns: bool
CurrentEntryIsAvailable
bool CurrentEntryIsAvailable( bool bAvailable );
| Name | Type | Description |
|---|
| bAvailable | bool | |
Returns: bool
CurrentEntryWillChange
bool CurrentEntryWillChange();
Current Entry
Returns: bool
DeregisterSteamMusicRemote
bool DeregisterSteamMusicRemote();
Returns: bool
EnableLooped
bool EnableLooped( bool bValue );
| Name | Type | Description |
|---|
| bValue | bool | |
Returns: bool
EnablePlaylists
bool EnablePlaylists( bool bValue );
| Name | Type | Description |
|---|
| bValue | bool | |
Returns: bool
EnablePlayNext
bool EnablePlayNext( bool bValue );
| Name | Type | Description |
|---|
| bValue | bool | |
Returns: bool
EnablePlayPrevious
bool EnablePlayPrevious( bool bValue );
| Name | Type | Description |
|---|
| bValue | bool | |
Abilities for the user interface
Returns: bool
EnableQueue
bool EnableQueue( bool bValue );
| Name | Type | Description |
|---|
| bValue | bool | |
Returns: bool
EnableShuffled
bool EnableShuffled( bool bValue );
| Name | Type | Description |
|---|
| bValue | bool | |
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 );
| Name | Type | Description |
|---|
| pchName | const char * | |
Service Definition
Returns: bool
ResetPlaylistEntries
bool ResetPlaylistEntries();
Returns: bool
ResetQueueEntries
bool ResetQueueEntries();
Returns: bool
SetCurrentPlaylistEntry
bool SetCurrentPlaylistEntry( int nID );
| Name | Type | Description |
|---|
| nID | int | |
Returns: bool
SetCurrentQueueEntry
bool SetCurrentQueueEntry( int nID );
| Name | Type | Description |
|---|
| nID | int | |
Returns: bool
SetDisplayName
bool SetDisplayName( const char *pchDisplayName );
| Name | Type | Description |
|---|
| pchDisplayName | const char * | |
Returns: bool
SetPlaylistEntry
bool SetPlaylistEntry( int nID, int nPosition, const char *pchEntryText );
| Name | Type | Description |
|---|
| nID | int | |
| nPosition | int | |
| pchEntryText | const char * | |
Returns: bool
SetPNGIcon_64x64
bool SetPNGIcon_64x64( void *pvBuffer, uint32 cbBufferLength );
| Name | Type | Description |
|---|
| pvBuffer | void * | |
| cbBufferLength | uint32 | |
Returns: bool
SetQueueEntry
bool SetQueueEntry( int nID, int nPosition, const char *pchEntryText );
| Name | Type | Description |
|---|
| nID | int | |
| nPosition | int | |
| pchEntryText | const char * | |
Returns: bool
UpdateCurrentEntryCoverArt
bool UpdateCurrentEntryCoverArt( void *pvBuffer, uint32 cbBufferLength );
| Name | Type | Description |
|---|
| pvBuffer | void * | |
| cbBufferLength | uint32 | |
Returns: bool
UpdateCurrentEntryElapsedSeconds
bool UpdateCurrentEntryElapsedSeconds( int nValue );
| Name | Type | Description |
|---|
| nValue | int | |
Returns: bool
UpdateCurrentEntryText
bool UpdateCurrentEntryText( const char *pchText );
| Name | Type | Description |
|---|
| pchText | const char * | |
Returns: bool
UpdateLooped
bool UpdateLooped( bool bValue );
| Name | Type | Description |
|---|
| bValue | bool | |
Returns: bool
UpdatePlaybackStatus
bool UpdatePlaybackStatus( AudioPlayback_Status nStatus );
Status
Returns: bool
UpdateShuffled
bool UpdateShuffled( bool bValue );
| Name | Type | Description |
|---|
| bValue | bool | |
Returns: bool
UpdateVolume
bool UpdateVolume( float flValue );
| Name | Type | Description |
|---|
| flValue | float | |
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
| Name | Type | Description |
|---|
| nID | int | |
MusicPlayerSelectsQueueEntry_t
| Name | Type | Description |
|---|
| nID | int | |
MusicPlayerWantsLooped_t
| Name | Type | Description |
|---|
| m_bLooped | bool | |
MusicPlayerWantsPause_t
This callback has no fields.
MusicPlayerWantsPlayingRepeatStatus_t
| Name | Type | Description |
|---|
| m_nPlayingRepeatStatus | int | |
MusicPlayerWantsPlayNext_t
This callback has no fields.
MusicPlayerWantsPlayPrevious_t
This callback has no fields.
MusicPlayerWantsPlay_t
This callback has no fields.
MusicPlayerWantsShuffled_t
| Name | Type | Description |
|---|
| m_bShuffled | bool | |
MusicPlayerWantsVolume_t
| Name | Type | Description |
|---|
| m_flNewVolume | float | |
MusicPlayerWillQuit_t
This callback has no fields.
Constants
These are constants which are defined for use with ISteamMusicRemote.
| Name | Type | Value | Description |
|---|
| k_SteamMusicNameMaxLength | int | 255 | |
| k_SteamMusicPNGMaxLength | int | 65535 | |
| STEAMMUSICREMOTE_INTERFACE_VERSION | const char * | "STEAMMUSICREMOTE_INTERFACE_VERSION001" | |
