WebStream插件

警告

本文中描述的功能是实验性的。

WebStream插件允许广播音频数据和视频帧呈现基于UNIGINE的应用程序通过 WebRTC（Web Real-Time Communication，网络实时通信）无限数量的设备。

一般来说，过程如下:

1. 您可以在远程计算机、组织内部的桌面、容器或云托管服务提供的虚拟机上运行UNIGINE应用程序。
2. UNIGINE使用该计算机可用的资源（如CPU，GPU，内存等）。来运行应用程序逻辑和渲染帧。
3. 呈现的输出被连续编码为媒体流，并通过一个轻量级的web服务堆栈传递。
4. 用户在其他计算机和移动设备上运行的标准web浏览器中查看此流，并从浏览器控制体验，将键盘，鼠标和触摸事件以及从客户端网页发出的自定义事件发送回UNIGINE。

要在项目中使用WebStream插件，请执行以下操作:

1. 在项目创建时通过UNIGINE SDK浏览器添加：单击Plugins，选择WebStream plugin选项，然后单击Add。

   注意

   对于现有项目，选择Other Actions -> Configure Project，按照上面的描述添加插件，然后单击 Update Configuration。

2. 启动插件：在应用程序启动时指定extern_plugin命令行选项。

   源代码

   main_x64 -extern_plugin "UnigineWebStream"

   此外，您可以通过指定-video_offscreen命令行选项来打开Offscreen模式。 它将允许您以无头模式运行应用程序，而不显示可见窗口。

   源代码

   main_x64 -extern_plugin "UnigineWebStream" -video_offscreen 1

   注意

   • 如果跳过此参数，则应用程序窗口将与视频和输入流一起呈现。然而，在这种情况下，输入可能会被错误地处理。
   • 对于不允许用户输入的远程客户端应用程序，无需启用Offscreen模式。

要在Web浏览器中渲染主视口的输出，请在地址栏中使用Web配置文件中指定的HTTP地址数据，如下所示：

localhost:8000	如果应用程序运行在同一台PC上
[设备IP地址]:8000	如果应用程序运行在网络中的另一台PC上 要使应用程序可从网络中的其他PC访问，请在Web配置文件中指定主机PC的IP地址。

如果地址中未设置Player名称（即链接如下所示）：

• localhost:8000/index.html?video=

  或者

• localhost:8000

则图像将以 Main Player 的渲染方式进行流式传输。

引擎图像：	流式图像：

要从特定摄像机渲染，请在地址中添加它的名称（/index.html?video=Player名称）：

• localhost:8000/index.html?video=Player名称

  或者

• [设备IP地址]:8000/index.html?video=Player名称

警告

如果在流式传输服务器计算机的当前场景中不存在指定名称的Player，则会看到来自流式传输服务器当前摄像机的备用视图，但没有任何后期特效和GUI。

未找到指定Player时的无GUI流式图像

该插件附带 web_config.json 文件 (位于目录 <your_project>/bin/plugins/Unigine/WebStream)，其中包含允许您配置广播过程的设置。您可以更改服务器设置(例如，指定自定义HTTP地址以在浏览器中查看输出)，并允许或禁止用户输入。

以下是默认配置文件的示例:

{
	"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
	}
}

服务器设置如下:

document_root	web服务器为页面提供服务的目录。
http_address	Web服务器的HTTP地址和端口。 默认地址 0.0.0.0 使应用程序仅在本地计算机上可访问。要允许网络中其他PC访问，请在本地网络中指定主机PC的IP地址。 默认端口为 8000。您也可以指定其他可用端口。
enable_directory_listing	标识用户是可以通过浏览器浏览 document_root 中指定文件夹的内容，还是只能访问预定义页面。
num_threads	Web服务器的线程数。 不建议将其设置为小于2。
disable_xframe_options	X-Frame-Option响应头是否开启的标志。
access_control_allow_origin	Access-Control-Allow-Origin响应头。 默认情况下，它设置为*，允许web浏览器从任何来源请求代码。
enable_keep_alive	指示是否启用Keep-Alive头的值。
keep_alive_timeout_ms	主机保持空闲连接打开的时间（以毫秒为单位）。
decode_url	指示是否启用URL解码的标志。
ssl_certificate	HTTPS所需证书的路径。
global_auth_file	全局身份验证文件的路径。
authentication_domain	认证域。
extra_options	附加服务器设置列表。

还有一个部分包含用户输入的设置:

enabled	允许或禁止服务器处理来自web浏览器的用户输入。 注意 当不允许输入时，插件可以在没有Offscreen模式的情况下使用，没有任何问题。