RemoteRenderingClient Class

Package:

com.azure.mixedreality.remoterendering

Maven Artifact:

com.azure:azure-mixedreality-remoterendering:1.1.28

• java.lang.Object
• • com.azure.mixedreality.remoterendering.RemoteRenderingClient

public final class RemoteRenderingClient

Client to communicate with remote rendering service.

Method Summary

Modifier and Type	Method and Description
SyncPoller<AssetConversion,AssetConversion>	beginConversion(String conversionId, AssetConversionOptions options) Starts a conversion using an asset stored in an Azure Blob Storage account.
SyncPoller<AssetConversion,AssetConversion>	beginConversion(String conversionId, AssetConversionOptions options, Context context) Starts a conversion using an asset stored in an Azure Blob Storage account.
SyncPoller<RenderingSession,RenderingSession>	beginSession(String sessionId) Creates a new rendering session.
SyncPoller<RenderingSession,RenderingSession>	beginSession(String sessionId, BeginSessionOptions options) Creates a new rendering session.
SyncPoller<RenderingSession,RenderingSession>	beginSession(String sessionId, BeginSessionOptions options, Context context) Creates a new rendering session.
void	endSession(String sessionId) Stops a particular rendering session.
Response<Void>	endSessionWithResponse(String sessionId, Context context) Stops a particular rendering session.
AssetConversion	getConversion(String conversionId) Gets the status of a previously created asset conversion.
Response<AssetConversion>	getConversionWithResponse(String conversionId, Context context) Gets the status of a previously created asset conversion.
RenderingSession	getSession(String sessionId) Gets properties of a particular rendering session.
Response<RenderingSession>	getSessionWithResponse(String sessionId, Context context) Gets properties of a particular rendering session.
PagedIterable<AssetConversion>	listConversions() Gets a list of all conversions.
PagedIterable<AssetConversion>	listConversions(Context context) Gets a list of all conversions.
PagedIterable<RenderingSession>	listSessions() Get a list of all rendering sessions.
PagedIterable<RenderingSession>	listSessions(Context context) Get a list of all rendering sessions.
RenderingSession	updateSession(String sessionId, UpdateSessionOptions options) Updates a particular rendering session.
Response<RenderingSession>	updateSessionWithResponse(String sessionId, UpdateSessionOptions options, Context context) Updates a particular rendering session.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

beginConversion

public SyncPoller 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.

beginConversion

public SyncPoller beginConversion(String conversionId, AssetConversionOptions options, Context context)

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.

context - The context to use.

Returns:

the conversion.

beginSession

public SyncPoller beginSession(String sessionId)

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.

beginSession

public SyncPoller 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 - Options for the session to be created.

Returns:

the rendering session.

beginSession

public SyncPoller beginSession(String sessionId, BeginSessionOptions options, Context context)

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 - Options for the session to be created.

context - The context to use.

Returns:

the rendering session.

endSession

public void endSession(String sessionId)

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.

endSessionWithResponse

public Response endSessionWithResponse(String sessionId, Context context)

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.

context - The context to use.

Returns:

The response.

getConversion

public AssetConversion getConversion(String conversionId)

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.

getConversionWithResponse

public Response getConversionWithResponse(String conversionId, Context context)

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.

context - The context to use.

Returns:

the conversion.

getSession

public RenderingSession getSession(String sessionId)

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.

getSessionWithResponse

public Response getSessionWithResponse(String sessionId, Context context)

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.

context - The context to use.

Returns:

the rendering session.

listConversions

public PagedIterable listConversions()

Gets a list of all conversions.

Returns:

a list of all conversions.

listConversions

public PagedIterable listConversions(Context context)

Gets a list of all conversions.

Parameters:

context - The context to use.

Returns:

a list of all conversions.

listSessions

public PagedIterable listSessions()

Get a list of all rendering sessions.

Returns:

a list of all rendering sessions.

listSessions

public PagedIterable listSessions(Context context)

Get a list of all rendering sessions.

Parameters:

context - The context to use.

Returns:

a list of all rendering sessions.

updateSession

public RenderingSession updateSession(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.

updateSessionWithResponse

public Response updateSessionWithResponse(String sessionId, UpdateSessionOptions options, Context context)

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.

context - The context to use.

Returns:

the rendering session.