182 строки
15 KiB
YAML
182 строки
15 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.mixedreality.remoterendering.models.RenderingSession"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession"
|
|
name: "RenderingSession"
|
|
nameWithType: "RenderingSession"
|
|
summary: "Holds the properties of a rendering session."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **RenderingSession**"
|
|
constructors:
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.RenderingSession(java.lang.String,int,int,java.time.Duration,java.lang.String,java.time.Duration,com.azure.mixedreality.remoterendering.models.RenderingSessionSize,com.azure.mixedreality.remoterendering.models.RenderingSessionStatus,float,com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError,java.time.OffsetDateTime)"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.RenderingSession(String id, int arrInspectorPort, int handshakePort, Duration elapsedTime, String hostname, Duration maxLeaseTime, RenderingSessionSize sessionSize, RenderingSessionStatus sessionStatus, float teraflops, RemoteRenderingServiceError error, OffsetDateTime creationTime)"
|
|
name: "RenderingSession(String id, int arrInspectorPort, int handshakePort, Duration elapsedTime, String hostname, Duration maxLeaseTime, RenderingSessionSize sessionSize, RenderingSessionStatus sessionStatus, float teraflops, RemoteRenderingServiceError error, OffsetDateTime creationTime)"
|
|
nameWithType: "RenderingSession.RenderingSession(String id, int arrInspectorPort, int handshakePort, Duration elapsedTime, String hostname, Duration maxLeaseTime, RenderingSessionSize sessionSize, RenderingSessionStatus sessionStatus, float teraflops, RemoteRenderingServiceError error, OffsetDateTime creationTime)"
|
|
summary: "Constructs a new Rendering<wbr>Session object."
|
|
parameters:
|
|
- description: "The id of the session supplied when the conversion was created."
|
|
name: "id"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The TCP port at which the Azure Remote Rendering Inspector tool is hosted."
|
|
name: "arrInspectorPort"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The TCP port used for the handshake."
|
|
name: "handshakePort"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Amount of time the session is or has been in Ready state. Time is rounded down to a full minute."
|
|
name: "elapsedTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "The hostname under which the rendering session is reachable."
|
|
name: "hostname"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The time the session will run after reaching the 'Ready' state."
|
|
name: "maxLeaseTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Size of the server used for the rendering session. Remote Rendering with Standard size\n server has a maximum scene size of 20 million polygons. Remote Rendering with Premium size does not enforce a\n hard maximum, but performance may be degraded if your content exceeds the rendering capabilities of the service."
|
|
name: "sessionSize"
|
|
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSessionSize?alt=com.azure.mixedreality.remoterendering.models.RenderingSessionSize&text=RenderingSessionSize\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The status of the rendering session. Once the status reached the 'Ready' state it can be\n connected to. The terminal state is 'Stopped'."
|
|
name: "sessionStatus"
|
|
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSessionStatus?alt=com.azure.mixedreality.remoterendering.models.RenderingSessionStatus&text=RenderingSessionStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The computational power of the rendering session GPU measured in Teraflops."
|
|
name: "teraflops"
|
|
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The error object containing details about the rendering session startup failure."
|
|
name: "error"
|
|
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError?alt=com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError&text=RemoteRenderingServiceError\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The time when the rendering session was created. Date and time in ISO 8601 format."
|
|
name: "creationTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public RenderingSession(String id, int arrInspectorPort, int handshakePort, Duration elapsedTime, String hostname, Duration maxLeaseTime, RenderingSessionSize sessionSize, RenderingSessionStatus sessionStatus, float teraflops, RemoteRenderingServiceError error, OffsetDateTime creationTime)"
|
|
desc: "Constructs a new RenderingSession object."
|
|
methods:
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.getArrInspectorPort()"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.getArrInspectorPort()"
|
|
name: "getArrInspectorPort()"
|
|
nameWithType: "RenderingSession.getArrInspectorPort()"
|
|
summary: "Get the arr<wbr>Inspector<wbr>Port property: The TCP port at which the Azure Remote Rendering Inspector tool is hosted."
|
|
syntax: "public int getArrInspectorPort()"
|
|
desc: "Get the arrInspectorPort property: The TCP port at which the Azure Remote Rendering Inspector tool is hosted."
|
|
returns:
|
|
description: "the arrInspectorPort value."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.getCreationTime()"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.getCreationTime()"
|
|
name: "getCreationTime()"
|
|
nameWithType: "RenderingSession.getCreationTime()"
|
|
summary: "Get the creation<wbr>Time property: The time when the rendering session was created."
|
|
syntax: "public OffsetDateTime getCreationTime()"
|
|
desc: "Get the creationTime property: The time when the rendering session was created. Date and time in ISO 8601 format."
|
|
returns:
|
|
description: "the creationTime value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.getElapsedTime()"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.getElapsedTime()"
|
|
name: "getElapsedTime()"
|
|
nameWithType: "RenderingSession.getElapsedTime()"
|
|
summary: "Get the elapsed<wbr>Time property: Amount of time the session is or has been in Ready state."
|
|
syntax: "public Duration getElapsedTime()"
|
|
desc: "Get the elapsedTime property: Amount of time the session is or has been in Ready state. Time is rounded down to a full minute."
|
|
returns:
|
|
description: "the elapsedTime value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.getError()"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.getError()"
|
|
name: "getError()"
|
|
nameWithType: "RenderingSession.getError()"
|
|
summary: "Get the error property: The error object containing details about the rendering session startup failure."
|
|
syntax: "public RemoteRenderingServiceError getError()"
|
|
desc: "Get the error property: The error object containing details about the rendering session startup failure."
|
|
returns:
|
|
description: "the error value."
|
|
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError?alt=com.azure.mixedreality.remoterendering.models.RemoteRenderingServiceError&text=RemoteRenderingServiceError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.getHandshakePort()"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.getHandshakePort()"
|
|
name: "getHandshakePort()"
|
|
nameWithType: "RenderingSession.getHandshakePort()"
|
|
summary: "Get the handshake<wbr>Port property: The TCP port used for the handshake."
|
|
syntax: "public int getHandshakePort()"
|
|
desc: "Get the handshakePort property: The TCP port used for the handshake."
|
|
returns:
|
|
description: "the handshakePort value."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.getHostname()"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.getHostname()"
|
|
name: "getHostname()"
|
|
nameWithType: "RenderingSession.getHostname()"
|
|
summary: "Get the hostname property: The hostname under which the rendering session is reachable."
|
|
syntax: "public String getHostname()"
|
|
desc: "Get the hostname property: The hostname under which the rendering session is reachable."
|
|
returns:
|
|
description: "the hostname value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.getId()"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.getId()"
|
|
name: "getId()"
|
|
nameWithType: "RenderingSession.getId()"
|
|
summary: "Get the id property: The id of the session supplied when the conversion was created."
|
|
syntax: "public String getId()"
|
|
desc: "Get the id property: The id of the session supplied when the conversion was created."
|
|
returns:
|
|
description: "the id value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.getMaxLeaseTime()"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.getMaxLeaseTime()"
|
|
name: "getMaxLeaseTime()"
|
|
nameWithType: "RenderingSession.getMaxLeaseTime()"
|
|
summary: "Get the max<wbr>Lease<wbr>Time property: The time the session will run after reaching the 'Ready' state."
|
|
syntax: "public Duration getMaxLeaseTime()"
|
|
desc: "Get the maxLeaseTime property: The time the session will run after reaching the 'Ready' state."
|
|
returns:
|
|
description: "the maxLeaseTime value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.getSize()"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.getSize()"
|
|
name: "getSize()"
|
|
nameWithType: "RenderingSession.getSize()"
|
|
summary: "Get the size property: Size of the server used for the rendering session."
|
|
syntax: "public RenderingSessionSize getSize()"
|
|
desc: "Get the size property: 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."
|
|
returns:
|
|
description: "the size value."
|
|
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSessionSize?alt=com.azure.mixedreality.remoterendering.models.RenderingSessionSize&text=RenderingSessionSize\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.getStatus()"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.getStatus()"
|
|
name: "getStatus()"
|
|
nameWithType: "RenderingSession.getStatus()"
|
|
summary: "Get the status property: The status of the rendering session."
|
|
syntax: "public RenderingSessionStatus getStatus()"
|
|
desc: "Get the status property: The status of the rendering session. Once the status reached the 'Ready' state it can be connected to. The terminal state is 'Stopped'."
|
|
returns:
|
|
description: "the status value."
|
|
type: "<xref href=\"com.azure.mixedreality.remoterendering.models.RenderingSessionStatus?alt=com.azure.mixedreality.remoterendering.models.RenderingSessionStatus&text=RenderingSessionStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.mixedreality.remoterendering.models.RenderingSession.getTeraflops()"
|
|
fullName: "com.azure.mixedreality.remoterendering.models.RenderingSession.getTeraflops()"
|
|
name: "getTeraflops()"
|
|
nameWithType: "RenderingSession.getTeraflops()"
|
|
summary: "Get the teraflops property: The computational power of the rendering session GPU measured in Teraflops."
|
|
syntax: "public float getTeraflops()"
|
|
desc: "Get the teraflops property: The computational power of the rendering session GPU measured in Teraflops."
|
|
returns:
|
|
description: "the teraflops value."
|
|
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Holds the properties of a rendering session."
|
|
metadata: {}
|
|
package: "com.azure.mixedreality.remoterendering.models"
|
|
artifact: com.azure:azure-mixedreality-remoterendering:1.1.34
|