azure.mixedreality.remoterendering.aio package

class azure.mixedreality.remoterendering.aio.RemoteRenderingClient(endpoint: str, account_id: str, account_domain: str, credential: Union[AsyncTokenCredential, azure.core.credentials.AzureKeyCredential, azure.core.credentials.AccessToken], **kwargs)[source]

A client for the Azure Remote Rendering Service.

This client offers functionality to convert assets to the format expected by the runtime, and also to manage the lifetime of remote rendering sessions.

Parameters

  • endpoint (str) – The rendering service endpoint. This determines the region in which the rendering session is created and asset conversions are performed.

  • account_id (str) – The Azure Remote Rendering account identifier.

  • account_domain (str) – The Azure Remote Rendering account domain. For example, for an account created in the eastus region, this will have the form “eastus.mixedreality.azure.com”

  • credential (Union[AsyncTokenCredential, AzureKeyCredential, AccessToken]) – Authentication for the Azure Remote Rendering account. Can be of the form of an AzureKeyCredential, AsyncTokenCredential or an AccessToken acquired from the Mixed Reality Secure Token Service (STS).

Keyword Arguments

api_version (str or RemoteRenderingApiVersion) – The API version of the service to use for requests. It defaults to the latest service version. Setting to an older version may result in reduced feature compatibility.

async begin_asset_conversion(conversion_id: str, input_settings: azure.mixedreality.remoterendering._generated.models._models_py3.AssetConversionInputSettings, output_settings: azure.mixedreality.remoterendering._generated.models._models_py3.AssetConversionOutputSettings, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mixedreality.remoterendering._generated.models._models_py3.AssetConversion][source]

Start a new asset conversion with the given options. :param str conversion_id:

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

Parameters
Returns

A poller for the created asset conversion

Return type

AsyncLROPoller[AssetConversion]

async begin_rendering_session(session_id: str, size: str, lease_time_minutes: int, **kwargs) → azure.core.polling._async_poller.AsyncLROPoller[azure.mixedreality.remoterendering._generated.models._models_py3.RenderingSession][source]
Parameters

  • session_id (str) – 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.

  • size (str or RenderingSessionSize) – Size of the server used for the rendering session. Remote Rendering with Standard size server has a maximum scene size of 20 million polygons. Remote Rendering with Premium size does not enforce a hard maximum, but performance may be degraded if your content exceeds the rendering capabilities of the service.

  • lease_time_minutes (int) – The time in minutes the session will run after reaching the ‘Ready’ state.

Returns

A poller for the created rendering session

Return type

AsyncLROPoller[RenderingSession]

async close() → None[source]
async get_asset_conversion(conversion_id: str, **kwargs) → azure.mixedreality.remoterendering._generated.models._models_py3.AssetConversion[source]

Retrieve the state of a previously created conversion. :param str conversion_id:

The identifier of the conversion to retrieve.

Returns

Information about the ongoing conversion process.

Return type

AssetConversion

async get_asset_conversion_poller(**kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.mixedreality.remoterendering._generated.models._models_py3.AssetConversion][source]

Returns a poller for an existing conversion by conversion id or a continuation token retrieved from a previous poller. :keyword conversion_id: The conversion id of a previously created conversion. :paramtype conversion_id: str :keyword continuation_token:

A continuation token retrieved from a poller of a conversion.

Returns

A poller for the created asset conversion

Return type

AsyncLROPoller[AssetConversion]

async get_rendering_session(session_id: str, **kwargs) → azure.mixedreality.remoterendering._generated.models._models_py3.RenderingSession[source]

Returns the properties of a previously generated rendering session. :param str session_id: The identifier of the rendering session. :return: Properties of the rendering session :rtype: ~azure.mixedreality.remoterendering.RenderingSession

async get_rendering_session_poller(**kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.mixedreality.remoterendering._generated.models._models_py3.RenderingSession][source]

Returns a poller for an existing rendering session by session id or a continuation token retrieved from a previous poller. :keyword session_id: The conversion id of a previously created conversion. :paramtype session_id: str :keyword continuation_token:

A continuation token retrieved from a poller of a session.

Returns

A poller for the created rendering session

Return type

AsyncLROPoller[RenderingSession]

async list_asset_conversions(**kwargs) → AsyncItemPaged[AssetConversion][source]

Gets conversions for the remote rendering account. :rtype: AsyncItemPaged[AssetConversion]

async list_rendering_sessions(**kwargs) → AsyncItemPaged[RenderingSession][source]
List rendering sessions in the ‘Ready’ or ‘Starting’ state. Does not return stopped or failed rendering

sessions.

Return type

AsyncItemPaged[RenderingSession]

async stop_rendering_session(session_id: str, **kwargs) → None[source]
Parameters

session_id (str) – The identifier of the session to be stopped.

Returns

None

Return type

None

async update_rendering_session(session_id: str, **kwargs) → azure.mixedreality.remoterendering._generated.models._models_py3.RenderingSession[source]

Updates an already existing rendering session. :param str session_id: The identifier of the session to be updated. :keyword lease_time_minutes: The new lease time of the rendering session. Has to be strictly larger than

the previous lease time.

Return type

RenderingSession

Raises

HttpResponseError –