Class DolbyIOSDK

Main entry point that allows the application to interact with the Dolby.io services.

Inheritance

Object

DolbyIOSDK

Implements

IDisposable

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: DolbyIO.Comms

Assembly: DolbyIO.Comms.Sdk.dll

Syntax

public sealed class DolbyIOSDK : IDisposable

Constructors

DolbyIOSDK(String)

Create a new DolbyIOSDK

Declaration

public DolbyIOSDK(string componentName = "dotnet-sdk")

Parameters

Type	Name	Description
String	componentName	The component used.

Properties

Audio

Gets the audio service.

Declaration

public AudioService Audio { get; }

Property Value

Type	Description
AudioService	The service that allows accessing to the remote and local audio services.

Exceptions

Type	Condition
DolbyIOException	Is thrown when InitAsync(String, RefreshTokenCallBack) has not yet been called.

Conference

Gets the conference service.

Declaration

public ConferenceService Conference { get; }

Property Value

Type	Description
ConferenceService	The service that allows manipulating conferences.

Exceptions

Type	Condition
DolbyIOException	Is thrown when InitAsync(String, RefreshTokenCallBack) has not yet been called.

InvalidTokenError

Raised when the access token is invalid or has expired.

Declaration

public InvalidTokenErrorEventHandler InvalidTokenError { set; }

Property Value

Type	Description
InvalidTokenErrorEventHandler	The InvalidTokenErrorEventHandler event handler raised when the access token is invalid or has expired.

Exceptions

Type	Condition
DolbyIOException	Is thrown when InitAsync(String, RefreshTokenCallBack) has not yet been called.

IsInitialized

Gets if the SDK is initialized.

Declaration

public bool IsInitialized { get; }

Property Value

Type	Description
Boolean	true if the SDK is initialized; otherwise, false.

MediaDevice

Gets the media device service.

Declaration

public MediaDeviceService MediaDevice { get; }

Property Value

Type	Description
MediaDeviceService	The service that allows manipulating media devices.

Exceptions

Type	Condition
DolbyIOException	Is thrown when InitAsync(String, RefreshTokenCallBack) has not yet been called.

Session

Gets the session service.

Declaration

public SessionService Session { get; }

Property Value

Type	Description
SessionService	The service that allows manipulating sessions.

Exceptions

Type	Condition
DolbyIOException	Is thrown when InitAsync(String, RefreshTokenCallBack) has not yet been called.

SignalingChannelError

Raised when an error occurs during a Session Initiation Protocol (SIP) negotiation of the local participant's peer connection.

Declaration

public SignalingChannelErrorEventHandler SignalingChannelError { set; }

Property Value

Type	Description
SignalingChannelErrorEventHandler	The SignalingChannelErrorEventHandler event handler raised when an error occurs.

Exceptions

Type	Condition
DolbyIOException	Is thrown when InitAsync(String, RefreshTokenCallBack) has not yet been called.

Video

Gets the video service.

Declaration

public VideoService Video { get; }

Property Value

Type	Description
VideoService

Exceptions

Type	Condition
DolbyIOException	Is thrown when InitAsync(String, RefreshTokenCallBack) has not yet been called.

Methods

Dispose()

Releases the unmanaged resources.

Declaration

public void Dispose()

InitAsync(String, RefreshTokenCallBack)

Initializes the SDK with an access token that is provided by the customer's backend.

Declaration

public async Task InitAsync(string accessToken, RefreshTokenCallBack cb)

Parameters

Type	Name	Description
String	accessToken	The access token provided by the customer's backend.
RefreshTokenCallBack	cb	The refresh token callback.

Returns

Type	Description
Task	A Task that represents the asynchronous operation.

Exceptions

Type	Condition
DolbyIOException	Is thrown when InitAsync(String, RefreshTokenCallBack) has not yet been called.

SetLogLevelAsync(LogLevel)

Sets the logging level for the SDK.

Declaration

public async Task SetLogLevelAsync(LogLevel logLevel)

Parameters

Type	Name	Description
LogLevel	logLevel	The new logging level value.

Returns

Type	Description
Task	A Task that represents the asynchronous operation.

Implements

System.IDisposable