Functions | Remote Play

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.


getSessionCount()

  • Get the number of currently connected Steam Remote Play sessions.
  • Returns an int. Returns a uint32.

getSessionID( int index ) getSessionID( uint32 index )

  • Get the currently connected Steam Remote Play session ID at the specified index.
  • Returns an int. Returns a uint32.

getSessionSteamID( int session_id ) getSessionSteamID( uint32 session_id )

  • Get the Steam ID of the connected user.
  • Returns an int. Returns a uint64_t.

getSessionClientName( int session_id ) getSessionClientName( uint64_t session_id )

  • Get the name of the session client device.
  • Returns a string.

getSessionClientFormFactor( int session_id ) getSessionClientFormFactor( uint32 session_id )

  • Get the form factor of the session client device.
  • Returns an int.

getSessionClientResolution( int session_id ) getSessionClientResolution( uint32 session_id )

  • Get the resolution, in pixels, of the session client device. This is set to 0x0 if the resolution is not available.
  • Returns a dictionary:
    • success (bool)
    • x (int)
    • y (int)

sendRemotePlayTogetherInvite( int friend_id ) sendRemotePlayTogetherInvite( uint64_t friend_id )

  • Invite a friend to join the game using Remote Play Together.
  • Returns a bool.