Music Remote

Allows direct interaction with the Steam Music player. These functions only work with soundtracks you purchased or own on Steam. See features / music_player for more information.

This class has absolutely no notes in either the SDK nor Valve's online documentation; everything here is assumed.

Only available in the main GodotSteam branches

Functions

activationSuccess

activationSuccess( bool activate )

Parameter	Type	Notes
activate	bool	-

Was the Music Remote activation successful? It is unclear what activate actually refers to though or if this is setting the activation as successful.

Returns: bool

isCurrentMusicRemote

isCurrentMusicRemote( )

Is a remote music client / host connected?

Returns: bool

Return true if Music Remote is currently active; otherwise, false.

currentEntryDidChange

currentEntryDidChange( )

Did the currenty music entry just change?

Returns: bool

Returns true if the current music entry did change; otherwise, false if not.

currentEntryIsAvailable

currentEntryIsAvailable( bool available )

Parameter	Type	Notes
available	bool	Whether or not the current entry is available.

Is the current music entry available?

Returns: bool

Returns true if the current music entry is available; otherwise, false if not.

currentEntryWillChange

currentEntryWillChange( )

Will the current music entry change?

Returns: bool

Returns true if the current music entry will change; otherwise, false if not.

deregisterSteamMusicRemote

deregisterSteamMusicRemote( )

Disconnect from remote music client / host.

Returns: bool

Returns true if Steam Music Remote was deregistered; otherwise, false if not.

enableLooped

enableLooped( bool enable_loop )

Parameter	Type	Notes
enable_loop	bool	Whether or not to enable track looping.

Enable track looping.

Returns: bool

Returns true if track looping was enabled; otherwise, false if not.

enablePlaylists

enablePlaylists( bool enable_playlists )

Parameter	Type	Notes
enable_playlists	bool	Whether or not to enable playlists.

Enable playlists on client.

Returns: bool

Returns true if playlists were enabled; otherwise, false if not.

enablePlayNext

enablePlayNext( bool enable_next )

Parameter	Type	Notes
enable_next	bool	Whether or not to enable play next.

Enable the play next command?

Returns: bool

Returns true if play next is enabled; otherwise, false.

enablePlayPrevious

enablePlayPrevious( bool enable_previous )

Parameter	Type	Notes
enable_previous	bool	Whether or not to enable play previous.

Play previous track on client.

Returns: bool

Returns true if play previous is enabled; otherwise, false.

enableQueue

enableQueue( bool enable_queue )

Parameter	Type	Notes
enable_queue	bool	Whether or not to enable the queue.

Enable the music queue on the client.

Returns: bool

Returns true if the queue is enabled; otherwise, false.

enableShuffled

enableShuffled( bool enable_shuffle )

Parameter	Type	Notes
enable_shuffle	bool	Whether or not to enable shuffle.

Enable shuffle on the client.

Returns: bool

Returns true if shuffle is enabled; otherwise, false.

playlistDidChange

playlistDidChange( )

Has the playlist changed?

Returns: bool

Returns true if the playlist changed; otherwise, false.

playlistWillChange

playlistWillChange( )

Will the playlist change?

Returns: bool

Returns true if the playlist will change; otherwise, false.

queueDidChange

queueDidChange( )

Did the song queue change?

Returns: bool

Returns true if the queue did change; otherwise, false.

queueWillChange

queueWillChange( )

Will the song queue change?

Returns: bool

Returns true if the queue will change; otherwise, false.

registerSteamMusicRemote

registerSteamMusicRemote( string name )

Parameter	Type	Notes
name	string	THe name of this Music Remote session?

Connect to a music remote client / host?

Returns: bool

Returns true if the Music Remote session was registered successfully; otherwise, false.

resetPlaylistEntries

resetPlaylistEntries( )

Reset the playlist entries.

Returns: bool

Returns true if the playlist entries were reset; otherwise, false.

resetQueueEntries

resetQueueEntries( )

Reset the song queue entries.

Returns: bool

Returns true if the queue entries were reset; otherwise, false.

setCurrentPlaylistEntry

setCurrentPlaylistEntry( int id )

Parameter	Type	Notes
id	int	The current playlist entry to set.

Set a new current playlist.

Returns: bool

Returns true if the playlist entry was set successfully; otherwise, false.

setCurrentQueueEntry

setCurrentQueueEntry( int id )

Parameter	Type	Notes
id	int	The current queue entry to set.

Set a new current song queue.

Returns: bool

Returns true if the queue entry was set successfully; otherwise, false.

setDisplayName

setDisplayName( string name )

Parameter	Type	Notes
name	string	The display name to set.

Set a new display name.

Returns: bool

Returns true if the display name was set successfully; otherwise, false.

setPlaylistEntry

setPlaylistEntry( int id, int position, string entry_text )

Parameter	Type	Notes
id	int	The ID of the entry to set.
position	int	The position in the playlist to set it to.
entry_text	string	The name of the entry.

Set a new playlist entry.

Returns: bool

Returns true if the playlist entry was set successfully; otherwise, false.

setPNGIcon64x64

setPNGIcon64x64( PackedByteArray icon )

Parameter	Type	Notes
icon	PackedByteArray	The icon data to set.

Set a PNG icon for a song? A playlist?

Returns: bool

Returns true if the icon was set successfully; otherwise, false.

setQueueEntry

setQueueEntry( int id, int position, string entry_text )

Parameter	Type	Notes
id	int	The ID of the entry to set.
position	int	The position in the queue to set it to.
entry_text	string	The name of the entry.

Set a new queue entry.

Returns: bool

Returns true if the queue entry was set successfully; otherwise, false.

updateCurrentEntryCoverArt

updateCurrentEntryCoverArt( PackedByteArray art )

Parameter	Type	Notes
art	PackedByteArray	The icon data to set.

Update the current song entry's cover art.

Returns: bool

Returns true if the current entry's cover art was set successfully; otherwise, false.

updateCurrentEntryElapsedSeconds

updateCurrentEntryElapsedSeconds( int seconds )

Parameter	Type	Notes
seconds	int	The amount of elapsed seconds to set.

Update the current seconds that have elapsed for an entry.

Returns: bool

Returns true if the elapsed seconds were set successfully; otherwise, false.

updateCurrentEntryText

updateCurrentEntryText( string text )

Parameter	Type	Notes
text	string	The text to set for the current entry.

Update the current song entry's text?

Returns: bool

Returns true if the current entry's text was set successfully; otherwise, false.

updateLooped

updateLooped( bool looped )

Parameter	Type	Notes
looped	bool	Whether or not to update the looped status?

Update looped or not.

Returns: bool

Returns true if the looped status was set successfully; otherwise, false.

updatePlaybackStatus

updatePlaybackStatus( AudioPlaybackStatus status )

Parameter	Type	Notes
status	AudioPlaybackStatus enum	The current playback status to set.

Update the current playback status.

Returns: bool

Returns true if the playback status was set successfully; otherwise, false.

updateShuffled

updateShuffled( bool shuffle )

Parameter	Type	Notes
shuffle	bool	Whether or not to update shuffle?

Update whether to shuffle or not.

Returns: bool

Returns true if shuffled was set successfully; otherwise, false.

updateVolume

updateVolume( float volume )

Parameter	Type	Notes
volume	float	The updated volume level to set.

Volume is between 0.0 and 1.0.

Returns: bool

Returns true if the volume was set successfully; otherwise, false.

Signals

These callbacks require you to setup one of the three callback methods to receive them.

music_player_remote_to_front

There are no notes in the Steamworks documentation.

Returns

Nothing.

music_player_remote_will_activate

Signals when the Music Remote session will activate.

Returns

Nothing.

music_player_remote_will_deactivate

Signals when the Music Remote session will deactivate.

Returns

Nothing.

music_player_selects_playlist_entry

Signals when a playlist entry has been selected.

Returns

Key	Type	Notes
entry	int	The entry that was selected.

music_player_selects_queue_entry

Signals when a queue entry has been selected.

Returns

Key	Type	Notes
entry	int	The entry that was selected.

music_player_wants_looped

Signals when the remote session wants a track looped.

Returns

Key	Type	Notes
looped	bool	Whether or not the remote session selected looped.

music_player_wants_pause

Signals when the remote session wants music paused.

Returns

Nothing.

music_player_wants_play

Signals when the remote session wants music played.

Returns

Nothing.

music_player_wants_play_next

Signals when the remote session wants the next entry played.

Returns

Nothing.

music_player_wants_play_previous

Signals when the remote session wants the previous entry played.

Returns

Nothing.

music_player_wants_playing_repeat_status

Signals when the remote session has a playing repeat status update.

Returns

Key	Type	Notes
status	int	-

music_player_wants_shuffled

Signals when the Steam music interface wants to change shuffled status.

Returns

Key	Type	Notes
shuffled	bool	Whether it is shuffled or not.

music_player_wants_volume

Signals the Steam music interface has a new volume.

Returns

Key	Type	Notes
new_volume	float	The new volume level; between 0.0 and 1.0.

music_player_will_quit

Signals that the Steam music interface will now quit.

Returns

Nothing.

Constants

Name	SDK Name	Value	Details
MUSIC_NAME_MAX_LENGTH	k_SteamMusicNameMaxLength	255	-
MUSIC_PNG_MAX_LENGTH	k_SteamMusicPNGMaxLength	65535	-