提交根据一段wav音频文件生成2D数字人视频任务,该接口会立即返回一个TaskUuid作为本次提交任务的唯一id,后续可以根据TaskUuid调用查询和取消任务接口。
接口说明
提交根据一段 wav 音频离线生成 2D 数字人视频任务,该接口会立即返回一个 TaskUuid 作为本次提交任务的唯一 id,后续可以根据 TaskUuid 调用查询视频合成任务详情接口查询对应的任务的状态,当任务状态为已完成时可以获取到对应视频的下载地址,进行视频下载。在任务状态为未开始情况下,也可以通过 TaskUuid 调用取消视频合成任务接口,取消该任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
avatar:SubmitAudioTo2DAvatarVideoTask | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TenantId | long | 是 | 租户 ID,从虚拟数字人开放平台中获取的 TenantId | 20516 |
App | object | 是 | App 信息,代表一个业务配置 | |
AppId | string | 是 | App ID。在开发者中心-实例管理页面获取对应的 appId,参考文档。 | 3d95xx946a |
Title | string | 是 | 提交的视频合成的任务标题,最长不超过 32 个字符 | 常吃的皮蛋一般是由哪一种蛋加工而成的? |
VideoInfo | object | 否 | 视频配置 | |
IsAlpha | boolean | 否 | 是否需要透明通道, 默认 false
| false |
BackgroundImageUrl | string | 否 | 有效可访问的 url 背景图片地址; 背景图片的分辨率必须要与生成的视频分辨率保持一致; 目前支持 jpg,jpeg,png 的图片格式 | 可访问的公网url地址 |
Resolution | integer | 否 | 生成的视频分辨率,不同人物支持不同分辨率:
| 3 |
AlphaFormat | integer | 否 | 透明通道格式 ,默认值 1
注意 当 isAlpha 为 false 时,该字段忽略。mov 格式的透明视频文件大小会非常大,不推荐使用,建议使用 webm 或者 mp4。 | 1 |
AvatarInfo | object | 否 | 数字人形象相关配置。 | |
Code | string | 否 | 数字人形象 code,从虚拟数字人开放平台-2D 资产页面获取,不传则使用应用配置的默认形象。 | CH_2d_xxxxxxx |
X | integer | 否 | 数字人图层相对于画面左上角横轴像素偏移量,原始状态默认为 0 | 0 |
Y | integer | 否 | 数字人图层相对于画面左上角纵轴像素偏移量,原始状态默认为 0 | 0 |
Width | integer | 否 | 数字人图层宽度 | 数字人底板视频为横屏:1920 数字人底板视频为竖屏:1080 |
Height | integer | 否 | 数字人图层高度 | 数字人底板视频为横屏:1080 数字人底板视频为竖屏:1920 |
AudioInfo | object | 否 | 音频相关配置。 | |
SampleRate | integer | 否 | 输出音频采样率(单位: Hz)。 枚举值:
| 16000 |
Url | string | 是 | 音频的地址 url,要求音频时长小于 30 分钟,采样率 16K,单声道,单采样点位深 16bit | 可访问的公网url地址 |
Callback | boolean | 否 | 本次视频合成任务是否需要事件回调,默认 false 不回调。平台支持在任务开始和任务结束时进行事件回调,具体可参考文档:数字人回调事件通知。 | false |
CallbackParams | string | 否 | 回调时需要透传的一些参数,json 格式字符串,callback=false 时不生效。 | { "xxx": "xxx" } |
ExtParams | string | 否 | 一些扩展参数。 | {"xxx": "xxx"} |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "4C8BF3A5-948F-1F89-AACD-D18DEF52D1XX",
"Code": "10050008",
"Message": "这个一个错误消息。",
"Success": true,
"Data": {
"TaskUuid": "xxxx-xxx-xx-xx"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2024-01-08 | OpenAPI 入参发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-12-14 | API 内部配置变更,不影响调用 | 看变更集 | ||||||||
| ||||||||||
2023-08-01 | OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-06-25 | OpenAPI 入参发生变更 | 看变更集 | ||||||||
|