Functions | Music

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.


musicIsEnabled()

  • Checks if Steam Music is enabled.
  • Returns a bool.

musicIsPlaying()

  • Checks if Steam Music is active. This does not necessarily a song is currently playing, it may be paused.
  • For finer grain control use getPlaybackStatus.
  • Returns a bool.

getPlaybackStatus()

  • Gets the current status of the Steam Music player.
  • Returns an int.

musicGetVolume()

  • Gets the current volume of the Steam Music player.
  • Returns a float.

musicPause()

  • Pause the Steam Music player.
  • Returns nothing; void.

musicPlay()

  • Have the Steam Music player resume playing.
  • Returns nothing; void.

musicPlayNext()

  • Have the Steam Music player skip to the next song.
  • Returns nothing; void.

musicPlayPrev()

  • Have the Steam Music player play the previous song.
  • Returns nothing; void.

musicSetVolume( float value )

  • Sets the volume of the Steam Music player.
  • Returns nothing; void.