Class RemoteRenderingAsyncClient
java.lang.Object
com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
A builder for creating a new instance of the MixedRealityRemoteRendering type.
-
Method Summary
Modifier and TypeMethodDescriptionbeginConversion
(String conversionId, AssetConversionOptions options) Starts a conversion using an asset stored in an Azure Blob Storage account.beginSession
(String sessionId) Creates a new rendering session.beginSession
(String sessionId, BeginSessionOptions options) Creates a new rendering session.endSession
(String sessionId) Stops a particular rendering session.endSessionWithResponse
(String sessionId) Stops a particular rendering session.getConversion
(String conversionId) Gets the status of a previously created asset conversion.getConversionWithResponse
(String conversionId) Gets the status of a previously created asset conversion.getSession
(String sessionId) Gets properties of a particular rendering session.getSessionWithResponse
(String sessionId) Gets properties of a particular rendering session.Gets a list of all conversions.Get a list of all rendering sessions.updateSession
(String sessionId, UpdateSessionOptions options) Updates a particular rendering session.updateSessionWithResponse
(String sessionId, UpdateSessionOptions options) Updates a particular rendering session.
-
Method Details
-
beginSession
Creates a new rendering session.- Parameters:
sessionId
- 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.- Returns:
- the rendering session.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
beginSession
public PollerFlux<RenderingSession,RenderingSession> beginSession(String sessionId, BeginSessionOptions options) Creates a new rendering session.- Parameters:
sessionId
- 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
- Settings for the session to be created.- Returns:
- the rendering session.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getSession
Gets properties of a particular rendering session.- Parameters:
sessionId
- 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.- Returns:
- the rendering session.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getSessionWithResponse
Gets properties of a particular rendering session.- Parameters:
sessionId
- 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.- Returns:
- the rendering session.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
updateSession
Updates a particular rendering session.- Parameters:
sessionId
- 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
- Options for the session to be updated.- Returns:
- the rendering session.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
updateSessionWithResponse
public Mono<Response<RenderingSession>> updateSessionWithResponse(String sessionId, UpdateSessionOptions options) Updates a particular rendering session.- Parameters:
sessionId
- 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
- Options for the session to be updated.- Returns:
- the rendering session.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
endSession
Stops a particular rendering session.- Parameters:
sessionId
- 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.- Returns:
- nothing on completion.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
endSessionWithResponse
Stops a particular rendering session.- Parameters:
sessionId
- 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.- Returns:
- nothing on completion.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listSessions
Get a list of all rendering sessions.- Returns:
- a list of all rendering sessions.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
beginConversion
public PollerFlux<AssetConversion,AssetConversion> beginConversion(String conversionId, AssetConversionOptions options) Starts a conversion using an asset stored in an Azure Blob Storage account. If the remote rendering account has been linked with the storage account no Shared Access Signatures (storageContainerReadListSas, storageContainerWriteSas) for storage access need to be provided. Documentation how to link your Azure Remote Rendering account with the Azure Blob Storage account can be found in the [documentation](https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts).All files in the input container starting with the blobPrefix will be retrieved to perform the conversion. To cut down on conversion times only necessary files should be available under the blobPrefix.
- Parameters:
conversionId
- 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.options
- The conversion options.- Returns:
- the conversion.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getConversion
Gets the status of a previously created asset conversion.- Parameters:
conversionId
- 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.- Returns:
- the conversion.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getConversionWithResponse
Gets the status of a previously created asset conversion.- Parameters:
conversionId
- 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.- Returns:
- the conversion.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listConversions
Gets a list of all conversions.- Returns:
- a list of all conversions.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.HttpResponseException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-