Share via


RemoteRenderingClient.StartSessionAsync Method

Definition

Creates a new rendering session.

public virtual System.Threading.Tasks.Task<Azure.MixedReality.RemoteRendering.StartRenderingSessionOperation> StartSessionAsync (string sessionId, Azure.MixedReality.RemoteRendering.RenderingSessionOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member StartSessionAsync : string * Azure.MixedReality.RemoteRendering.RenderingSessionOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.MixedReality.RemoteRendering.StartRenderingSessionOperation>
override this.StartSessionAsync : string * Azure.MixedReality.RemoteRendering.RenderingSessionOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.MixedReality.RemoteRendering.StartRenderingSessionOperation>
Public Overridable Function StartSessionAsync (sessionId As String, options As RenderingSessionOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of StartRenderingSessionOperation)

Parameters

sessionId
String

An ID uniquely identifying the rendering session for the given account. The ID is case sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 256 characters.

options
RenderingSessionOptions

Options of the session to be created.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

sessionId or options is null.

Applies to