RenderingSession Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Each rendering session is running on a dedicated server, providing the Azure Remote Rendering functionality.
public ref class RenderingSessionpublic class RenderingSessiontype RenderingSession = classPublic Class RenderingSession- Inheritance
-
RenderingSession
Remarks
An application can manage multiple RenderingSession objects. However, each application can only connect a single RenderingSession for rendering.
Properties
| Client |
Retrieves the associated owner RemoteRenderingClient |
| Connection |
Get the runtime API if connected to this session. |
| ConnectionStatus |
Current connection status of this session. |
| GraphicsBinding |
Get the graphics binding for this session. |
| InteropId | |
| IsConnected |
Utility function to query whether this session is connected. |
| RendererInitOptions |
Last connection parameters used in a call to ConnectAsync(RendererInitOptions). |
| SessionUuid |
String UUID of this session. |
| Valid |
Whether this object is still valid. |
Methods
| ConnectAsync(RendererInitOptions) |
Connect to the runtime on the server associated with this session. |
| ConnectToArrInspectorAsync() |
Gets a file path pointing to an HTML file to connect to the ArrInspector website. |
| Disconnect() |
Disconnect this session if connected to the runtime. |
| Equals(Object) | |
| Finalize() | |
| GetHashCode() | |
| GetPropertiesAsync() |
Queries the properties of the session (hostname, lease time, size, etc). |
| RenewAsync(RenderingSessionUpdateOptions) |
Updates the session parameters for this rendering session. |
| StopAsync() |
Stops the Azure session. It is not possible to connect to this session again. |
Operators
| Equality(RenderingSession, RenderingSession) | |
| Inequality(RenderingSession, RenderingSession) |
Events
| ConnectionStatusChanged |
Callback for connection status changes. |