Share via


RemoteRenderingClient.StartSession Method

Definition

Creates a new rendering session.

public virtual Azure.MixedReality.RemoteRendering.StartRenderingSessionOperation StartSession (string sessionId, Azure.MixedReality.RemoteRendering.RenderingSessionOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member StartSession : string * Azure.MixedReality.RemoteRendering.RenderingSessionOptions * System.Threading.CancellationToken -> Azure.MixedReality.RemoteRendering.StartRenderingSessionOperation
override this.StartSession : string * Azure.MixedReality.RemoteRendering.RenderingSessionOptions * System.Threading.CancellationToken -> Azure.MixedReality.RemoteRendering.StartRenderingSessionOperation
Public Overridable Function StartSession (sessionId As String, options As RenderingSessionOptions, Optional cancellationToken As CancellationToken = Nothing) As 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 session to be created.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

sessionId or options is null.

Applies to