RemotePlay.Client

Introduction

1
using RemotePlay = HeathenEngineering.SteamworksIntegration.API.RemotePlay.Client;
Copied!
1
public static class RemotePlay.Client
Copied!

What can it do?

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

Events

Session Connected

Called when a session connects

Session Disconnected

Called when a session disconnects

How To

Get Session Counts

Get the number of currently connected sessions
1
var count = API.RemotePlay.Client.GetSessionCounts();
Copied!

Get Sessions

Get the collection of current remote play sessions
1
var sessions = API.RemotePlay.Client.GetSessions();
Copied!

Get Session User

Gets the user data of the connected session user
1
var user = API.RemotePlay.Client.GetSessionUser(session);
Copied!

Get Session Client Name

Gets the name of the session client device
1
var name = API.RemotePlay.Client.GetSessionClientName(session);
Copied!

Get Session Client Formfactor

Gets the formfactor of the connected session
1
var formfactor = API.RemotePlay.Client.GetSessionClientFormFactor(session);
Copied!

Get Session Client Resolution

Get the resolution of the connected session
1
var resolution = API.RemotePlay.Client.GetSessionClientResolution(session);
Copied!

Send Invite

Invite a friend to join the game using remote play together
1
if(API.RemotePlayClient.SendInvite(user))
2
Debug.Log("Done");
3
else
4
Debug.Log("Send failed");
Copied!