你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/mixed-reality-remote-rendering package

Classes

RemoteRenderingClient

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

RemoteRenderingServiceError

Error object containing details about a conversion or session failure.

Interfaces

AssetConversionBase

Properties available for an AssetConversion in any state.

AssetConversionInputSettings

Conversion input settings describe the origin of conversion input.

AssetConversionOperationState

The state carried by the poller for the beginConversion operation.

AssetConversionOutput

Information about the output of a successful conversion. Only present when the status of the conversion is 'Succeeded'.

AssetConversionOutputSettings

Conversion output settings describe the destination of conversion output.

AssetConversionPollerOptions

Options to configure the poller for the beginConversion operation.

AssetConversionSettings

Conversion settings describe the origin of input files and destination of output files.

CancelledAssetConversion

The conversion was cancelled.

ErrorRenderingSession

The rendering session has encountered an error, and is unusable.

ExpiredRenderingSession

The rendering session enters the 'Expired' state when it has been in the 'Ready' state longer than its lease time. This is a terminal state.

FailedAssetConversion

The conversion has failed. Check the 'error' field for more details.

NonStartedAssetConversion

The conversion was created but hasn't started.

PartialRenderingSessionProperties

In certain RenderingSession states, some properties are available and some are not.

ReadyRenderingSession

The rendering session is ready for incoming connections.

RemoteRenderingClientOptions

Options to create the RemoteRenderingClient.

RenderingSessionBase

Properties available for a rendering session in any state

RenderingSessionOperationState

The state carried by the poller for the beginSession operation.

RenderingSessionPollerOptions

Options to configure the poller for the beginSession operation.

RenderingSessionProperties

The properties of a complete rendering session

RenderingSessionSettings

Settings of the session to be created.

RunningAssetConversion

The conversion is running.

StartingRenderingSession

The rendering session is starting, but not accepting incoming connections yet.

StoppedRenderingSession

The rendering session has been stopped with the 'Stop Session' operation. This is a terminal state.

SucceededAssetConversion

The conversion has succeeded.

UpdateSessionSettings

Settings used to update the session.

Type Aliases

AssetConversion

A type representing the various states of a conversion. This is a tagged union with "status" as its discriminant property.

AssetConversionPollerLike

The poller returned by the beginConversion operation.

AssetConversionStatus

Defines values for AssetConversionStatus.
KnownAssetConversionStatus can be used interchangeably with AssetConversionStatus, this enum contains the known values that the service supports.

Known values supported by the service

NotStarted: The conversion was created but hasn't started.
Running: The conversion is running.
Cancelled: The conversion was cancelled. This is a terminal state.
Failed: The conversion has failed. Check the 'error' field for more details. This is a terminal state.
Succeeded: The conversion has succeeded. Check the 'output' field for output asset location. This is a terminal state.

BeginConversionOptions

Options to configure the beginConversion operation.

BeginSessionOptions

Options to configure the beginSession operation.

EndSessionOptions

Options to configure the endSession operation.

GetConversionOptions

Options to configure the getConversion operation.

GetSessionOptions

Options to configure the getSession operation.

ListConversionsOptions

Options to configure the listConversions operation.

ListSessionsOptions

Options to configure the listSessions operation.

RenderingServerSize

Defines values for RenderingServerSize.
KnownRenderingServerSize can be used interchangeably with RenderingServerSize, this enum contains the known values that the service supports.

Known values supported by the service

Standard: Standard rendering session size.
Premium: Premium rendering session size.

RenderingSession

Information about a rendering session. This is a tagged union with "status" as its discriminant property.

RenderingSessionPollerLike

The poller returned by the beginSession operation.

ResumeBeginConversionOptions

Options for resuming a pre-existing conversion operation.

ResumeBeginSessionOptions

Options for resuming a pre-existing session operation.

UpdateSessionOptions

Options to configure the updateSession operation.

Enums

KnownAssetConversionStatus

Known values of AssetConversionStatus that the service accepts.

KnownRenderingServerSize

Known values of RenderingServerSize that the service accepts.

KnownRenderingSessionStatus

Known values of KnownRenderingSessionStatus that the service accepts.