WebStream Plugin

The WebStream plugin allows broadcasting audio data and video frames rendered by a UNIGINE-based application to an unlimited number of devices via WebRTC (Web Real-Time Communication).

In general, the process is as follows:

1. You run the UNIGINE application on a remote computer, a desktop inside your organization, a container, or a virtual machine provided by a cloud hosting service.
2. UNIGINE uses the resources available to that computer (like CPU, GPU, memory, etc.) to run application logic and render frames.
3. The rendered output is continuously encoded into a media stream and passed through a lightweight stack of web services.
4. Users view this stream in standard web browsers running on other computers and mobile devices and control the experience from their browsers, sending keyboard, mouse, and touch events, as well as custom events emitted from the client's web page, back to UNIGINE.

To use the WebStream plugin with your project, do the following:

1. Add it via UNIGINE SDK Browser on project creation: click Plugins, check the WebStream plugin option, and click Add.

   Notice

   For the existing project, choose Other Actions -> Configure Project, add the plugin as described above, and click Update Configuration.

2. Launch the plugin: specify the extern_plugin command line option on the application start-up.

   Source code

   main_x64 -extern_plugin "UnigineWebStream"

   In addition, you can turn on the Offscreen mode by specifying the -video_offscreen command-line option. It will allow you to run the application in the headless mode without displaying a visible window.

   Source code

   main_x64 -extern_plugin "UnigineWebStream" -video_offscreen 1

   Notice

   • If you skip this parameter, the application window will be rendered alongside the video and input streams. However, in this case, inputs may be processed incorrectly.
   • When user input is not allowed, the plugin can be used without the Offscreen mode.

To view the rendered output in a web browser, specify localhost:8000 or [device-IP-address]:8000 in the address bar.

Web Configuration File#

{
	"server":{
		"document_root":"./plugins/Unigine/WebStream/html",
		"http_address":"0.0.0.0:8000",
		"enable_directory_listing" : false,
		"num_threads" : 4,
		"disable_xframe_options" : false,
		"access_control_allow_origin" : "*",
		"enable_keep_alive" : true,
		"keep_alive_timeout_ms" : 1000,
		"decode_url" : false,
		"ssl_certificate" : "",
		"global_auth_file" : "",
		"authentication_domain" : "",
		"extra_options" : []
	},
	"input":{
		"enabled" : true
	}
}