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

Interface representing a RemoteRendering.

Hierarchy

RemoteRendering

Implemented by

RemoteRenderingImpl

Index

Methods

createConversion

createConversion(accountId: string, conversionId: string, body: CreateConversionSettings, options?: RemoteRenderingCreateConversionOptionalParams): Promise<RemoteRenderingCreateConversionResponse>

- Defined in generated/operationsInterfaces/remoteRendering.ts:46
Creates a conversion using an asset stored in an Azure Blob Storage account.

Parameters
- accountId: string
  
  The Azure Remote Rendering account ID.
- 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.
- body: CreateConversionSettings
  
  Request body configuring the settings for an asset conversion.
- Optional options: RemoteRenderingCreateConversionOptionalParams
  
  The options parameters.
Returns Promise<RemoteRenderingCreateConversionResponse>

createSession

createSession(accountId: string, sessionId: string, body: RenderingSessionSettings, options?: RemoteRenderingCreateSessionOptionalParams): Promise<RemoteRenderingCreateSessionResponse>

- Defined in generated/operationsInterfaces/remoteRendering.ts:83
Creates a new rendering session.

Parameters
- accountId: string
  
  The Azure Remote Rendering account ID.
- 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.
- body: RenderingSessionSettings
  
  Settings of the session to be created.
- Optional options: RemoteRenderingCreateSessionOptionalParams
  
  The options parameters.
Returns Promise<RemoteRenderingCreateSessionResponse>

getConversion

getConversion(accountId: string, conversionId: string, options?: RemoteRenderingGetConversionOptionalParams): Promise<RemoteRenderingGetConversionResponse>

- Defined in generated/operationsInterfaces/remoteRendering.ts:60
Gets the status of a particular conversion.

Parameters
- accountId: string
  
  The Azure Remote Rendering account ID.
- 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.
- Optional options: RemoteRenderingGetConversionOptionalParams
  
  The options parameters.
Returns Promise<RemoteRenderingGetConversionResponse>

getSession

getSession(accountId: string, sessionId: string, options?: RemoteRenderingGetSessionOptionalParams): Promise<RemoteRenderingGetSessionResponse>

- Defined in generated/operationsInterfaces/remoteRendering.ts:97
Gets the properties of a particular rendering session.

Parameters
- accountId: string
  
  The Azure Remote Rendering account ID.
- 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: RemoteRenderingGetSessionOptionalParams
  
  The options parameters.
Returns Promise<RemoteRenderingGetSessionResponse>

listConversions

listConversions(accountId: string, options?: RemoteRenderingListConversionsOptionalParams): Promise<RemoteRenderingListConversionsResponse>

- Defined in generated/operationsInterfaces/remoteRendering.ts:70
Gets a list of all conversions.

Parameters
- accountId: string
  
  The Azure Remote Rendering account ID.
- Optional options: RemoteRenderingListConversionsOptionalParams
  
  The options parameters.
Returns Promise<RemoteRenderingListConversionsResponse>

listConversionsNext

listConversionsNext(accountId: string, nextLink: string, options?: RemoteRenderingListConversionsNextOptionalParams): Promise<RemoteRenderingListConversionsNextResponse>

- Defined in generated/operationsInterfaces/remoteRendering.ts:145
ListConversionsNext

Parameters
- accountId: string
  
  The Azure Remote Rendering account ID.
- nextLink: string
  
  The nextLink from the previous successful call to the ListConversions method.
- Optional options: RemoteRenderingListConversionsNextOptionalParams
  
  The options parameters.
Returns Promise<RemoteRenderingListConversionsNextResponse>

listSessions

listSessions(accountId: string, options?: RemoteRenderingListSessionsOptionalParams): Promise<RemoteRenderingListSessionsResponse>

- Defined in generated/operationsInterfaces/remoteRendering.ts:135
Gets a list of all rendering sessions.

Parameters
- accountId: string
  
  The Azure Remote Rendering account ID.
- Optional options: RemoteRenderingListSessionsOptionalParams
  
  The options parameters.
Returns Promise<RemoteRenderingListSessionsResponse>

listSessionsNext

listSessionsNext(accountId: string, nextLink: string, options?: RemoteRenderingListSessionsNextOptionalParams): Promise<RemoteRenderingListSessionsNextResponse>

- Defined in generated/operationsInterfaces/remoteRendering.ts:156
ListSessionsNext

Parameters
- accountId: string
  
  The Azure Remote Rendering account ID.
- nextLink: string
  
  The nextLink from the previous successful call to the ListSessions method.
- Optional options: RemoteRenderingListSessionsNextOptionalParams
  
  The options parameters.
Returns Promise<RemoteRenderingListSessionsNextResponse>

stopSession

stopSession(accountId: string, sessionId: string, options?: RemoteRenderingStopSessionOptionalParams): Promise<RemoteRenderingStopSessionResponse>

- Defined in generated/operationsInterfaces/remoteRendering.ts:125
Stops a particular rendering session.

Parameters
- accountId: string
  
  The Azure Remote Rendering account ID.
- 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: RemoteRenderingStopSessionOptionalParams
  
  The options parameters.
Returns Promise<RemoteRenderingStopSessionResponse>

updateSession

updateSession(accountId: string, sessionId: string, body: UpdateSessionSettings, options?: RemoteRenderingUpdateSessionOptionalParams): Promise<RemoteRenderingUpdateSessionResponse>

- Defined in generated/operationsInterfaces/remoteRendering.ts:111
Updates the max lease time of a particular rendering session.

Parameters
- accountId: string
  
  The Azure Remote Rendering account ID.
- 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.
- body: UpdateSessionSettings
  
  Settings used to update the session.
- Optional options: RemoteRenderingUpdateSessionOptionalParams
  
  The options parameters.
Returns Promise<RemoteRenderingUpdateSessionResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createConversion

Parameters

accountId: string

conversionId: string

body: CreateConversionSettings

Optional options: RemoteRenderingCreateConversionOptionalParams

Returns Promise<RemoteRenderingCreateConversionResponse>

createSession

Parameters

accountId: string

sessionId: string

body: RenderingSessionSettings

Optional options: RemoteRenderingCreateSessionOptionalParams

Returns Promise<RemoteRenderingCreateSessionResponse>

getConversion

Parameters

accountId: string

conversionId: string

Optional options: RemoteRenderingGetConversionOptionalParams

Returns Promise<RemoteRenderingGetConversionResponse>

getSession

Parameters

accountId: string

sessionId: string

Optional options: RemoteRenderingGetSessionOptionalParams

Returns Promise<RemoteRenderingGetSessionResponse>

listConversions

Parameters

accountId: string

Optional options: RemoteRenderingListConversionsOptionalParams

Returns Promise<RemoteRenderingListConversionsResponse>

listConversionsNext

Parameters

accountId: string

nextLink: string

Optional options: RemoteRenderingListConversionsNextOptionalParams

Returns Promise<RemoteRenderingListConversionsNextResponse>

listSessions

Parameters

accountId: string

Optional options: RemoteRenderingListSessionsOptionalParams

Returns Promise<RemoteRenderingListSessionsResponse>

listSessionsNext

Parameters

accountId: string

nextLink: string

Optional options: RemoteRenderingListSessionsNextOptionalParams

Returns Promise<RemoteRenderingListSessionsNextResponse>

stopSession

Parameters

accountId: string

sessionId: string

Optional options: RemoteRenderingStopSessionOptionalParams

Returns Promise<RemoteRenderingStopSessionResponse>

updateSession

Parameters

accountId: string

sessionId: string

body: UpdateSessionSettings

Optional options: RemoteRenderingUpdateSessionOptionalParams

Returns Promise<RemoteRenderingUpdateSessionResponse>