提交根据一段文本离线生成3D数字人视频任务,该接口会立即返回一个TaskUuid作为本次提交任务的唯一id,后续可以根据TaskUuid调用查询和取消任务接口。
接口说明
提交根据一段文本离线生成3D数字人视频任务,该接口会立即返回一个TaskUuid作为本次提交任务的唯一id,后续可以根据TaskUuid调用查询视频合成任务详情接口查询对应的任务的状态,当任务状态为已完成时可以获取到对应视频的下载地址,进行视频下载。在任务状态为未开始情况下,也可以通过TaskUuid调用取消视频合成任务接口,取消该任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
avatar:SubmitTextTo3DAvatarVideoTask | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TenantId | long | 是 | 租户ID,从虚拟数字人开放平台中获取的TenantId | xxxx |
App | object | 是 | App信息,代表一个业务配置 | |
AppId | string | 是 | App ID。在业务配置详情页的右下角可以看到开发者信息AppId | 12131231 |
Title | string | 是 | 提交的视频合成的任务标题,最长不超过64个字符 | 这是一个示例标题 |
Text | string | 是 | 合成文本,最长不超过1000个字符。 | 这是一个示例文本 |
VideoInfo | object | 否 | 视频格式 | |
Resolution | integer | 是 | 生成的视频分辨率,目前支持:
| 1 |
IsSubtitles | boolean | 否 | 是否需要字幕,默认值:true
| true |
IsAlpha | boolean | 否 | 是否需要透明通道, 默认false
| false |
BackgroundImageUrl | string | 否 | 有效可访问的url背景图片地址,背景图片的分辨率必须要与生成的视频分辨率保持一致
| 可访问的公网url地址 |
AlphaFormat | integer | 否 | 透明通道格式 ,默认值1
说明当isAlpha为false时,该字段忽略 | 1 |
AvatarInfo | object | 否 | 数字人相关配置 | |
Locate | integer | 否 | 数字人机位
具体每个机位的效果预览可以参考:3D数字人视频合成使用指南 | 0 |
Angle | integer | 否 | 0 | |
Code | string | 否 | 人物code | CH_xxxxxxx |
返回参数
TaskUuid是该任务的唯一标识,请务必保存好。
示例
正常返回示例
JSON
格式
{
"RequestId": "13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7",
"Code": "502",
"Message": "这是一个错误",
"Success": false,
"Data": {
"TaskUuid": "xxxxxx-xxxxx-xxxxx"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2022-08-18 | API 内部配置变更,不影响调用 | |||
|