Skip to content

Functions - Remote Play


getSessionClientFormFactor

getSessionClientFormFactor( uint32 session_id )

Get the form factor of the session client device.

Returns: int


Read more in the official Steamworks SDK documentation

getSessionClientName

getSessionClientName( uint64_t session_id )

Get the name of the session client device.

Returns: string


Read more in the official Steamworks SDK documentation

getSessionClientResolution

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: dictionary

Contains the following keys:

  • success (bool)
  • x (int)
  • y (int)

Read more in the official Steamworks SDK documentation

getSessionCount

getSessionCount()

Get the number of currently connected Steam Remote Play sessions.

Returns: uint32


Read more in the official Steamworks SDK documentation

getSessionID

getSessionID( uint32 index )

Get the currently connected Steam Remote Play session ID at the specified index.

Returns: uint32


Read more in the official Steamworks SDK documentation

getSessionSteamID

getSessionSteamID( uint32 session_id )

Get the Steam ID of the connected user.

Returns: uint64_t


Read more in the official Steamworks SDK documentation

sendRemotePlayTogetherInvite

sendRemotePlayTogetherInvite( uint64_t friend_id )

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

Returns: bool


Read more in the official Steamworks SDK documentation