RenderingSession Class

  • Reference
Package:
com.azure.mixedreality.remoterendering.models
Maven Artifact:
com.azure:azure-mixedreality-remoterendering:1.1.28
  • java.lang.Object
    • com.azure.mixedreality.remoterendering.models.RenderingSession

public final class RenderingSession

Holds the properties of a rendering session.

Constructor Summary

Constructor Description
RenderingSession(String id, int arrInspectorPort, int handshakePort, Duration elapsedTime, String hostname, Duration maxLeaseTime, RenderingSessionSize sessionSize, RenderingSessionStatus sessionStatus, float teraflops, RemoteRenderingServiceError error, OffsetDateTime creationTime)

Constructs a new RenderingSession object.

Method Summary

Modifier and Type Method and Description
int getArrInspectorPort()

Get the arrInspectorPort property: The TCP port at which the Azure Remote Rendering Inspector tool is hosted.
OffsetDateTime getCreationTime()

Get the creationTime property: The time when the rendering session was created.
Duration getElapsedTime()

Get the elapsedTime property: Amount of time the session is or has been in Ready state.
RemoteRenderingServiceError getError()

Get the error property: The error object containing details about the rendering session startup failure.
int getHandshakePort()

Get the handshakePort property: The TCP port used for the handshake.
String getHostname()

Get the hostname property: The hostname under which the rendering session is reachable.
String getId()

Get the id property: The id of the session supplied when the conversion was created.
Duration getMaxLeaseTime()

Get the maxLeaseTime property: The time the session will run after reaching the 'Ready' state.
RenderingSessionSize getSize()

Get the size property: Size of the server used for the rendering session.
RenderingSessionStatus getStatus()

Get the status property: The status of the rendering session.
float getTeraflops()

Get the teraflops property: The computational power of the rendering session GPU measured in Teraflops.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RenderingSession

public RenderingSession(String id, int arrInspectorPort, int handshakePort, Duration elapsedTime, String hostname, Duration maxLeaseTime, RenderingSessionSize sessionSize, RenderingSessionStatus sessionStatus, float teraflops, RemoteRenderingServiceError error, OffsetDateTime creationTime)

Constructs a new RenderingSession object.

Parameters:

id - The id of the session supplied when the conversion was created.
arrInspectorPort - The TCP port at which the Azure Remote Rendering Inspector tool is hosted.
handshakePort - The TCP port used for the handshake.
elapsedTime - Amount of time the session is or has been in Ready state. Time is rounded down to a full minute.
hostname - The hostname under which the rendering session is reachable.
maxLeaseTime - The time the session will run after reaching the 'Ready' state.
sessionSize - 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.
sessionStatus - The status of the rendering session. Once the status reached the 'Ready' state it can be connected to. The terminal state is 'Stopped'.
teraflops - The computational power of the rendering session GPU measured in Teraflops.
error - The error object containing details about the rendering session startup failure.
creationTime - The time when the rendering session was created. Date and time in ISO 8601 format.

Method Details

getArrInspectorPort

public int getArrInspectorPort()

Get the arrInspectorPort property: The TCP port at which the Azure Remote Rendering Inspector tool is hosted.

Returns:

the arrInspectorPort value.

getCreationTime

public OffsetDateTime getCreationTime()

Get the creationTime property: The time when the rendering session was created. Date and time in ISO 8601 format.

Returns:

the creationTime value.

getElapsedTime

public Duration getElapsedTime()

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:

the elapsedTime value.

getError

public RemoteRenderingServiceError getError()

Get the error property: The error object containing details about the rendering session startup failure.

Returns:

the error value.

getHandshakePort

public int getHandshakePort()

Get the handshakePort property: The TCP port used for the handshake.

Returns:

the handshakePort value.

getHostname

public String getHostname()

Get the hostname property: The hostname under which the rendering session is reachable.

Returns:

the hostname value.

getId

public String getId()

Get the id property: The id of the session supplied when the conversion was created.

Returns:

the id value.

getMaxLeaseTime

public Duration getMaxLeaseTime()

Get the maxLeaseTime property: The time the session will run after reaching the 'Ready' state.

Returns:

the maxLeaseTime value.

getSize

public RenderingSessionSize getSize()

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:

the size value.

getStatus

public RenderingSessionStatus getStatus()

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:

the status value.

getTeraflops

public float getTeraflops()

Get the teraflops property: The computational power of the rendering session GPU measured in Teraflops.

Returns:

the teraflops value.

Applies to