ISteamRemotePlay

Note

This documentation is auto-generated. Methods marked with 🤖 are automatically generated bindings. Methods marked with ✍️ are manually implemented and methods marked with ✋ are currently not implemented.

List of Callbacks

RemotePlay.OnSteamRemotePlaySessionConnected()
RemotePlay.OnSteamRemotePlaySessionDisconnected()
RemotePlay.OnSteamRemotePlayTogetherGuestInvite()
RemotePlay.OnSteamRemotePlaySessionAvatarLoaded()

Function Reference

RemotePlay.BEnableRemotePlayTogetherDirectInput()

🤖 Auto-generated binding

Returns:: (bool) Return value
SteamWorks:: BEnableRemotePlayTogetherDirectInput

RemotePlay.BGetSessionClientResolution(unSessionID)

🤖 Auto-generated binding

Parameters:: unSessionID (int - RemotePlaySessionID_t) –
Returns:: (bool) Return value
Returns:: (int) pnResolutionX
Returns:: (int) pnResolutionY
SteamWorks:: BGetSessionClientResolution

Signature differences from C++ API:

Parameter pnResolutionX is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.
Parameter pnResolutionY is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

RemotePlay.BSendRemotePlayTogetherInvite(steamIDFriend)

🤖 Auto-generated binding

Parameters:: steamIDFriend (uint64 - CSteamID) –
Returns:: (bool) Return value
SteamWorks:: BSendRemotePlayTogetherInvite

Example:

if Steam.RemotePlay.BSendRemotePlayTogetherInvite(friendSteamID) then
    print('Remote Play Together invite sent')
end

RemotePlay.BSessionRemotePlayTogether(unSessionID)

🤖 Auto-generated binding

Parameters:: unSessionID (int - RemotePlaySessionID_t) –
Returns:: (bool) Return value
SteamWorks:: BSessionRemotePlayTogether

RemotePlay.CreateMouseCursor(nWidth, nHeight, nHotX, nHotY, pBGRA, nPitch)

🤖 Auto-generated binding

Parameters:

nWidth (int) –
nHeight (int) –
nHotX (int) –
nHotY (int) –
pBGRA (str?) –
nPitch (int) –

Returns:

(int - RemotePlayCursorID_t) Return value

SteamWorks:

CreateMouseCursor

RemotePlay.DisableRemotePlayTogetherDirectInput()

🤖 Auto-generated binding

SteamWorks:: DisableRemotePlayTogetherDirectInput

RemotePlay.GetInput(unMaxEvents)

🤖 Auto-generated binding

Parameters:: unMaxEvents (int?) – size of the buffer to allocate for pInput. If nil then the buffer will be NULL.
Returns:: (int) Return value
Returns:: (RemotePlayInput_t[]) pInput
SteamWorks:: GetInput

Signature differences from C++ API:

Parameter pInput is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

Example:

local nInputs = Steam.RemotePlay.GetInput(nil)
local _, inputs = Steam.RemotePlay.GetInput(nInputs)
for _, input in ipairs(inputs) do
    processInput(input)
end

RemotePlay.GetLargeSessionAvatar(unSessionID)

🤖 Auto-generated binding

Parameters:: unSessionID (int - RemotePlaySessionID_t) –
Returns:: (int) Return value
SteamWorks:: GetLargeSessionAvatar

RemotePlay.GetMediumSessionAvatar(unSessionID)

🤖 Auto-generated binding

Parameters:: unSessionID (int - RemotePlaySessionID_t) –
Returns:: (int) Return value
SteamWorks:: GetMediumSessionAvatar

RemotePlay.GetSessionClientFormFactor(unSessionID)

🤖 Auto-generated binding

Parameters:: unSessionID (int - RemotePlaySessionID_t) –
Returns:: (int - ESteamDeviceFormFactor) Return value
SteamWorks:: GetSessionClientFormFactor

Example:

local formFactor = Steam.RemotePlay.GetSessionClientFormFactor(sessionID)
if formFactor == Steam.k_ESteamDeviceFormFactor_Phone then
    print('Client is on a mobile device')
end

RemotePlay.GetSessionClientName(unSessionID)

🤖 Auto-generated binding

Parameters:: unSessionID (int - RemotePlaySessionID_t) –
Returns:: (str) Return value
SteamWorks:: GetSessionClientName

Notes:

See RemotePlay.GetSessionID()’s example.

RemotePlay.GetSessionCount()

🤖 Auto-generated binding

Returns:: (int) Return value
SteamWorks:: GetSessionCount

Example:

local count = Steam.RemotePlay.GetSessionCount()
print('Active Remote Play sessions:', count)

RemotePlay.GetSessionGuestID(unSessionID)

🤖 Auto-generated binding

Parameters:: unSessionID (int - RemotePlaySessionID_t) –
Returns:: (int) Return value
SteamWorks:: GetSessionGuestID

RemotePlay.GetSessionID(iSessionIndex)

🤖 Auto-generated binding

Parameters:: iSessionIndex (int) –
Returns:: (int - RemotePlaySessionID_t) Return value
SteamWorks:: GetSessionID

Example:

local count = Steam.RemotePlay.GetSessionCount()
for i = 0, count - 1 do
    local sessionID = Steam.RemotePlay.GetSessionID(i)
    local name = Steam.RemotePlay.GetSessionClientName(sessionID)
    print('Remote Play client:', name)
end

RemotePlay.GetSessionSteamID(unSessionID)

🤖 Auto-generated binding

Parameters:: unSessionID (int - RemotePlaySessionID_t) –
Returns:: (uint64 - CSteamID) Return value
SteamWorks:: GetSessionSteamID

Example:

local steamID = Steam.RemotePlay.GetSessionSteamID(sessionID)
print('Remote player:', Steam.Friends.GetFriendPersonaName(steamID))

RemotePlay.GetSmallSessionAvatar(unSessionID)

🤖 Auto-generated binding

Parameters:: unSessionID (int - RemotePlaySessionID_t) –
Returns:: (int) Return value
SteamWorks:: GetSmallSessionAvatar

RemotePlay.SetMouseCursor(unSessionID, unCursorID)

🤖 Auto-generated binding

Parameters:

unSessionID (int - RemotePlaySessionID_t) –
unCursorID (int - RemotePlayCursorID_t) –

SteamWorks:

SetMouseCursor

RemotePlay.SetMousePosition(unSessionID, flNormalizedX, flNormalizedY)

🤖 Auto-generated binding

Parameters:

unSessionID (int - RemotePlaySessionID_t) –
flNormalizedX (float) –
flNormalizedY (float) –

SteamWorks:

SetMousePosition

RemotePlay.SetMouseVisibility(unSessionID, bVisible)

🤖 Auto-generated binding

Parameters:

unSessionID (int - RemotePlaySessionID_t) –
bVisible (bool) –

SteamWorks:

SetMouseVisibility

RemotePlay.ShowRemotePlayTogetherUI()

🤖 Auto-generated binding

Returns:: (bool) Return value
SteamWorks:: ShowRemotePlayTogetherUI

Callbacks

RemotePlay.OnSteamRemotePlaySessionConnected()

Callback for SteamRemotePlaySessionConnected_t

callback(data) receives:

data.m_unSessionID (int - RemotePlaySessionID_t)

Example:

function Steam.RemotePlay.OnSteamRemotePlaySessionConnected(data)
    local name = Steam.RemotePlay.GetSessionClientName(data.m_unSessionID)
    print('Remote Play session connected:', name)
end

RemotePlay.OnSteamRemotePlaySessionDisconnected()

Callback for SteamRemotePlaySessionDisconnected_t

callback(data) receives:

data.m_unSessionID (int - RemotePlaySessionID_t)

Example:

function Steam.RemotePlay.OnSteamRemotePlaySessionDisconnected(data)
    print('Remote Play session disconnected:', data.m_unSessionID)
end

RemotePlay.OnSteamRemotePlayTogetherGuestInvite()

Callback for SteamRemotePlayTogetherGuestInvite_t

callback(data) receives:

data.m_szConnectURL (string)

RemotePlay.OnSteamRemotePlaySessionAvatarLoaded()

Callback for SteamRemotePlaySessionAvatarLoaded_t

callback(data) receives:

data.m_unSessionID (int - RemotePlaySessionID_t)
data.m_iImage (int)
data.m_iWide (int)
data.m_iTall (int)

ISteamRemotePlay

List of Functions

List of Callbacks

Function Reference

Callbacks