Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SessionProperties

Package version

The properties of a rendering session.

Hierarchy

  • SessionProperties

Index

Properties

Optional arrInspectorPort

arrInspectorPort: undefined | number

The TCP port at which the Azure Remote Rendering Inspector tool is hosted. NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdOn

createdOn: Date

The time when the rendering session was created. Date and time in ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional elapsedTimeInMinutes

elapsedTimeInMinutes: undefined | number

Amount of time in minutes the session is or was in the 'Ready' state. Time is rounded down to a full minute. NOTE: This property will not be serialized. It can only be populated by the server.

Optional error

The error object containing details about the rendering session startup failure. NOTE: This property will not be serialized. It can only be populated by the server.

Optional handshakePort

handshakePort: undefined | number

The TCP port used for the handshake when establishing a connection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional host

host: undefined | string

The hostname under which the rendering session is reachable. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxLeaseTimeInMinutes

maxLeaseTimeInMinutes: undefined | number

The time in minutes the session will run after reaching the 'Ready' state. NOTE: This property will not be serialized. It can only be populated by the server.

sessionId

sessionId: string

The ID of the session supplied when the session was created.

size

The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details.

status

The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'.

Optional teraflops

teraflops: undefined | number

The computational power of the rendering session GPU measured in teraflops. NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc