首页 虚拟数字人开放平台 API参考指南 API目录 数字人离线视频合成 SubmitTextTo3DAvatarVideoTask - 提交3D文本视频合成任务

SubmitTextTo3DAvatarVideoTask - 提交3D文本视频合成任务

提交根据一段文本离线生成3D数字人视频任务,该接口会立即返回一个TaskUuid作为本次提交任务的唯一id,后续可以根据TaskUuid调用查询和取消任务接口。

接口说明

提交根据一段文本离线生成3D数字人视频任务,该接口会立即返回一个TaskUuid作为本次提交任务的唯一id,后续可以根据TaskUuid调用查询视频合成任务详情接口查询对应的任务的状态,当任务状态为已完成时可以获取到对应视频的下载地址,进行视频下载。在任务状态为未开始情况下,也可以通过TaskUuid调用取消视频合成任务接口,取消该任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
avatar:SubmitTextTo3DAvatarVideoTaskWrite
  • Avatar
    acs:avatar::{#accountId}:*

请求参数

名称类型必填描述示例值
TenantIdlong

租户ID,从虚拟数字人开放平台中获取的TenantId

xxxx
Appobject

App信息,代表一个业务配置

AppIdstring

App ID。在业务配置详情页的右下角可以看到开发者信息AppId

12131231
Titlestring

提交的视频合成的任务标题,最长不超过64个字符

这是一个示例标题
Textstring

合成文本,最长不超过1000个字符。

这是一个示例文本
VideoInfoobject

视频格式

Resolutioninteger

生成的视频分辨率,目前支持:

  • 1:720 * 1280(竖屏)
  • 2:1280 * 720(横屏)
  • 3:1080 * 1920(竖屏)
  • 4:1920 * 1080(横屏)
1
IsSubtitlesboolean

是否需要字幕,默认值:true

  • true: 生成字幕,字幕文件格式为ass文件,会作为独立文件提供下载链接进行下载
  • false:不生成字幕
true
IsAlphaboolean

是否需要透明通道, 默认false

  • true: 开启透明通道,视频格式为MOV
  • false:不开启透明通道,视频格式为MP4,包含绿幕
false
BackgroundImageUrlstring

有效可访问的url背景图片地址,背景图片的分辨率必须要与生成的视频分辨率保持一致

  • 目前支持jpg,jpeg,png的图片格式
可访问的公网url地址
AlphaFormatinteger

透明通道格式 ,默认值1

  • 1:webm
  • 2:mov
说明当isAlpha为false时,该字段忽略
1
AvatarInfoobject

数字人相关配置

Locateinteger

数字人机位

  • 0: 全身近景机位,默认机位
  • 1: 头部近景机位
  • 2: 全身远景机位
  • 3: 半身近景机位
  • 4: 半身远景机位
  • 5: 左边近景机位
  • 6: 右边近景机位

具体每个机位的效果预览可以参考:3D数字人视频合成使用指南

0
Angleinteger

数字人角度

  • 0: 正面,默认角度
  • 1: 左侧30度
  • 2: 右侧30度

具体每个角度的效果预览可以参考:3D数字人视频合成使用指南

0
Codestring

人物code

CH_xxxxxxx

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID

13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7
Codestring

错误码

502
Messagestring

错误消息

这是一个错误
Successboolean

是否调用成功

false
Dataobject

调用返回数据

TaskUuidstring

任务唯一uuid,后续用来查询任务详情,请务必保存好

xxxxxx-xxxxx-xxxxx

TaskUuid是该任务的唯一标识,请务必保存好。

示例

正常返回示例

JSON格式

{
  "RequestId": "13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7",
  "Code": "502",
  "Message": "这是一个错误",
  "Success": false,
  "Data": {
    "TaskUuid": "xxxxxx-xxxxx-xxxxx"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-08-18API 内部配置变更,不影响调用
变更项变更内容
API 内部配置变更,不影响调用
阿里云首页 虚拟数字人 相关技术圈