Music Remote
Allows direct interaction with the Steam Music player.
Functions
activationSuccess
activationSuccess( bool value )
If remote access was successfully activated.
Returns: bool
isCurrentMusicRemote
isCurrentMusicRemote()
Is a remote music client / host connected?
Returns: bool
currentEntryDidChange
currentEntryDidChange()
Did the currenty music entry just change?
Returns: bool
currentEntryIsAvailable
currentEntryIsAvailable( bool available )
Is the current music entry available?
Returns: bool
currentEntryWillChange
currentEntryWillChange()
Will the current music entry change?
Returns: bool
deregisterSteamMusicRemote
deregisterSteamMusicRemote()
Disconnect from remote music client / host.
Returns: bool
enableLooped
enableLooped( bool value )
Enable track loop on client.
Returns: bool
enablePlaylists
enablePlaylists( bool value )
Enable playlists on client.
Returns: bool
enablePlayNext
enablePlayNext( bool value )
Play the next track on client.
Returns: bool
enablePlayPrevious
enablePlayPrevious( bool value )
Play previous track on client.
Returns: bool
enableQueue
enableQueue( bool value )
Enable the music queue on the client.
Returns: bool
enableShuffled
enableShuffled( bool value )
Enable shuffle on the client.
Returns: bool
playlistDidChange
playlistDidChange()
Has the playlist changed?
Returns: bool
playlistWillChange
playlistWillChange()
Will the playlist change?
Returns: bool
queueDidChange
queueDidChange()
Did the song queue change?
Returns: bool
queueWillChange
queueWillChange()
Will the song queue change?
Returns: bool
registerSteamMusicRemote
registerSteamMusicRemote( string name )
Connect to a music remote client / host?
Returns: bool
resetPlaylistEntries
resetPlaylistEntries()
Reset the playlist entries.
Returns: bool
resetQueueEntries
resetQueueEntries()
Reset the song queue entries.
Returns: bool
setCurrentPlaylistEntry
setCurrentPlaylistEntry( int id )
Set a new current playlist.
Returns: bool
setCurrentQueueEntry
setCurrentQueueEntry( int id )
Set a new current song queue.
Returns: bool
setDisplayName
setDisplayName( string name )
Set a new display name.
Returns: bool
setPlaylistEntry
setPlaylistEntry( int id, int position, string entryText )
Set a new playlist entry.
Returns: bool
setPNGIcon64x64
setPNGIcon64x64( PoolByteArray icon )
Set a PNG icon for a song? A playlist?
Returns: bool
setQueueEntry
setQueueEntry( int id, int position, string entryText )
Set a new queue entry.
Returns: bool
updateCurrentEntryCoverArt
updateCurrentEntryCoverArt( PoolByteArray art )
Update the current song entry's cover art.
Returns: bool
updateCurrentEntryElapsedSeconds
updateCurrentEntryElapsedSeconds( int value )
Update the current seconds that have elapsed for an entry.
Returns: bool
updateCurrentEntryText
updateCurrentEntryText( string text )
Update the current song entry's text?
Returns: bool
updateLooped
updateLooped( bool value )
Update looped or not.
Returns: bool
updatePlaybackStatus
updatePlaybackStatus( int status )
Update the current playback status:
- 0 - undefined
- 1 - playing
- 2 - paused
- 3 - idle.
Returns: bool
updateShuffled
updateShuffled( bool value )
Update whether to shuffle or not.
Returns: bool
updateVolume
updateVolume( float value )
Volume is between 0.0 and 1.0.
Returns: bool
Signals
music_player_remote_to_front
music_player_remote_to_front
There are no notes in the Steamworks documentation.
Returns: nothing
music_player_remote_will_activate
music_player_remote_will_activate
There are no notes in the Steamworks documentation.
Returns: nothing
music_player_remote_will_deactivate
music_player_remote_will_deactivate
There are no notes in the Steamworks documentation.
Returns: nothing
music_player_selects_playlist_entry
music_player_selects_playlist_entry
There are no notes in the Steamworks documentation.
Returns:
- entry (int)
music_player_selects_queue_entry
music_player_selects_queue_entry
There are no notes in the Steamworks documentation.
Returns:
*entry (int)
music_player_wants_looped
music_player_wants_looped
There are no notes in the Steamworks documentation.
Returns:
- looped (bool)
music_player_wants_pause
music_player_wants_pause
There are no notes in the Steamworks documentation.
Returns: nothing
music_player_wants_play
music_player_wants_play
There are no notes in the Steamworks documentation.
Returns: nothing
music_player_wants_play_next
music_player_wants_play_next
There are no notes in the Steamworks documentation.
Returns: nothing
music_player_wants_play_previous
music_player_wants_play_previous
There are no notes in the Steamworks documentation.
Returns: nothing
music_player_wants_playing_repeat_status
music_player_wants_playing_repeat_status
There are no notes in the Steamworks documentation.
Returns:
- status (int)
music_player_wants_shuffled
music_player_wants_shuffled
There are no notes in the Steamworks documentation.
Returns:
- shuffled (bool)
music_player_wants_volume
music_player_wants_volume
There are no notes in the Steamworks documentation.
Returns:
- volume (float)
music_player_will_quit
music_player_will_quit
There are no notes in the Steamworks documentation.
Returns: nothing