XR Viewer Cloud
- Last UpdatedSep 03, 2025
- 3 minute read
The XR Viewer Cloud is designed to emulate cloud environment execution and enables you to test a streamed app from a web page.
It's based on a server that provides both HTTP access to the page and streams the rendering. The user interacts with the web page that communicates with the engine in the server through a JRPC API contract.
-
Execution of XR Viewer Cloud is restricted to when XR Studio is running on the same machine. For this reason, XR Portable should not be part of any release.
-
Can execute unpacked project data as well as packed project data.
-
Integrates both debug and log panel, so you can inspect the app while interacting with it.
Command line arguments
|
Argument |
Description |
|---|---|
|
-config |
Application Configuration File to be loaded. Automatically generated by XR Studio. |
|
-paks |
List of paks to be loaded. Automatically generated by XR Studio (ex. pakname1.pak|pakfolder1|pakname2.pak|pakfolder2). |
|
-configuration |
(optional) Project configuration file to override some of the application configuration options. This file can be generated using XR Studio. |
|
-port |
By default is set to 10668, it can be reassigned using this parameter. |
|
-wsport |
By default is set to 10669, it can be reassigned using this argument. |
Server application
When you start the XR Viewer Cloud against a development project and specify it’s folder as the working directory, you will see the following Windows application.
Application will stay in waiting state until scene loading is complete and the stream service is ready.
Server interface
XR Viewer Cloud has a basic application interface with three buttons and a status bar.
-
Open Webpage. Open the server web page on default browser. It can be used multiple times but only one page will be capable to stream the rendering at a time.
-
Debug. Shows XR Viewer Runtime Debug Tool.
-
Log. Shows Log panel.
-
Status bar. Shows the currently used HTTP address and streaming endpoint.
Code example
WD: C:\dev\projects\XRViewerCloudSample
Cmd args: -config config.xml -param License.type XR_STUDIO -paks
mwpl_core.pak|C:\\dev\\source\\xr_framework\\_bundled_release_\\Package\\Core_0.0.0.0
\\ModulePaks|mwpl_media.pak|C:\\dev\\source\\xr_framework\\_bundled_release_\\Package\\Core_0.0.0.0\\ModulePaks
Executing a single PAK released application
In order to test a PAK application on the XR Viewer Cloud, it's enough to start it without provisioning -pak argument. This can be achieved setting the Override mode for the additional command line arguments in the run configuration. See Managing configurations for further details.
When running the server without passing the -pak list, it displays a different interface.
Select and drop a single PAK released application into it to get to the standard interface. The server will load the application.
