提交根据一段文本离线生成2D数字人视频任务,该接口会立即返回一个TaskUuid作为本次提交任务的唯一id,后续可以根据TaskUuid调用查询和取消任务接口。
接口说明
提交根据一段文本离线生成2D数字人视频任务,该接口会立即返回一个TaskUuid作为本次提交任务的唯一id,后续可以根据TaskUuid调用查询视频合成任务详情接口查询对应的任务的状态,当任务状态为已完成时可以获取到对应视频的下载地址,进行视频下载。在任务状态为未开始情况下,也可以通过TaskUuid调用取消视频合成任务接口,取消该任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TenantId | long | 是 | 租户ID,从虚拟数字人开放平台中获取的TenantId | xxxxx |
App | object | 是 | 开发者应用信息,代表一个业务配置 | |
AppId | string | 是 | App ID。在业务配置详情页的右下角可以看到开发者信息AppId | 12131231 |
Title | string | 是 | 提交的视频合成的任务标题,最长不超过64个字符 | 这是一个示例标题 |
Text | string | 是 | 合成文本, 最长不超过1000个字符。 | 这是一个示例文本 |
VideoInfo | object | 是 | 视频配置 | |
IsSubtitles | boolean | 是 | 是否需要字幕 默认值:true true: 生成字幕,字幕文件格式为ass文件,会作为独立文件提供下载链接进行下载 false:不生成字幕 | true |
IsAlpha | boolean | 是 | 是否需要透明通道, 默认false true: 开启透明通道,视频格式为MOV false:不开启透明通道,视频格式为MP4,包含绿幕 | false |
BackgroundImageUrl | string | 否 | 有效可访问的url背景图片地址; 背景图片的分辨率必须要与生成的视频分辨率保持一致; 目前支持jpg,jpeg,png的图片格式 | 可访问的公网url地址 |
AudioInfo | object | 否 | 音频相关配置,不传则使用资产中配置的默认值。 | |
Voice | string | 否 | TTS播报发音人code,从虚拟数字人开放平台-2D资产管理页面获取,不传则使用资产中配置的发音人。 | guijie |
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 | 0 |
Volume | integer | 否 | TTS播报声音音量,取值范围:0~100,不传则使用资产中配置的默认值。 | 50 |
PitchRate | integer | 否 | TTS播报声音语调,取值范围:-500~500,不传则使用资产中配置的默认值。 | 0 |
AvatarInfo | object | 否 | 数字人形象相关配置 | |
Code | string | 否 | 数字人形象code,从虚拟数字人开放平台-2D资产页面获取,不传则使用应用配置的默认形象。 | CH_xxxxx |
返回参数
TaskUuid是该任务的唯一标识,请务必保存好。
示例
正常返回示例
JSON
格式
{
"RequestId": "13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7",
"Code": "-10000000",
"Message": "这个一次错误消息。",
"Success": false,
"Data": {
"TaskUuid": "xxxx-xxx-xxx"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2022-08-18 | API 内部配置变更,不影响调用 | |||
|