Index
All Classes and Interfaces|All Packages
A
- accessToken(AccessToken) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Use a
AccessToken
for authentication. - accountDomain(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Sets the accountDomain.
- accountId(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Sets the accountId.
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Adds a custom Http pipeline policy.
- AssetConversion - Class in com.azure.mixedreality.remoterendering.models
-
Holds properties of a conversion.
- AssetConversion(String, AssetConversionOptions, String, RemoteRenderingServiceError, AssetConversionStatus, OffsetDateTime) - Constructor for class com.azure.mixedreality.remoterendering.models.AssetConversion
-
Constructs a new AssetConversion object.
- AssetConversionOptions - Class in com.azure.mixedreality.remoterendering.models
-
Options for a conversion.
- AssetConversionOptions() - Constructor for class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
- AssetConversionStatus - Class in com.azure.mixedreality.remoterendering.models
-
The status of a conversion.
- AssetConversionStatus() - Constructor for class com.azure.mixedreality.remoterendering.models.AssetConversionStatus
- Authenticate the client - Search tag in Overview
- Section
- Authenticating a user using device code authentication - Search tag in Overview
- Section
- Authenticating with account key authentication - Search tag in Overview
- Section
- Authenticating with an AAD client secret - Search tag in Overview
- Section
- Authenticating with a static access token - Search tag in Overview
- Section
- Azure Remote Rendering client library for Java - Search tag in Overview
- Section
B
- beginConversion(String, AssetConversionOptions) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Starts a conversion using an asset stored in an Azure Blob Storage account.
- beginConversion(String, AssetConversionOptions) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Starts a conversion using an asset stored in an Azure Blob Storage account.
- beginConversion(String, AssetConversionOptions, Context) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Starts a conversion using an asset stored in an Azure Blob Storage account.
- beginSession(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Creates a new rendering session.
- beginSession(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Creates a new rendering session.
- beginSession(String, BeginSessionOptions) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Creates a new rendering session.
- beginSession(String, BeginSessionOptions) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Creates a new rendering session.
- beginSession(String, BeginSessionOptions, Context) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Creates a new rendering session.
- BeginSessionOptions - Class in com.azure.mixedreality.remoterendering.models
-
Options for a session to be created.
- BeginSessionOptions() - Constructor for class com.azure.mixedreality.remoterendering.models.BeginSessionOptions
- buildAsyncClient() - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Builds and returns a RemoteRenderingAsyncClient instance from the provided parameters.
- buildClient() - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Builds and returns a RemoteRenderingClient instance from the provided parameters.
C
- CANCELLED - Static variable in class com.azure.mixedreality.remoterendering.models.AssetConversionStatus
-
Static value Cancelled for AssetConversionStatus.
- clientOptions(ClientOptions) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Sets the
ClientOptions
which enables various options to be set on the client. - com.azure.mixedreality.remoterendering - package com.azure.mixedreality.remoterendering
-
This package contains classes for the Remote Rendering project.
- com.azure.mixedreality.remoterendering.models - package com.azure.mixedreality.remoterendering.models
-
This package contains model classes for the Remote Rendering project.
- configuration(Configuration) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Sets The configuration store that is used during construction of the service client.
- Contributing - Search tag in Overview
- Section
- Convert a more complex asset - Search tag in Overview
- Section
- Convert a simple asset - Search tag in Overview
- Section
- Create a rendering session - Search tag in Overview
- Section
- credential(AzureKeyCredential) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Sets the accountKeyCredential to use for authentication.
- credential(TokenCredential) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Use a
TokenCredential
for authentication.
E
- endpoint(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Sets the Remote Rendering service endpoint.
- endSession(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Stops a particular rendering session.
- endSession(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Stops a particular rendering session.
- endSessionWithResponse(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Stops a particular rendering session.
- endSessionWithResponse(String, Context) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Stops a particular rendering session.
- ERROR - Static variable in class com.azure.mixedreality.remoterendering.models.RenderingSessionStatus
-
Static value Error for SessionStatus.
- Examples - Search tag in Overview
- Section
- EXPIRED - Static variable in class com.azure.mixedreality.remoterendering.models.RenderingSessionStatus
-
Static value Expired for SessionStatus.
- Extend the lease time of a session - Search tag in Overview
- Section
F
- FAILED - Static variable in class com.azure.mixedreality.remoterendering.models.AssetConversionStatus
-
Static value Failed for AssetConversionStatus.
- fromString(String) - Static method in class com.azure.mixedreality.remoterendering.models.AssetConversionStatus
-
Creates or finds a AssetConversionStatus from its string representation.
- fromString(String) - Static method in class com.azure.mixedreality.remoterendering.models.RenderingSessionSize
-
Creates or finds a SessionSize from its string representation.
- fromString(String) - Static method in class com.azure.mixedreality.remoterendering.models.RenderingSessionStatus
-
Creates or finds a SessionStatus from its string representation.
G
- getArrInspectorPort() - Method in class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Get the arrInspectorPort property: The TCP port at which the Azure Remote Rendering Inspector tool is hosted.
- getCode() - Method in class com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError
-
Get the code property: Error code.
- getConversion(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Gets the status of a previously created asset conversion.
- getConversion(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Gets the status of a previously created asset conversion.
- getConversionWithResponse(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Gets the status of a previously created asset conversion.
- getConversionWithResponse(String, Context) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Gets the status of a previously created asset conversion.
- getCreationTime() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversion
-
Get the creationTime property: The time when the conversion was created.
- getCreationTime() - Method in class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Get the creationTime property: The time when the rendering session was created.
- getElapsedTime() - Method in class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Get the elapsedTime property: Amount of time the session is or has been in Ready state.
- getError() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversion
-
Get the error property: The error object containing details about the conversion failure.
- getError() - Method in class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Get the error property: The error object containing details about the rendering session startup failure.
- getHandshakePort() - Method in class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Get the handshakePort property: The TCP port used for the handshake.
- getHostname() - Method in class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Get the hostname property: The hostname under which the rendering session is reachable.
- getId() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversion
-
Get the id property: The id of the conversion supplied when the conversion was created.
- getId() - Method in class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Get the id property: The id of the session supplied when the conversion was created.
- getInnerError() - Method in class com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError
-
Get the innerError property: An object containing more specific information than the current object about the error.
- getInputBlobPrefix() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Get the inputBlobPrefix property: Only Blobs starting with this prefix will be downloaded to perform the conversion.
- getInputRelativeAssetPath() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Get the inputRelativeAssetPath property: The relative path starting at blobPrefix (or at the container root if blobPrefix is not specified) to the input model.
- getInputStorageContainerReadListSas() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Get the inputStorageContainerReadListSas property: A Azure blob storage container shared access signature giving read and list access to the storage container.
- getInputStorageContainerUrl() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Get the inputStorageContainerUrl property: The URL of the Azure blob storage container containing the input model.
- getLatest() - Static method in enum com.azure.mixedreality.remoterendering.RemoteRenderingServiceVersion
-
Gets the latest service version supported by this client library.
- getMaxLeaseTime() - Method in class com.azure.mixedreality.remoterendering.models.BeginSessionOptions
-
Get the maxLeaseTime property: The time the session will run after reaching the 'Ready' state.
- getMaxLeaseTime() - Method in class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Get the maxLeaseTime property: The time the session will run after reaching the 'Ready' state.
- getMaxLeaseTime() - Method in class com.azure.mixedreality.remoterendering.models.UpdateSessionOptions
-
Get the maxLeaseTimeMinutes property: Update to the time the session will run after it reached the 'Ready' state.
- getMessage() - Method in class com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError
-
Get the message property: A human-readable representation of the error.
- getOptions() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversion
-
Get the conversion options: Options for where to retrieve input files from and where to write output files.
- getOutputAssetFilename() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Get the outputAssetFilename property: The file name of the output asset.
- getOutputAssetUrl() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversion
-
Get the outputAssetUrl property: URL of the asset generated by the conversion process.
- getOutputBlobPrefix() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Get the outputBlobPrefix property: A prefix which gets prepended in front of all files produced by the conversion process.
- getOutputStorageContainerUrl() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Get the outputStorageContainerUrl property: The URL of the Azure blob storage container where the result of the conversion should be written to.
- getOutputStorageContainerWriteSas() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Get the outputStorageContainerWriteSas property: A Azure blob storage container shared access signature giving write access to the storage container.
- getSession(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Gets properties of a particular rendering session.
- getSession(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Gets properties of a particular rendering session.
- getSessionWithResponse(String) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Gets properties of a particular rendering session.
- getSessionWithResponse(String, Context) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Gets properties of a particular rendering session.
- getSize() - Method in class com.azure.mixedreality.remoterendering.models.BeginSessionOptions
-
Get the size property: Size of the server used for the rendering session.
- getSize() - Method in class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Get the size property: Size of the server used for the rendering session.
- getStatus() - Method in class com.azure.mixedreality.remoterendering.models.AssetConversion
-
Get the status property: The status of the conversion.
- getStatus() - Method in class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Get the status property: The status of the rendering session.
- getTarget() - Method in class com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError
-
Get the target property: The target of the particular error (e.g., the name of the property in error).
- getTeraflops() - Method in class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Get the teraflops property: The computational power of the rendering session GPU measured in Teraflops.
- Get the output when an asset conversion has finished - Search tag in Overview
- Section
- Getting started - Search tag in Overview
- Section
- getVersion() - Method in enum com.azure.mixedreality.remoterendering.RemoteRenderingServiceVersion
H
- httpClient(HttpClient) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Sets The HTTP client used to send the request.
- httpLogOptions(HttpLogOptions) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Sets The logging configuration for HTTP requests and responses.
I
- Include direct dependency - Search tag in Overview
- Section
- Include the BOM file - Search tag in Overview
- Section
- Include the package - Search tag in Overview
- Section
- Interactive authentication with DefaultAzureCredential - Search tag in Overview
- Section
K
- Key concepts - Search tag in Overview
- Section
L
- listConversions() - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Gets a list of all conversions.
- listConversions() - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Gets a list of all conversions.
- listConversions(Context) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Gets a list of all conversions.
- List conversions - Search tag in Overview
- Section
- List rendering sessions - Search tag in Overview
- Section
- listRootErrors() - Method in class com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError
-
List of errors that led to this reported error.
- listSessions() - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Get a list of all rendering sessions.
- listSessions() - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Get a list of all rendering sessions.
- listSessions(Context) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Get a list of all rendering sessions.
M
- maxLeaseTime(Duration) - Method in class com.azure.mixedreality.remoterendering.models.UpdateSessionOptions
-
Set the maxLeaseTime property: Update to the time the session will run after it reached the 'Ready' state.
N
- Next steps - Search tag in Overview
- Section
- NOT_STARTED - Static variable in class com.azure.mixedreality.remoterendering.models.AssetConversionStatus
-
Static value NotStarted for AssetConversionStatus.
P
- pipeline(HttpPipeline) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Sets The HTTP pipeline to send requests through.
- PREMIUM - Static variable in class com.azure.mixedreality.remoterendering.models.RenderingSessionSize
-
Static value Premium for SessionSize.
- Prerequisites - Search tag in Overview
- Section
R
- READY - Static variable in class com.azure.mixedreality.remoterendering.models.RenderingSessionStatus
-
Static value Ready for SessionStatus.
- RemoteRenderingAsyncClient - Class in com.azure.mixedreality.remoterendering
-
A builder for creating a new instance of the MixedRealityRemoteRendering type.
- RemoteRenderingClient - Search tag in Overview
- Section
- RemoteRenderingClient - Class in com.azure.mixedreality.remoterendering
-
Client to communicate with remote rendering service.
- RemoteRenderingClientBuilder - Class in com.azure.mixedreality.remoterendering
-
A builder for creating instances of RemoteRenderingClient and RemoteRenderingAsyncClient.
- RemoteRenderingClientBuilder() - Constructor for class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Constructs a new RemoteRenderingClientBuilder instance.
- RemoteRenderingServiceError - Class in com.azure.mixedreality.remoterendering.models
-
Represents an error in the service.
- RemoteRenderingServiceError(String, String, String, RemoteRenderingServiceError, List<RemoteRenderingServiceError>) - Constructor for class com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError
-
Constructs a new RemoteRenderingServiceError object.
- RemoteRenderingServiceVersion - Enum in com.azure.mixedreality.remoterendering
-
The versions of the RemoteRenderingService supported by this client library.
- RenderingSession - Class in com.azure.mixedreality.remoterendering.models
-
Holds the properties of a rendering session.
- RenderingSession(String, int, int, Duration, String, Duration, RenderingSessionSize, RenderingSessionStatus, float, RemoteRenderingServiceError, OffsetDateTime) - Constructor for class com.azure.mixedreality.remoterendering.models.RenderingSession
-
Constructs a new RenderingSession object.
- RenderingSessionSize - Class in com.azure.mixedreality.remoterendering.models
-
The size of a rendering session.
- RenderingSessionSize() - Constructor for class com.azure.mixedreality.remoterendering.models.RenderingSessionSize
- RenderingSessionStatus - Class in com.azure.mixedreality.remoterendering.models
-
The status of a rendering session.
- RenderingSessionStatus() - Constructor for class com.azure.mixedreality.remoterendering.models.RenderingSessionStatus
- retryPolicy(RetryPolicy) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Sets The retry policy that will attempt to retry failed requests, if applicable.
- RUNNING - Static variable in class com.azure.mixedreality.remoterendering.models.AssetConversionStatus
-
Static value Running for AssetConversionStatus.
S
- serviceVersion(RemoteRenderingServiceVersion) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClientBuilder
-
Sets the
RemoteRenderingServiceVersion
that is used when making API requests. - setInputBlobPrefix(String) - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Set the inputBlobPrefix property: Only Blobs starting with this prefix will be downloaded to perform the conversion.
- setInputRelativeAssetPath(String) - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Set the inputRelativeAssetPath property: The relative path starting at blobPrefix (or at the container root if blobPrefix is not specified) to the input model.
- setInputStorageContainerReadListSas(String) - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Set the inputStorageContainerReadListSas property: A Azure blob storage container shared access signature giving read and list access to the storage container.
- setInputStorageContainerUrl(String) - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Set the inputStorageContainerUrl property: The URL of the Azure blob storage container containing the input model.
- setMaxLeaseTime(Duration) - Method in class com.azure.mixedreality.remoterendering.models.BeginSessionOptions
-
Set the maxLeaseTime property: The time the session will run after reaching the 'Ready' state.
- setOutputAssetFilename(String) - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Set the outputAssetFilename property: The file name of the output asset.
- setOutputBlobPrefix(String) - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Set the blobPrefix property: A prefix which gets prepended in front of all files produced by the conversion process.
- setOutputStorageContainerUrl(String) - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Set the outputStorageContainerUrl property: The URL of the Azure blob storage container where the result of the conversion should be written to.
- setOutputStorageContainerWriteSas(String) - Method in class com.azure.mixedreality.remoterendering.models.AssetConversionOptions
-
Set the storageContainerWriteSas property: A Azure blob storage container shared access signature giving write access to the storage container.
- setSize(RenderingSessionSize) - Method in class com.azure.mixedreality.remoterendering.models.BeginSessionOptions
-
Set the size property: Size of the server used for the rendering session.
- STANDARD - Static variable in class com.azure.mixedreality.remoterendering.models.RenderingSessionSize
-
Static value Standard for SessionSize.
- STARTING - Static variable in class com.azure.mixedreality.remoterendering.models.RenderingSessionStatus
-
Static value Starting for SessionStatus.
- Stop a session - Search tag in Overview
- Section
- STOPPED - Static variable in class com.azure.mixedreality.remoterendering.models.RenderingSessionStatus
-
Static value Stopped for SessionStatus.
- SUCCEEDED - Static variable in class com.azure.mixedreality.remoterendering.models.AssetConversionStatus
-
Static value Succeeded for AssetConversionStatus.
T
- Troubleshooting - Search tag in Overview
- Section
U
- updateSession(String, UpdateSessionOptions) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Updates a particular rendering session.
- updateSession(String, UpdateSessionOptions) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Updates a particular rendering session.
- UpdateSessionOptions - Class in com.azure.mixedreality.remoterendering.models
-
Options for updating an existing rendering session.
- UpdateSessionOptions() - Constructor for class com.azure.mixedreality.remoterendering.models.UpdateSessionOptions
- updateSessionWithResponse(String, UpdateSessionOptions) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingAsyncClient
-
Updates a particular rendering session.
- updateSessionWithResponse(String, UpdateSessionOptions, Context) - Method in class com.azure.mixedreality.remoterendering.RemoteRenderingClient
-
Updates a particular rendering session.
V
- V2021_01_01 - Enum constant in enum com.azure.mixedreality.remoterendering.RemoteRenderingServiceVersion
-
Service version
2021-01-01
. - valueOf(String) - Static method in enum com.azure.mixedreality.remoterendering.RemoteRenderingServiceVersion
-
Returns the enum constant of this type with the specified name.
- values() - Static method in class com.azure.mixedreality.remoterendering.models.AssetConversionStatus
- values() - Static method in class com.azure.mixedreality.remoterendering.models.RenderingSessionSize
- values() - Static method in class com.azure.mixedreality.remoterendering.models.RenderingSessionStatus
- values() - Static method in enum com.azure.mixedreality.remoterendering.RemoteRenderingServiceVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes and Interfaces|All Packages