Rediger

Use the session management REST API

  • Artikel

To use Azure Remote Rendering functionality, you need to create a session. Each session corresponds to a server being allocated in Azure to which a client device can connect. When a device connects, the server renders the requested data and serves the result as a video stream. During session creation, you chose which kind of server you want to run on, which determines pricing. Once the session isn't needed anymore, it should be stopped. If not stopped manually, it will be shut down automatically when the session's lease time expires.

REST API reference

The REST API reference can be found here and the swagger definitions here. We provide a PowerShell script in the ARR samples repository in the Scripts folder, called RenderingSession.ps1, which demonstrates the use of our service. The script and its configuration are described here: Example PowerShell scripts. We also provide SDKs for .NET and Java.

Important

Latency is an important factor when using remote rendering. For the best experience create sessions in the region that is closest to you. The Azure Latency Test can be used to determine which region is closest to you.

Important

An ARR runtime SDK is needed for a client device to connect to a rendering session. These SDKs are available in .NET and C++. Apart from connecting to the service, these SDKs can also be used to start and stop sessions.

Next steps