Class Library

Container for library-wise global settings of MixedReality-WebRTC.

Inheritance

Object

Library

Namespace: Microsoft.MixedReality.WebRTC

Assembly: Microsoft.MixedReality.WebRTC.dll

Syntax

public static class Library : object

Properties

ShutdownOptions

Options used when shutting down the MixedReality-WebRTC library. disposed, to shutdown the internal threads and release the global resources, and allow the library's module to be unloaded.

Declaration

public static Library.ShutdownOptionsFlags ShutdownOptions { get; set; }

Property Value

Type	Description
Library.ShutdownOptionsFlags

UsedAudioDeviceModule

Audio device module to use on Windows Desktop.

Declaration

public static AudioDeviceModule UsedAudioDeviceModule { get; set; }

Property Value

Type	Description
AudioDeviceModule

Remarks

The ADM can only be changed before any peer connection is created/initialized; otherwise an is raised.

This has no effect on UWP or non-Windows platforms.

Methods

ForceShutdown()

Forcefully shutdown the MixedReality-WebRTC library. This shall not be used under normal circumstances, but can be useful e.g. in the Unity editor when a test fails and proper clean-up is not ensured (in particular, disposing objects), to allow the shared module to shutdown and terminate its native threads, and be unloaded.

Declaration

public static void ForceShutdown()

ReportLiveObjects()

Report all objects currently alive and tracked by the native implementation. This is a live report, which generally gets outdated as soon as the function returned, as new objects are created and others destroyed. Nonetheless this is may be helpful to diagnose issues with disposing objects.

Declaration

public static uint ReportLiveObjects()

Returns

Type	Description
UInt32	Returns the number of live objects at the time of the call.