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
This class has been removed as of Steamworks SDK 1.63 and no longer exists in GodotSteam as of versions 3.31 / 4.17
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
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
isCurrentMusicRemote
isCurrentMusicRemote( )
Is a remote music client / host connected?
Returns: bool
Return true if Music Remote is currently active; otherwise, false.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
currentEntryDidChange
currentEntryDidChange( )
Did the currenty music entry just change?
Returns: bool
Returns true if the current music entry did change; otherwise, false if not.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
currentEntryWillChange
currentEntryWillChange( )
Will the current music entry change?
Returns: bool
Returns true if the current music entry will change; otherwise, false if not.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
deregisterSteamMusicRemote
deregisterSteamMusicRemote( )
Disconnect from remote music client / host.
Returns: bool
Returns true if Steam Music Remote was deregistered; otherwise, false if not.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
playlistDidChange
playlistDidChange( )
Has the playlist changed?
Returns: bool
Returns true if the playlist changed; otherwise, false.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
playlistWillChange
playlistWillChange( )
Will the playlist change?
Returns: bool
Returns true if the playlist will change; otherwise, false.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
queueDidChange
queueDidChange( )
Did the song queue change?
Returns: bool
Returns true if the queue did change; otherwise, false.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
queueWillChange
queueWillChange( )
Will the song queue change?
Returns: bool
Returns true if the queue will change; otherwise, false.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
resetPlaylistEntries
resetPlaylistEntries( )
Reset the playlist entries.
Returns: bool
Returns true if the playlist entries were reset; otherwise, false.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
resetQueueEntries
resetQueueEntries( )
Reset the song queue entries.
Returns: bool
Returns true if the queue entries were reset; otherwise, false.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
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.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
Signals
These callbacks require you to setup one of the three callback methods to receive them.
music_player_remote_to_front
music_player_remote_to_front
There are no notes in the Steamworks documentation.
Returns
Nothing.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_remote_will_activate
music_player_remote_will_activate
Signals when the Music Remote session will activate.
Returns
Nothing.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_remote_will_deactivate
music_player_remote_will_deactivate
Signals when the Music Remote session will deactivate.
Returns
Nothing.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_selects_playlist_entry
music_player_selects_playlist_entry
Signals when a playlist entry has been selected.
Returns
| Key | Type | Notes |
|---|---|---|
| entry | int | The entry that was selected. |
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_selects_queue_entry
music_player_selects_queue_entry
Signals when a queue entry has been selected.
Returns
| Key | Type | Notes |
|---|---|---|
| entry | int | The entry that was selected. |
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_wants_looped
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. |
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_wants_pause
music_player_wants_pause
Signals when the remote session wants music paused.
Returns
Nothing.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_wants_play
music_player_wants_play
Signals when the remote session wants music played.
Returns
Nothing.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_wants_play_next
music_player_wants_play_next
Signals when the remote session wants the next entry played.
Returns
Nothing.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_wants_play_previous
music_player_wants_play_previous
Signals when the remote session wants the previous entry played.
Returns
Nothing.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_wants_playing_repeat_status
music_player_wants_playing_repeat_status
Signals when the remote session has a playing repeat status update.
Returns
| Key | Type | Notes |
|---|---|---|
| status | int | - |
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_wants_shuffled
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. |
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_wants_volume
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. |
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
music_player_will_quit
music_player_will_quit
Signals that the Steam music interface will now quit.
Returns
Nothing.
Read more in the official Steamworks SDK documentation Removed GodotSteam 4.17 Removed GodotSteam 3.31
Constants
| Name | SDK Name | Value | Details |
|---|---|---|---|
| MUSIC_NAME_MAX_LENGTH | k_SteamMusicNameMaxLength | 255 | - |
| MUSIC_PNG_MAX_LENGTH | k_SteamMusicPNGMaxLength | 65535 | - |