Remote Play

Functions that provide information about Steam Remote Play sessions, streaming your game content to another computer or to a Steam Link app or hardware. See Steam Remote Play for more information.

Only available in the main GodotSteam branches

Functions

getSessionClientFormFactor

getSessionClientFormFactor( uint32 session_id )

Get the form factor of the session client device.

Returns: int

getSessionClientName

getSessionClientName( uint64_t session_id )

Get the name of the session client device.

Returns: string

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)

getSessionCount

getSessionCount()

Get the number of currently connected Steam Remote Play sessions.

Returns: uint32

getSessionID

getSessionID( uint32 index )

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

Returns: uint32

getSessionSteamID

getSessionSteamID( uint32 session_id )

Get the Steam ID of the connected user.

Returns: uint64_t

sendRemotePlayTogetherInvite

sendRemotePlayTogetherInvite( uint64_t friend_id )

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

Returns: bool

startRemotePlayTogether

startRemotePlayTogether( bool show_overlay )

Start Remote Play Together and optionally show the UI in the overlay. This returns false if Remote Play Together can't be started or your game is not configured for Remote Play Together.

Returns: bool

Signals

These callbacks require you to run Steam.run_callbacks() in your _process() function to receive them.

remote_play_session_connected

Called when a player connects to a remote play session.

Returns:

session_id (uint32)

remote_play_session_disconnected

Called when a player disconnects from a remote play session.

Returns:

session_id (uint32)