启动参数说明
数智人端渲染 Windows SDK 程序 virtual_human_ue426.exe 在启动时可以传入参数来控制数智人的行为。
参数使用单横线的方式调用, 如:
virtual_human_ue426.exe -RenderOffScreen -Log -EnableSessionCheck -TencentLicenseAppID=xxxxxxxxx -EnableSessionCheck
其中, 开关参数值接填入, 带值参数使用等号分割参数名称和参数值。
参数列表
参数列表如下:
UE 自带参数
参数名称 | 必选 | 类型 | 描述 |
RenderOffScreen | 是 | Bool | 是否离屏渲染 |
Log | 否 | Bool | 是否显示日志窗口 |
数智人端渲染 sdk 并不使用 UE 窗口, 视口显示内容为黑屏, 启动参数添加 -RenderOffScreen 激活离屏渲染。
授权参数
参数名称 | 必选 | 类型 | 描述 |
TencentLicenseAppID | 是 | String | 授权获取到的 AppID |
TencentLicenseSecretKey | 是 | string | 授权获取到的 SecretKey |
TencentLicenseFile | 否 | string | 授权文件保存的路径, 如果不填 默认为 c:\\TencentLicense\\virtual_human.lic |
驱动参数
参数名称 | 必选 | 类型 | 描述 |
TencentServerUrl | 否 | String | 驱动的 URL 地址,默认为公有云正式环境 |
TencentAppKey | 是 | string | 在平台申请的 AppKey ,用来做文本,语音驱动鉴权使用 |
TencentAccessToken | 是 | string | 在平台申请的 AccessToken,用来做文本,语音驱动鉴权使用 |
TencentVirtualHumanKey | 是 | string | 在平台申请的人物 ID,现阶段和 AppKey相同,用来标识在平台配置的音色和对话 |
DisableDriverTLS | 否 | Bool | websocket 禁用 tls,使用 ws, 默认是 wss |
Session 检测
参数名称 | 必选 | 类型 | 描述 |
EnableSessionCheck | 否 | Bool | 是否校验 UDP 通讯协议的 Session, 默认值为否 |
Session 校验主要是给云渲染部署使用的,在端渲染时,一般不需要打开。
如果打开此参数,在开始控制数智人之前需要 发送 init 指令,并保持后面的命令的 SessionID 一致,否则命令将拒绝执行。
Agent 心跳
参数名称 | 必选 | 类型 | 描述 |
AgentAddress | 否 | String | Agent 监听的 IP 地址,不填默认值为 127.0.0.1 |
AgentPort | 否 | Int | Agent 监听的 UDP 端口号,不填的话,不会启动心跳上报 |
ReportDuration | 否 | Int | 上报心跳的时间间隔,单位秒, 默认为 |
InstanceID | 否 | String | 内容会透传到心跳包里 |
InstanceInfo | 否 | String | 内容会透传到心跳包里 |