Functions | Music Remote

Here is a list of all the functions available in the GodotSteam module. The descriptions are pulled from the official Steamworks SDK documentation with modifications made to fit GodotSteam's implementation of the functions. Naturally, any GodotSteam-specific functions will be noted as such.


activationSuccess( bool value )

  • If remote access was successfully activated.
  • Returns a bool.

isCurrentMusicRemote()

  • Is a remote music client / host connected?
  • Returns a bool.

currentEntryDidChange()

  • Did the currenty music entry just change?
  • Returns a bool.

currentEntryIsAvailable( bool available )

  • Is the current music entry available?
  • Returns a bool.

currentEntryWillChange()

  • Will the current music entry change?
  • Returns a bool.

deregisterSteamMusicRemote()

  • Disconnect from remote music client / host.
  • Returns a bool.

enableLooped( bool value )

  • Enable track loop on client.
  • Returns a bool.

enablePlaylists( bool value )

  • Enable playlists on client.
  • Returns a bool.

enablePlayNext( bool value )

  • Play the next track on client.
  • Returns a bool.

enablePlayPrevious( bool value )

  • Play previous track on client.
  • Returns a bool.

enableQueue( bool value )

  • Enable the music queue on the client.
  • Returns a bool.

enableShuffled( bool value )

  • Enable shuffle on the client.
  • Returns a bool.

playlistDidChange()

  • Has the playlist changed?
  • Returns a bool.

playlistWillChange()

  • Will the playlist change?
  • Returns a bool.

queueDidChange()

  • Did the song queue change?
  • Returns a bool.

queueWillChange()

  • Will the song queue change?
  • Returns a bool.

registerSteamMusicRemote( string name )

  • Connect to a music remote client / host?
  • Returns a bool.

resetPlaylistEntries()

  • Reset the playlist entries.
  • Returns a bool.

resetQueueEntries()

  • Reset the song queue entries.
  • Returns a bool.

setCurrentPlaylistEntry( int id )

  • Set a new current playlist.
  • Returns a bool.

setCurrentQueueEntry( int id )

  • Set a new current song queue.
  • Returns a bool.

setDisplayName( string name )

  • Set a new display name.
  • Returns a bool.

setPlaylistEntry( int id, int position, string entryText )

  • Set a new playlist entry.
  • Returns a bool.

setPNGIcon64x64(const PoolByteArray& icon )

  • Set a PNG icon for a song? A playlist?
  • Returns a bool.

setQueueEntry( int id, int position, string entryText )

  • Set a new queue entry.
  • Returns a bool.

updateCurrentEntryCoverArt( PoolByteArray art )

  • Update the current song entry's cover art.
  • Returns a bool.

updateCurrentEntryElapsedSeconds( int value )

  • Update the current seconds that have elapsed for an entry.
  • Returns a bool.

updateCurrentEntryText( string text )

  • Update the current song entry's text?
  • Returns a bool.

updateLooped( bool value )

  • Update looped or not.
  • Returns a bool.

updatePlaybackStatus( int status )

  • Update the current playback status; 0 - undefined, 1 - playing, 2 - paused, 3 - idle.
  • Returns a bool.

updateShuffled( bool value )

  • Update whether to shuffle or not.
  • Returns a bool.

updateVolume( float value )

  • Volume is between 0.0 and 1.0.
  • Returns a bool.