Class WindowsMRRemoting
Windows Mixed Reality Class used to manage Remoting within the application
Namespace: UnityEngine.XR.WindowsMR
Syntax
public static class WindowsMRRemotingProperties
isAudioEnabled
Enable Audio when remoting
Declaration
public static bool isAudioEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
isConnected
Active remoting connection established
Declaration
public static bool isConnected { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
isVideoEnabled
Enable Video when remoting
Declaration
public static bool isVideoEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
maxBitRateKbps
The maximum bit rate (in Kbps) for sending data between application and device when Remoting
Declaration
public static int maxBitRateKbps { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
remoteMachineName
IP address of the device to connect to
Declaration
public static string remoteMachineName { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Methods
Connect()
Attempt to connect to the Holographic Remoting Player on the device specified by the remoteMachineName
Declaration
public static void Connect()Disconnect()
Disconnect any active remoting connections
Declaration
public static void Disconnect()TryGetConnectionFailureReason(out ConnectionFailureReason)
Try to get the failure reason of the remoting connection
Declaration
public static bool TryGetConnectionFailureReason(out ConnectionFailureReason connectionFailureReason)Parameters
| Type | Name | Description |
|---|---|---|
| ConnectionFailureReason | connectionFailureReason | The reason the remoting connection failed |
Returns
| Type | Description |
|---|---|
| Boolean | True if the connection failure reason was able to be acquired |
TryGetConnectionState(out ConnectionState)
Try to get the current state of the remoting connection
Declaration
public static bool TryGetConnectionState(out ConnectionState connectionState)Parameters
| Type | Name | Description |
|---|---|---|
| ConnectionState | connectionState | The current state of the connection |
Returns
| Type | Description |
|---|---|
| Boolean | True if the connection state was able to be acquired |