3D数字人视频合成接入指南

参数

类型

是否必需

说明

TenantId

Long

是

租户ID，从虚拟数字人开放平台中获取的TenantId。参考：租户ID（TenantId）获取

App

Object

是

开发者应用信息。

App.AppId

String

是

开发者信息AppId，从虚拟数字人开放平台中获取。参考：AppId获取

Title

String

是

任务标题：

• 任务标题最长64个字。

• UTF-8编码格式

Text

String

是

合成的文本，最大支持5000个字符（SSML标签不计入）；同时支持纯文本和SSML文本

VideoInfo

Object

是

视频设置。

VideoInfo.Resolution

Number

是

视频分辨率， 默认1

• 1：720x1280竖屏

• 2：1280x720横屏

• 3：1080x1920竖屏

• 4：1920x1080横屏

VideoInfo.IsAlpha

Boolean

否

是否需要透明通道， 默认false。

• true： 开启透明通道，视频格式为MOV

• false：不开启透明通道，视频格式为MP4，包含绿幕

VideoInfo.AlphaFormat

Integer

否

透明视频格式，针对透明视频目前支持MOV、WEBM两种视频格式：

• 1：webm

• 2：mov

VideoInfo.SubtitleEmbedded

Boolean

否

是否将字幕合并到视频中，默认值false

• true：字幕合并到视频中

• false：字幕不合并到视频中，会提供一个单独的字幕文件供下载使用

VideoInfo.BackgroundImageUrl

String

否

指定视频背景图URL。

• 必须是有效可访问的URL背景图片地址，且背景图片的分辨率必须要与生成的视频分辨率保持一致。

• 目前支持jpg，jpeg，png的图片格式。

（请升级SDK到最新版本使用）

AvatarInfo

Object

否

数字人相关配置

AvatarInfo.code

String

否

数字人形象code，从虚拟数字人开放平台-3D资产页面获取，不传则使用应用配置的默认形象（点击查看形象code获取方法）

AvatarInfo.Locate

Integer

否

数字人机位

• 0: 全身近景机位，默认机位

• 1: 头部近景机位

• 2: 全身远景机位

• 3: 半身近景机位

• 4: 半身远景机位

• 5: 左边近景机位

• 6: 右边近景机位

具体每个机位效果可以参考：数字人机位效果展示。

AvatarInfo.Angle

Integer

否

数字人角度

• 0: 正面，默认角度

• 1: 左侧30度

• 2: 右侧30度

具体每个角度效果可以参考：数字人角度效果展示。

AvatarInfo.IndustryCode

String

否

数字人动作行业code，默认值：default

• default - 默认通用

• kefu - 客服行业

• live - 直播场景

AudioInfo

object

否

音频相关配置，不传则使用资产中配置的默认值。

AudioInfo.Voice

String

否

TTS播报发音人code，从虚拟数字人开放平台-3D资产管理页面获取，参考文档：获取发音人code，不传则使用资产中配置的发音人。

AudioInfo.Volume

Integer

否

TTS播报声音音量，取值范围：0～100，不传则使用资产中配置的默认值。

AudioInfo.SpeechRate

Integer

否

TTS播报声音语速，取值范围：-500～500，不传则使用资产中配置的默认值。

[-500, 0, 500] 对应的语速倍速区间为 [0.5, 1.0, 2.0]。

-500表示基准语速的0.5倍速； 0表示基准语速的1倍速。1倍速是指模型默认输出的合成语速，语速会依据每一个发音人略有不同，大概每秒钟4个字左右； 500表示基准语速的2倍速；

计算方法如下：

0.8倍速（1-1/0.8)/0.002 = -125

1.2倍速（1-1/1.2)/0.001 = 166

AudioInfo.PitchRate

Integer

否

TTS播报声音语调，取值范围：-500～500，不传则使用资产中配置的默认值。

Callback

Boolean

否

本次视频合成任务是否需要事件回调，默认false不回调。平台支持在任务开始和任务结束时进行事件回调，具体可参考文档：数字人回调事件通知。

CallbackParams

String

否

回调时需要平台透传的一些参数，传入该参数会在回调时添加在事件内容的callbackParams字段。

json格式字符串，callback=false时不生效。

参数

类型

是否必需

说明

TenantId

Long

是

租户ID，从虚拟数字人开放平台中获取的TenantId。参考：租户ID（TenantId）获取

App

Object

是

开发者应用信息。

App.AppId

String

是

开发者信息AppId，从虚拟数字人开放平台中获取。参考：AppId获取

Title

String

是

任务标题：

• 任务标题最长64个字。

• UTF-8编码格式

Url

String

是

音频的地址url，要求音频时长小于30分钟

VideoInfo

Object

是

视频设置。

VideoInfo.Resolution

Number

是

视频分辨率， 默认1

• 1：720x1280竖屏

• 2：1280x720横屏

• 3：1080x1920竖屏

• 4：1920x1080横屏

VideoInfo.IsAlpha

Boolean

否

是否需要透明通道， 默认false。

• true： 开启透明通道，视频格式为MOV

• false：不开启透明通道，视频格式为MP4，包含绿幕

VideoInfo.AlphaFormat

Integer

否

透明视频格式，针对透明视频目前支持MOV、WEBM两种视频格式。

1：webm

2：mov

VideoInfo.BackgroundImageUrl

String

否

指定视频背景图URL。

• 必须是有效可访问的URL背景图片地址，且背景图片的分辨率必须要与生成的视频分辨率保持一致。

• 目前支持jpg，jpeg，png的图片格式。

（请升级SDK到最新版本使用）

AvatarInfo

Object

否

数字人相关配置

AvatarInfo.code

String

否

数字人形象code，从虚拟数字人开放平台-3D资产页面获取，不传则使用应用配置的默认形象（点击查看形象code获取方法）

AvatarInfo.Locate

Integer

否

数字人机位

• 0: 全身近景机位，默认机位

• 1: 头部近景机位

• 2: 全身远景机位

• 3: 半身近景机位

• 4: 半身远景机位

• 5: 左边近景机位

• 6: 右边近景机位

具体每个机位效果可以参考：数字人机位效果展示。

AvatarInfo.Angle

Integer

否

数字人角度

• 0: 正面，默认角度

• 1: 左侧30度

• 2: 右侧30度

具体每个角度效果可以参考：数字人角度效果展示。

AvatarInfo.IndustryCode

String

否

数字人动作行业code，默认值：default

• default - 默认通用

• kefu - 客服行业

• live - 直播场景

Callback

Boolean

否

本次视频合成任务是否需要事件回调，默认false不回调。平台支持在任务开始和任务结束时进行事件回调，具体可参考文档：数字人回调事件通知。

CallbackParams

String

否

回调时需要平台透传的一些参数，传入该参数会在回调时添加在事件内容的callbackParams字段。

json格式字符串，callback=false时不生效。