查询分身数字人视频制作任务详情 - Show2DDigitalHumanVideo
功能介绍
该接口用于查询分身数字人视频制作任务详情。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/2d-digital-human-videos/{job_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
|
job_id |
是 |
String |
任务ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
show_script |
否 |
Boolean |
是否需要返回剧本参数配置。 默认取值: false |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 |
|
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选,携带项目ID信息。 |
|
X-App-UserId |
否 |
String |
第三方用户ID。不允许输入中文。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
请求ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
job_id |
String |
任务ID。 |
|
state |
String |
任务的状态。
|
|
job_type |
String |
任务类型。
|
|
start_time |
String |
数字人视频制作开始时间。 |
|
end_time |
String |
数字人视频制作结束时间。 |
|
duration |
Float |
参数解释: 数字人视频内容时长。 取值范围: 0~2147483647 |
|
output_asset_config |
OutputAssetInfo object |
输出资产信息。 |
|
error_info |
ErrorResponse object |
错误信息。 |
|
create_time |
String |
任务创建时间。 |
|
lastupdate_time |
String |
任务更新时间。 |
|
script_id |
String |
剧本ID。 |
|
video_making_type |
String |
视频生成类型。该参数取值是MODEL时,model_asset_id必填;取值是PICTURE时,human_image必填。
说明:
|
|
human_image |
String |
人物照片,需要Base64编码。
说明:
|
|
model_asset_id |
String |
分身数字人模型资产ID,可以从资产库中查询。 |
|
voice_config |
VoiceConfig object |
语音配置参数。 |
|
video_config |
VideoConfig object |
视频输出配置。 |
|
shoot_scripts |
Array of ShootScriptItem objects |
拍摄脚本列表。 |
|
background_music_config |
BackgroundMusicConfig object |
背景音乐配置 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
asset_id |
String |
输出视频资产ID。 |
|
asset_name |
String |
输出视频资产名称。 |
|
cover_url |
String |
视频封面URL。 |
|
preview_video_url |
String |
预览视频下载URL。URL有效期24小时。
说明:
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
voice_asset_id |
String |
参数解释: 音色资产ID,可以从资产库中查询。 音色ID的查询操作,详见查询预置音色ID。 约束限制: 不涉及。 取值范围: 字符长度1-256位。 默认取值: 不涉及。 |
|
speed |
Integer |
参数解释: 语速。50表示0.5倍语速,100表示正常语速,200表示2倍语速。 当取值为“100”时,表示一个成年人的正常语速,约为250字/分钟。 约束限制: 不涉及。 取值范围: 50~200 默认取值: 100 |
|
pitch |
Integer |
参数解释: 音高。 约束限制: 不涉及。 取值范围: 50~200 默认取值: 100 |
|
volume |
Integer |
参数解释: 音量。 约束限制: 不涉及。 取值范围: 90~240 默认取值: 140 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
clip_mode |
String |
参数解释: 输出视频的剪辑方式。 约束限制: 不涉及。 取值范围:
默认取值: RESIZE |
|
codec |
String |
参数解释: 视频编码格式及视频文件格式。 约束限制: 仅分身数字人视频制作支持VP8和QTRLE编码。QTRLE编码时文本驱动字符数限制小于1500字,音频驱动音频长度小于5分钟。 QTRLE编码需要先申请开通白名单后才能使用 取值范围:
默认取值: H264 默认取值: H264 |
|
bitrate |
Integer |
参数解释: 输出平均码率。单位:kbps。 约束限制:
默认取值: 不涉及 取值范围: 40~30000 |
|
width |
Integer |
参数解释: 视频宽度。单位:像素。 约束限制:
默认取值: 不涉及 取值范围: 0~3840 |
|
height |
Integer |
参数解释: 视频高度。 单位:像素。 约束限制:
默认取值: 不涉及 取值范围: 0~3840 |
|
frame_rate |
String |
参数解释: 帧率。单位:FPS。 约束限制: 分身数字人视频固定25FPS。 默认取值: 25 |
|
is_subtitle_enable |
Boolean |
参数解释: 输出的视频是否带字幕。 约束限制: 分身数字人直播暂时不支持字幕。 取值范围:
默认取值: false |
|
subtitle_config |
SubtitleConfig object |
字幕配置。 |
|
dx |
Integer |
参数解释: 裁剪视频左上角像素点横坐标。
说明:
以模特分辨率为画布大小,比如1920*1080分辨率的模特,dx最小值是0,最大值是1920。
约束限制: clip_mode= CROP时生效。 默认取值: 不涉及 取值范围: -1920~3840 |
|
dy |
Integer |
参数解释: 裁剪视频左上角像素点纵坐标。
说明:
以模特分辨率为画布大小,比如1920*1080分辨率的模特,dy最小值是0,最大值是1080
约束限制: clip_mode= CROP时生效。 默认取值: 不涉及 取值范围: -1920~3840 |
|
is_enable_super_resolution |
Boolean |
参数解释: 视频是否开启超分。 约束限制: 仅分身数字人视频制作支持。 取值范围
默认取值: false |
|
is_end_at_first_frame |
Boolean |
参数解释: 视频结束帧是否跟起始帧相同。需要多个数字人视频无缝拼接时设置成true。 约束限制: 仅分身数字人视频制作支持,当视频制作时插入动作标签后此设置将失效。 取值范围
默认取值: false |
|
output_external_url |
String |
视频文件上传的外部URL。
说明:
|
|
is_vocabulary_config_enable |
Boolean |
参数解释: 是否应用当前租户的读法配置 约束限制: 仅分身数字人视频制作支持。 取值范围
默认取值: true |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
dx |
Integer |
参数解释: 字幕框左下角像素点坐标。 约束限制: 不涉及。 默认取值: 不涉及。 取值范围: 0~1920 |
|
dy |
Integer |
参数解释: 字幕框左下角像素点坐标。 约束限制: 不涉及。 默认取值: 不涉及。 取值范围: 0~1920 |
|
h |
Integer |
参数解释: 字幕框高度。 约束限制: 参数h用于方便前端计算字幕框左上角坐标,后台不使用该参数。 取值范围: 0~1920 |
|
w |
Integer |
参数解释: 字幕框宽度。 约束限制:
取值范围: 0~1920 |
|
font_name |
String |
参数解释: 字体。当前支持的字体请参考服务支持的字体 约束限制: 不涉及。 取值范围: 字符长度0-64位 默认取值: HarmonyOS_Sans_SC_Black |
|
font_size |
Integer |
参数解释: 字体大小。接口的取值范围为0-120,实际业务使用的取值范围要求为24-120,请以业务实际使用要求为准。 约束限制: 不涉及。 取值范围: 0~120 默认取值: 54 |
|
font_color |
String |
参数解释: 字幕字体颜色的RGB颜色值。 约束限制: 无 取值范围: 字符长度0-7位,固定长度 默认取值: #FFFFFF |
|
stroke_color |
String |
参数解释: 字幕字体描边颜色的RGB颜色值。 约束限制: 无 取值范围: 字符长度0-7位,固定长度 |
|
stroke_thickness |
Float |
参数解释: 字幕字体描边粗细像素值。 约束限制: 无 取值范围: 0-50 取值范围: 0~50 |
|
opacity |
Float |
参数解释: 字幕字体不透明度,0表示完全透明,1表示完全不透明。默认1。 约束限制: 无 取值范围: 0-1 取值范围: 0~1 默认取值: 1 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
sequence_no |
Integer |
参数解释: 剧本序号。 约束限制: 同一个剧本序号不重复。 默认取值: 不涉及。 取值范围: 0~2147483647 |
|
shoot_script |
ShootScript object |
表演脚本。 |
|
subtitle_file_info |
SubtitleFiles object |
字幕文件信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
script_type |
String |
参数解释: 脚本类型,即视频制作的驱动方式 约束限制: 不涉及 取值范围
默认取值: TEXT |
|
text_config |
TextConfig object |
讲解词配置。 |
|
audio_duration |
Float |
语音驱动时,音频时长,单位秒。
说明:
取值范围: 0~36000 |
|
audio_drive_action_config |
Array of AudioDriveActionConfig objects |
语音驱动时的动作配置。 |
|
audio_drive_file_external_url |
String |
语音驱动音频文件外部下载URL。
说明:
|
|
background_config |
Array of BackgroundConfigInfo objects |
背景配置。 |
|
layer_config |
Array of LayerConfig objects |
图层配置。 |
|
audio_config |
AudioInfo object |
音频文件信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
text |
String |
参数解释: 台词脚本。支持两种模式,纯文本模式和标签模式。
约束限制: 不含SSML标签字符数最长10000个字符。 取值范围: 字符长度0-131072位。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
action_tag |
String |
动作标签 |
|
action_name |
String |
动作名称 |
|
action_start_time |
Float |
动作开始时间 取值范围: 0~2592000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
background_type |
String |
参数解释: 背景类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及 |
|
background_config |
String |
参数解释: 背景文件的URL。 约束限制:
取值范围: 字符长度1-2048位 默认取值: 不涉及。 |
|
background_color_config |
String |
参数解释: 纯色背景的RGB颜色值。 约束限制: background_type=COLOR时需要填写。 取值范围: 字符长度0-16位 默认取值: #FFFFFF |
|
background_asset_id |
String |
参数解释: 背景资产ID。
说明:
背景是背景图片时,填图片资产ID。
约束限制: 不涉及 取值范围: 字符长度0-64位 默认取值: 不涉及 |
|
background_image_config |
BackgroundImageConfig object |
背景图片大小及位置配置。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
dx |
Integer |
参数解释: 背景图片左上角像素点的X轴位置值(画布左上角坐标是0x0)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 需要保证背景图片要铺满画布。即dx <= 0,并且横屏时dx + width >=1920,竖屏时dx + width >=1080。 取值范围: -5760~0 默认取值: 0 |
|
dy |
Integer |
参数解释: 背景图片左上角像素点的Y轴位置值(画布左上角坐标是0x0)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 需要保证背景图片要铺满画布。即dy <= 0,并且横屏时dy + height >=1080,竖屏时dy + height >=1920。 取值范围: -5760~0 默认取值: 0 |
|
width |
Integer |
参数解释: 背景图片宽度像素值(相对画布大小)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 需要保证背景图片要铺满画布。即width > 1080,并且横屏时dx + width >=1920,竖屏时dx + width >=1080。 取值范围: 1~7680 |
|
height |
Integer |
参数解释: 背景图片高度像素值(相对画布大小)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 需要保证背景图片要铺满画布。height> 1080,并且横屏时dy + height >=1080,竖屏时dy + height >=1920。 取值范围: 1~7680 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
layer_type |
String |
参数解释: 图层类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及 |
|
asset_id |
String |
参数解释: 图层所需资产的资产id,外部资产信息无需填写。 约束限制: 不涉及。 取值范围: 字符长度0-64位 默认取值: 不涉及 |
|
group_id |
String |
参数解释: 多场景素材编组。同一group_id的素材,在应用全局时共享位置信息。 约束限制: 不涉及。 取值范围: 字符长度0-64位 默认取值: 不涉及 |
|
sequence_no |
Integer |
参数解释: 播放到对应的段落,显示对应的图层。该字段向前兼容,可以不填,字段可选。 只支持直播业务。 约束限制: 段落sequence_no。 默认取值: 不涉及。 取值范围: 0~2147483647 |
|
position |
LayerPositionConfig object |
图层位置配置。 |
|
size |
LayerSizeConfig object |
图层大小配置。 |
|
rotation |
LayerRotationConfig object |
图层旋转配置。 |
|
image_config |
ImageLayerConfig object |
素材图片图层配置。 |
|
video_config |
VideoLayerConfig object |
素材视频图层配置。 |
|
text_config |
TextLayerConfig object |
素材文字图层配置。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
dx |
Integer |
参数解释: 图层左上角像素点的X轴位置值(画布左上角坐标是0x0)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。 取值范围: -1920~3840 默认取值: 0 |
|
dy |
Integer |
参数解释: 图层图片左上角像素点的Y轴位置值(画布左上角坐标是0x0)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。 取值范围: -1920~3840 默认取值: 0 |
|
layer_index |
Integer |
参数解释: 图片、视频、人物图的层顺序。
说明:
图层顺序为从1开始的整数,底层图层顺序是1,往上依次增加。
约束限制: 如果出现重复则重复图层叠加关系随机。 取值范围: 1~100 默认取值: 100 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
width |
Integer |
参数解释: 图层图片左上角像素点的Y轴位置值图层图片宽度像素值(相对画布大小)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。 取值范围: 1~7680 |
|
height |
Integer |
参数解释: 图层图片高度像素值(相对画布大小)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。| 取值范围: 1~7680 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
angle |
Integer |
参数解释: 旋转角度。 取值范围: 角度范围0-360度。 默认取值: 0度。 约束限制: 以素材中心点旋转。 视频素材不支持旋转 取值范围: 0~360 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
image_url |
String |
参数解释: 图片文件的URL。 约束限制:
取值范围: 字符长度1-2048位。 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
video_url |
String |
参数解释: 视频文件的URL。 约束限制:
取值范围: 字符长度1-2048位。 默认取值: 不涉及。 |
|
video_cover_url |
String |
参数解释: 视频封面文件的URL。 约束限制:
取值范围: 字符长度1-2048位。 默认取值: 不涉及。 |
|
loop_count |
Integer |
参数解释: 循环播放视频次数。 特殊取值:
约束限制: 不涉及。 取值范围: -1~100 默认取值: -1 |
|
video_sound |
Integer |
参数解释: 按照百分比,调整视频素材的音量,取值为0-100。 特殊取值为0,表示不开启声音(默认值)。 约束限制: 不涉及。 取值范围: 0~100 |
|
is_play_the_entire_video |
Boolean |
参数解释: 是否播放完整个视频,true表示播放完整个视频,false表示当场景文本/音频结束时,视频也同时不再播放。 特殊取值: 默认值为false 约束限制: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
text_context |
String |
参数解释: 文字图层的文本,内容需做Base64编码。 示例:若想添加文字水印“测试文字水印”,那么text_context的值为:5rWL6K+V5paH5a2X5rC05Y2w 约束限制: 不涉及。 取值范围: 字符长度0-1024位。 默认取值: 不涉及。 |
|
font_name |
String |
字体。当前支持的字体请参考服务支持的字体 约束限制: 不涉及。 取值范围: 字符长度0-64位 默认取值: HarmonyOS_Sans_SC_Black |
|
font_size |
Integer |
参数解释: 字体大小(像素)。接口的取值范围为0-120,实际业务使用的取值范围要求为4-120,请以业务实际使用要求为准。 约束限制: 不涉及。 取值范围: 0~120 默认取值: 16 |
|
font_color |
String |
参数解释: 字体颜色。RGB颜色值。 约束限制: 不涉及。 取值范围: 字符长度0-16位 默认取值: #FFFFFF |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
audio_id |
Integer |
参数解释: 音频id。
说明:
约束限制: 不涉及 默认取值: 不涉及 取值范围: 0~10000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
text_subtitle_file |
SubtitleFileInfo object |
|
|
audio_subtitle_file |
SubtitleFileInfo object |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
subtitle_file_download_url |
String |
字幕文件下载链接。 |
|
subtitle_file_upload_url |
String |
字幕文件上传链接。 |
|
subtitle_file_state |
String |
字幕文件生成状态。
|
|
job_id |
String |
字幕文件生成任务ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
music_asset_id |
String |
参数解释: 音乐资产ID。 约束限制: 不涉及。 取值范围: 字符长度0-64位。 默认取值: 不涉及。 |
|
volume |
Integer |
参数解释: 音乐音量。如100,表示音量100%,50表示音量50%。 约束限制: 不涉及。 取值范围: 0~100 默认取值: 100 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
GET https://{endpoint}/v1/0d697589d98091f12f92c0073501cd79/2d-digital-human-videos/26f06524-4f75-4b3a-a853-b649a21aaf66
响应示例
状态码:200
处理成功返回。
{
"job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66",
"state" : "SUCCESS",
"start_time" : "2022-01-18T16:29:36Z",
"end_time" : "2022-01-18T16:30:36Z",
"duration" : 60,
"output_asset_config" : {
"asset_id" : "942e65a5fd219a2e01fb08d881cfadb9",
"asset_name" : "One Day",
"cover_url" : "https://{endpoint}/0d697589d98091f12f92c0073501cd79/942e65a5fd219a2e01fb08d881cfadb9/20d367508e62d3d4ad608cedbe81bd35.png?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671241457&Signature=zVGMVbI5ji9rr8epD1Cir5OGIRk%3D"
},
"error_info" : null,
"create_time" : "2022-11-30T06:59:56Z",
"lastupdate_time" : "2022-11-30T07:00:09Z",
"script_id" : "4b5b6effcf3b4c72a0baccb265111765",
"model_asset_id" : "cda7e9a469ee9cf3ffc1ad62794a12ff",
"voice_config" : {
"voice_asset_id" : "f5e6a13eab4443fa85421191ad061780",
"speed" : 100,
"pitch" : 100,
"volume" : 140
},
"video_config" : {
"codec" : "H264",
"bitrate" : 5000,
"width" : 720,
"height" : 1280,
"frame_rate" : 30
},
"shoot_scripts" : [ {
"sequence_no" : 0,
"shoot_script" : {
"text_config" : {
"text" : "大家好,我是云玲。"
},
"background_config" : [ {
"background_type" : "IMAGE",
"background_config" : "https://{endpoint}/0d697589d98091f12f92c0073501cd79/c7885ffdfb347337a890208ca7fd07e3/34534f0262813a6838bdcfb8bc949af6.jpg?AccessKeyId=WTEZCVDFUF3XHXCTPIJ8&Expires=1686901332&Signature=2E7Y7joo2NopBsU8u3iDnf2P9p8%3D"
} ],
"layer_config" : [ {
"layer_type" : "HUMAN",
"position" : {
"dx" : 656,
"dy" : 0,
"layer_index" : 1
},
"size" : {
"width" : 607,
"height" : 1080
}
} ],
"script_type" : "TEXT"
}
} ]
}
状态码:400
请求传参异常,包含错误码及对应描述。
{
"error_code" : "MSS.00000003",
"error_msg" : "Invalid parameter"
}
状态码:401
未鉴权或鉴权失败。
{
"error_code" : "MSS.00000001",
"error_msg" : "Unauthorized"
}
状态码:404
无内容。
{
"error_code" : "MSS.00000002",
"error_msg" : "Not Found"
}
状态码:500
内部服务错误。
{
"error_code" : "MSS.00000004",
"error_msg" : "Internal Error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
处理成功返回。 |
|
400 |
请求传参异常,包含错误码及对应描述。 |
|
401 |
未鉴权或鉴权失败。 |
|
404 |
无内容。 |
|
500 |
内部服务错误。 |
错误码
请参见错误码。