RemoteRenderingClient | @azure/mixed-reality-remote-rendering

The client class used to interact with the App Configuration service.

Hierarchy

RemoteRenderingClient

Index

Constructors

constructor

Methods

Constructors

constructor

new RemoteRenderingClient(endpoint: string, accountId: string, accountDomain: string, credential: AzureKeyCredential, options?: RemoteRenderingClientOptions): RemoteRenderingClient
new RemoteRenderingClient(endpoint: string, accountId: string, accountDomain: string, credential: TokenCredential, options?: RemoteRenderingClientOptions): RemoteRenderingClient
new RemoteRenderingClient(endpoint: string, accountId: string, credential: AccessToken, options?: RemoteRenderingClientOptions): RemoteRenderingClient

- Defined in remoteRenderingClient.ts:177
Creates an instance of a RemoteRenderingClient.

Parameters
- endpoint: string
  
  The RemoteRendering endpoint to use.
- accountId: string
  
  The Remote Rendering service account identifier.
- accountDomain: string
  
  The Remote Rendering service account domain.
- credential: AzureKeyCredential
  
  A token credential for authenticating the account with the Mixed Reality STS service.
- Optional options: RemoteRenderingClientOptions
  
  Additional client options.
Returns RemoteRenderingClient
- Defined in remoteRenderingClient.ts:193
Creates an instance of a RemoteRenderingClient.

Parameters
- endpoint: string
  
  The RemoteRendering endpoint to use.
- accountId: string
  
  The Remote Rendering service account identifier.
- accountDomain: string
  
  The Remote Rendering service account domain.
- credential: TokenCredential
  
  A token credential for authenticating the account with the Mixed Reality STS service.
- Optional options: RemoteRenderingClientOptions
  
  Additional client options.
Returns RemoteRenderingClient
- Defined in remoteRenderingClient.ts:209
Creates an instance of a RemoteRenderingClient.

Parameters
- endpoint: string
  
  The RemoteRendering endpoint to use.
- accountId: string
  
  The Remote Rendering service account identifier.
- credential: AccessToken
  
  A token credential for authenticating the account with the Mixed Reality STS service.
- Optional options: RemoteRenderingClientOptions
  
  Additional client options.
Returns RemoteRenderingClient

Methods

beginConversion

beginConversion(conversionId: string, assetConversionSettings: AssetConversionSettings, options?: BeginConversionOptions): Promise<AssetConversionPollerLike>
beginConversion(options: ResumeBeginConversionOptions): Promise<AssetConversionPollerLike>

- Defined in remoteRenderingClient.ts:323
Creates a conversion using an asset stored in an Azure Blob Storage account.

Parameters
- conversionId: string
  
  An ID uniquely identifying the conversion 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.
- assetConversionSettings: AssetConversionSettings
  
  Settings configuring the asset conversion.
- Optional options: BeginConversionOptions
  
  The options parameters.
Returns Promise<AssetConversionPollerLike>
- Defined in remoteRenderingClient.ts:333
Obtains a poller corresponding to a conversion that was already started.

Parameters
- options: ResumeBeginConversionOptions
  
  The options parameters, carrying a resumeFrom value.
Returns Promise<AssetConversionPollerLike>

beginSession

beginSession(sessionId: string, settings: RenderingSessionSettings, options?: BeginSessionOptions): Promise<RenderingSessionPollerLike>
beginSession(options: ResumeBeginSessionOptions): Promise<RenderingSessionPollerLike>

- Defined in remoteRenderingClient.ts:490
Creates a new rendering session.

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.
- settings: RenderingSessionSettings
  
  Settings of the session to be created.
- Optional options: BeginSessionOptions
  
  The options parameters.
Returns Promise<RenderingSessionPollerLike>
- Defined in remoteRenderingClient.ts:500
Obtains a poller for a pre-existing session

Parameters
- options: ResumeBeginSessionOptions
  
  The options parameters, carrying a resumeFrom value.
Returns Promise<RenderingSessionPollerLike>

endSession

endSession(sessionId: string, options?: EndSessionOptions): Promise<void>

- Defined in remoteRenderingClient.ts:631
Stops a particular rendering session.

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.
- Optional options: EndSessionOptions
  
  The options parameters.
Returns Promise<void>

getConversion

getConversion(conversionId: string, options?: GetConversionOptions): Promise<AssetConversion>

- Defined in remoteRenderingClient.ts:408
Gets the status of a particular conversion.

Parameters
- conversionId: string
  
  The ID of a previously created conversion.
- Optional options: GetConversionOptions
  
  The options parameters.
Returns Promise<AssetConversion>

getSession

getSession(sessionId: string, options?: GetSessionOptions): Promise<RenderingSession>

- Defined in remoteRenderingClient.ts:574
Gets the status of a particular session.

Parameters
- sessionId: string
  
  An ID uniquely identifying the 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.
- Optional options: GetSessionOptions
  
  The options parameters.
Returns Promise<RenderingSession>

listConversions

listConversions(options?: ListConversionsOptions): PagedAsyncIterableIterator<AssetConversion>

- Defined in remoteRenderingClient.ts:452
Gets a list of all conversions.

Parameters
- Optional options: ListConversionsOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<AssetConversion>

listSessions

listSessions(options?: ListSessionsOptions): PagedAsyncIterableIterator<RenderingSession>

- Defined in remoteRenderingClient.ts:668
Gets a list of all sessions.

Parameters
- Optional options: ListSessionsOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<RenderingSession>

updateSession

updateSession(sessionId: string, settings: UpdateSessionSettings, options?: UpdateSessionOptions): Promise<RenderingSession>

- Defined in remoteRenderingClient.ts:595
Updates the max lease time of a particular rendering session.

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.
- settings: UpdateSessionSettings
- Optional options: UpdateSessionOptions
  
  The options parameters.
Returns Promise<RenderingSession>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

endpoint: string

accountId: string

accountDomain: string

credential: AzureKeyCredential

Optional options: RemoteRenderingClientOptions

Returns RemoteRenderingClient

Parameters

endpoint: string

accountId: string

accountDomain: string

credential: TokenCredential

Optional options: RemoteRenderingClientOptions

Returns RemoteRenderingClient

Parameters

endpoint: string

accountId: string

credential: AccessToken

Optional options: RemoteRenderingClientOptions

Returns RemoteRenderingClient

Methods

beginConversion

Parameters

conversionId: string

assetConversionSettings: AssetConversionSettings

Optional options: BeginConversionOptions

Returns Promise<AssetConversionPollerLike>

Parameters

options: ResumeBeginConversionOptions

Returns Promise<AssetConversionPollerLike>

beginSession

Parameters

sessionId: string

settings: RenderingSessionSettings

Optional options: BeginSessionOptions

Returns Promise<RenderingSessionPollerLike>

Parameters

options: ResumeBeginSessionOptions

Returns Promise<RenderingSessionPollerLike>

endSession

Parameters

sessionId: string

Optional options: EndSessionOptions

Returns Promise<void>

getConversion

Parameters

conversionId: string

Optional options: GetConversionOptions

Returns Promise<AssetConversion>

getSession

Parameters

sessionId: string

Optional options: GetSessionOptions

Returns Promise<RenderingSession>

listConversions

Parameters

Optional options: ListConversionsOptions

Returns PagedAsyncIterableIterator<AssetConversion>

listSessions

Parameters

Optional options: ListSessionsOptions

Returns PagedAsyncIterableIterator<RenderingSession>

updateSession

Parameters

sessionId: string

settings: UpdateSessionSettings

Optional options: UpdateSessionOptions

Returns Promise<RenderingSession>