XII Release 0.1.0
Loading...
Searching...
No Matches
xiiXRRemotingInterface Class Referenceabstract

XR Remoting singleton interface. Allows for streaming the XR application to a remote device. More...

#include <XRRemotingInterface.h>

Public Member Functions

virtual xiiResult Initialize ()=0
 Initializes the XR Remoting system. Needs to be done before xiiXRInterface is initialized.
 
virtual xiiResult Deinitialize ()=0
 Shuts down XR Remoting. This will fail if XR actors still exists or if xiiXRInterface is still initialized.
 
virtual bool IsInitialized () const =0
 Returns whether XR Remoting is initialized.
 
Connection Functions
virtual xiiResult Connect (const char *szRemoteHostName, uint16_t remotePort=8265, bool bEnableAudio=true, int iMaxBitrateKbps=20000)=0
 Tries to connect to the remote device.
 
virtual xiiResult Disconnect ()=0
 Disconnects from the remote device.
 
virtual xiiEnum< xiiXRRemotingConnectionStateGetConnectionState () const =0
 Get the current connection state to the remote device.
 
virtual xiiXRRemotingConnectionEventGetConnectionEvent ()=0
 Returns the connection event to subscribe to connection changes.
 

Static Public Attributes

static xiiCVarBool cvar_XrRemoting
 Enable XR Remoting if available.
 
static xiiCVarString cvar_XrRemotingHostName
 Hostname to connect to for XR Remoting.
 

Detailed Description

XR Remoting singleton interface. Allows for streaming the XR application to a remote device.

Needs to be initialized before xiiXRInterface to be able to use remoting.


The documentation for this class was generated from the following files: