虚幻引擎5文档已被迁移至 Epic开发者社区

像素流送参考

像素流送系统组件支持的浏览器、网络端口和配置选项。

Choose your operating system:

Windows

macOS

Linux

此页面将讲述像素流送系统诸多部分所公开的选项、设置和命令行参数。

支持的图形硬件

用像素流送插件运行虚幻引擎应用程序的电脑必须具备以下类型的图形硬件之一：

如尝试使用像素流送插件时收到错误消息 未找到兼容的GPU，或未能加载其编码器库（No compatible GPU found, or failed to load their respective encoder libraries） ，原因很可能是GPU不支持NVENC或AMF。

支持的操作系统

像素流送插件与信令和Web服务器已在Windows 8和Windows 10上进行测试。

其尚未在其他操作系统上进行测试，包括Windows 7。

支持的客户端浏览器

像素流送播放可在支持WebRTC协议上的主流浏览器上使用。举例而言，经过测试，其无需额外配置便可兼容以下浏览器的最新版本：

  • Google Chrome（桌面版和移动版）

  • Mozilla Firefox（桌面版和移动版）

  • Apple Safari（桌面版和移动版）

其他浏览器（如Microsoft Edge和Opera）则需要附件组件或插件，并且可能无法用于所有系统。

默认网络端口

像素流送系统的组件使用如下所述的默认端口进行通信。需要确认这些端口已在运行每个组件的主机上打开。

组件

端口

Signaling Server host

  • 80 -用于来自客户端的所有HTTP请求。
    设置信令服务器的 --httpPort 参数即可修改此值。

  • 443 -用于信令服务器运行HTTPS模式时来自客户端的所有HTTPS请求。
    设置信令服务器的 --httpsPort 参数即可修改此值。

  • 8888 -用于来自虚幻引擎应用的所有传入连接请求。
    如要修改此值，须对信令服务器的 --streamerPort 参数 和 UE4应用的 -PixelStreamingPort 参数进行设置。

Matchmaker Server host

  • 90 -用于来自客户端的所有HTTP请求。
    使用配对服务器的 --httpPort 参数即可修改此值。

  • 9999 -用于信令服务器发送的所有消息。
    如要修改此值，须对配对服务器的 --matchmakerPort 参数 和 信令服务器的 --matchmakerPort 参数进行设置。

虚幻引擎控制台命令

Encoder 命令控制像素流送插件将虚幻引擎渲染帧编码为视频帧的方式。

命令

描述

Encoder.MaxBitrate

允许的最大比特率，以bps为单位。

Encoder.TargetSize

编码器的目标分辨率大小，格式为 <width>x<height> 。
并将 Encoder.UseBackBufferSIze 设为false，以便让流送使用此自定义大小。

Encoder.UseBackBufferSize

让编码器使用后置缓冲大小（即为渲染游戏视口的代销），而非 Encoder.TargetSize 设置的自定义大小。

虚幻引擎命令行参数

启动虚幻引擎应用程序时在命令行上设置这些属性。

参数

描述

-AllowPixelStreamingCommands

决定播放器网页是否能使用 emitCommand() 函数在虚幻引擎中远程执行控制台命令。注意这可能涉及安全问题，请谨慎处理。

-AudioMixer

强制虚幻引擎使用软件混合音频，以便像素流送插件采集音频。
从应用程序采集音频并流送到浏览器需要用到此参数。

-PixelStreamingIP=<value>

必需。

指定运行信令和Web服务器的计算机的IP地址或域名。

-PixelStreamingPort=<value>

必需。

指定信令和Web服务器用于监听来自虚幻引擎应用程序通信的端口。 信令和Web服务器的默认值为 8888 。

-PixelStreamingKeyFilter="<value>"

像素流送插件应从播放器网页中继至虚幻引擎的输入中过滤掉的键盘键的列表，以逗号分隔。如果在浏览器中按下其中一个键，此事件将不会被中继至虚幻引擎的输入控制器。
举例而言， -PixelStreamingKeyFilter="F1..F12,W,A,S,D" 将过滤掉所有12个功能键和移动键。

-PixelStreamingReceiveStringMaxLength

设置虚幻引擎应用从信令和网页服务器接收的信息的最大长度，以字节为单位。
默认值为 1024 。

-RenderOffScreen

以headless模式运行虚幻引擎应用程序，本地机上不带任何可见的渲染。应用程序不会显示任何窗口，也不会以全屏渲染。
可使用此参数结合 -ForceRes 使虚幻引擎停止基于主显示分辨率自动调整分辨率。
如遗漏此参数，虚幻引擎应用程序窗口将正常渲染。如果此应用程序窗口被最小化，像素流送视频和输入采集将停止工作。因此我们推荐固定包含此参数，除非需要在运行时在同一台电脑上本地查看虚幻引擎应用程序的渲染输出。

-NvEncFrameRateNum=<value>

指定后，覆盖默认的编码器帧率。
默认值设为匹配 t.MaxFPS 。

-NvEncMaxEncodeWidth=<value>

编码器可编码的帧的最大宽度。
默认值为 3840 。

-NvEncMaxEncodeHeight=<value>

编码器可编码的帧的最大高度。
默认值为 2160 。

-NvEncAverageBitRate=<value>

指定后，覆盖编码器的默认平均比特率。

-NvEncH264ConfigLevel=<value>

决定H.264的压缩级别：5.2或5.1。如果不设置此参数，解码器将使用5.2级别，可以解码高清分辨率，如3840x2160（4K）。 如果要解码较低的分辨率，可以将此参数设置为 NV_ENC_LEVEL_H264_51 以切换到5.1级别，以节省带宽。 如需了解H.264等级的更多内容，请参阅 此页面 。
如果虚幻引擎应用程序报告其 未能初始化NvEncoder ，且正在处理高分辨率输出，则可能需要移除此选项，将压缩级别恢复到5.2。

信令服务器配置参数

设置这些参数的方法有两种：

  • 运行 run.bat 或 node cirrus.js 启动信令和Web服务器时在命令行上进行设置。在此情况中，在每个参数前添加 -- 前缀，然后在其后添加空格，然后再加上需要设置的值。例如 --httpPort 81 。

  • 在配置文件中设置。信令和Web服务器（ cirrus.js ）默认在同个文件夹中查找一个名为 config.json 的文件。在此情况中，将把需要对其进行设置的每个参数和值设为文件中定义的JSON对象中的一个键值对。如果已启动信令和Web服务器至少一次，则参数已列出在 Engine/Source/Programs/PixelStreaming/WebServers/SignallingWebServer/config.json 文件中。

参数

描述

publicIp

运行信令和Web服务器的电脑的公开IP。

httpPort

信令和Web服务器用于与客户端浏览器进行HTTP连接的端口。

streamerPort

信令和Web服务器上聆听来自虚幻引擎应用传入连接的端口。

peerConnectionOptions

指定虚幻引擎应用和浏览器需要了解自身外部IP地址时进行查询的所有STUN和TURN服务器的主机名或IP地址。
如需了解STUN和TURN服务器的更多信息，请参阅 创建主机和网络连接指南 。
此参数必须为一个字符串，其将以进行接触的顺序列出服务器URL。格式必须如下：
"{ \"iceServers\": [{\"urls\": [<url1>,<url2>,<url3>,...]}] }"
例如：
"{ \"iceServers\": [{\"urls\": [\"stun:34.250.222.95:19302\"]}] }"
或
"{ \"iceServers\": [{\"urls\": [\"stun:34.250.222.95:19302\",\"turn:34.250.222.95:19312\"]}] }"
虚幻引擎自带的TURN服务器实现需要以下用户名和密码：
"{\"iceServers\":[{\"urls\":[\"stun: 34.250.222.95:19302\",\"turn: 34.250.222.95:19312\"],\"username\":\"<TURN_Username>\",\"credential\":\"<TURN_Password>\"}]}"
其他STUN和TURN实现的登陆信息要求可能有所不同。

值的格式必须为一个字符串，即使使用JSON配置文件来提供参数也同样如此。前后必须使用双引号，在字符串中使用反斜杠来断开引用。如下所示：

HomepageFile

服务器将提供的默认页面的文件名，以连接不请求特定URL的客户端浏览器。
默认值为 player.htm 。

AdditionalRoutes

指定信令和Web服务器应服务的额外文件夹。
此参数必须是一个JSON对象，这意味着只能在JSON配置文件中提供它，而不能在命令行上提供。 其必须是一个对象，在这个对象中每个键均是URL的一部分，每个键的值均是服务器应服务请求客户端的一个本地路径。举例而言，如果设置： "AdditionalRoutes" = { "/myfolder", "C:\some_local_path" } 则客户端请求 http://server-name/myfolder/index.html 时，服务器将提供命名为 C:\some_local_path\index.html 的文件。

LogToFile

决定信令和Web服务器是否将日志消息写入 ./logs 文件夹中的文件。
默认值为 true 。

UseHttps

将此参数设为 true ，使信令服务器仅接受 httpsPort 上的HTTPS连接。
还需要将 client-key.pem 和 client-cert.pem 文件放入信令和Web服务器根文件夹下的 certificates 文件夹。

httpsPort

聆听HTTPS连接的端口。只在 UseHttps 启用时使用。
默认值为 443 。

UseMatchmaker

确定信令和Web服务器是否将其当前状态发送到配对服务器，以帮助客户端浏览器寻找当前未使用的信令服务器和虚幻引擎应用。

matchmakerAddress

信令和Web服务器应接触的配对服务器的IP地址。

matchmakerPort

配对服务器聆听来自信令和Web服务器消息的端口。

configFile

指定配置文件的路径和文件名（信令服务器将把此文件用于获取上述属性的值）。只能在命令行上进行设置。

配对服务器命令行参数

运行服务器的 run.bat 文件、或运行 node.exe matchmaker.js 启动配对服务器，在命令行上提供这些参数。

参数

描述

--httpPort <value>

设置聆听来自客户端HTTP连接的配对服务器端口数量。
默认值为 90 。

--matchmakerPort <value>

设置聆听来自Cirrus信令服务器的传入消息的配对服务器端口数量。
默认值为 9999 。

欢迎帮助改进虚幻引擎文档！请告诉我们该如何更好地为您服务。
填写问卷调查
取消