数据结构
CallbackConfig
事件回调设置
名称 |
类型 |
说明 |
callbackUrl |
string |
HTTP回调地址 |
enableSign |
boolean |
是否开启签名 |
signKey |
string |
签名key |
enableMediaUploadCompleteEvent |
boolean |
是否开启媒资上传完成事件通知 |
enableMediaFetchCompleteEvent |
boolean |
是否开启媒资拉取完成事件通知 |
enableMediaTranscodeCompleteEvent |
boolean |
是否开启媒资转码完成事件通知 |
enableMediaThumbnailCompleteEvent |
boolean |
是否开启媒资截图完成事件通知 |
enableMediaAnalysisCompleteEvent |
boolean |
是否开启媒资分析完成事件通知 |
enableMediaRegulationCompleteEvent |
boolean |
是否开启媒资审核完成事件通知 |
enableComposeTaskStatusChangeEvent |
boolean |
是否开启视频云剪辑任务状态变更事件通知 |
enableMediaRestoreCompleteEvent |
boolean |
是否开启媒资取回完成事件通知 |
enableVideoGenerateCompleteEvent |
boolean |
是否开启视频生成完成事件通知 |
CallbackEvent
事件回调消息
ComposeOutput
字段 |
类型 |
必要性 |
默认值 |
说明 |
fileName |
string |
是 |
|
导出视频保存到媒资库的文件名 |
videoCodec |
string(枚举) |
|
h264 |
导出视频编码,取值:h264, h265 |
audioCodec |
string(枚举) |
|
aac |
导出音频编码,取值:aac, mp3 |
width |
int |
|
1920 |
导出分辨率宽度 |
height |
int |
|
1080 |
导出分辨率高度 |
frameRate |
float |
|
30 |
导出帧率 |
audioSampleRateInHz |
int |
|
44100 |
导出音频采样率。各编码支持的采样率: mp3: 44100, 48000, 32000, 22050, 24000, 16000, 11025, 12000, 8000. aac: 96000, 88200, 64000, 48000, 44100, 32000, 24000, 22050, 16000, 12000, 11025, 8000, 7350. |
audioChannels |
int |
|
2 |
导出音频声道数,取值范围[1,7] |
compressionType |
string(枚举) |
|
mid |
导出视频压缩质量,取值:high(高), mid(中), low(低) |
gop |
int |
|
125 |
导出视频 i 帧最大间隔 |
注意:导出配置将影响任务处理耗时,例如较高的分辨率、帧率、质量等都将增加任务耗时,请合理配置。
ComposeTaskInfo
视频云剪辑任务信息
名称 |
类型 |
说明 |
status |
string |
运行状态,包括- CREATED
- PENDING
- RUNNING
- FAILED
- SUCCESS
|
errMsg |
string |
错误信息 |
mediaId |
string |
媒资ID |
output |
ComposeTaskOutput |
视频云剪辑任务输出参数 |
ComposeTaskOutput
视频云剪辑任务输出信息
名称 |
类型 |
说明 |
mediaId |
string |
视频云剪辑视频导入媒资库的媒资ID |
url |
string |
视频云剪辑视频播放地址 |
ComposeTaskStatusChangeEvent
视频云剪辑任务状态变更回调事件内容
名称 |
类型 |
说明 |
taskId |
string |
任务ID |
status |
string |
运行状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
|
createTime |
string |
任务创建时间, 例如2024-10-11T13:48:01Z |
finishTime |
string |
任务完成时间 |
beginProcessTime |
string |
任务开始时间 |
composeTaskInfo |
ComposeTaskInfo |
视频云剪辑任务信息 |
ComposeTimeline
ComposeTimelineAudioItem
字段 |
类型 |
必要性 |
默认值 |
说明 |
mediaId |
string |
与sourceUrl二选一 |
|
媒资库的媒资 id |
sourceUrl |
string |
|
|
文件链接。当 mediaId 为空时必须提供 sourceUrl ,发起任务后将自动保存到VOD媒资库 |
start |
float |
是 |
|
视频片段取自素材文件的起始时间,单位为秒,支持3位小数,默认为0。 |
duration |
float |
是 |
|
视频片段时长,单位为秒。默认取视频素材本身长度,表示截取全部素材。必须大于0 |
showStart |
float |
是 |
|
截取片段在作品中的播放起点,单位秒 |
showDuration |
float |
是 |
|
截取片段在作品中的播放时长,单位秒。必须大于0 |
durationPaddingType |
string(枚举) |
|
loop |
当 duration < showDuration 时,不足部分的填充方式。
loop :循环播放截取的片段
last_frame :静止播放截取片段的最后一帧 |
audioOperations |
ComposeTimelineAudioOperation[] |
|
|
对截取的音频片段进行的操作,如音量调节等。列表元素最多1个。 |
注意事项
- 优先使用
mediaId
而不是sourceUrl
,因为提供sourceUrl
会在处理之前先将其存储到媒资库,有一定的时间消耗。
ComposeTimelineAudioOperation
字段 |
类型 |
必要性 |
默认值 |
说明 |
volume |
float |
|
1.0 |
音量调节倍数,0 表示静音,取值范围 [0, 16] |
speed |
float |
|
1.0 |
播放倍速,仅音频节点生效,取值范围 [0.01, 16] |
ComposeTimelineAudioTrack
ComposeTimelineImageOperation
字段 |
类型 |
必要性 |
默认值 |
说明 |
speed |
float |
|
1.0 |
播放倍速,精确到小数点后2位,取值范围为[0.01,16] |
crop |
object |
|
|
裁剪区域 |
[+] xpos |
float |
|
0 |
裁剪区域的左上角横坐标比例,取值范围为[0.0~1.0] |
[+] ypos |
float |
|
0 |
裁剪区域的左上角纵坐标比例,取值范围为[0.0~1.0] |
[+] width |
float |
|
1 |
裁剪区域的宽度比例,取值范围为[0.0~1.0]。要求 xpos + width <= 1.0 |
[+] height |
float |
|
1 |
裁剪区域的高度比例,取值范围为[0.0~1.0]。要求 ypos + height <= 1.0 |
rotate |
int |
|
0 |
顺时针旋转角度,取值[0,359] |
mirror |
string(枚举) |
|
|
镜像效果,取值:hori (左右镜像),vert (上下镜像),full (旋转180度) |
posMovement |
object |
|
|
运动效果 |
[+] viewBox |
string(枚举) |
|
fixed |
画布上用于展示运动效果的区域。取值:
fixed :素材运动效果的展示区域固定在 VideoItem.{xpos, ypos, width, height} (默认全屏),输入视频会提前放大到适当比例再运动,保证运动过程中视频边缘不进入该区域。 |
[+] type |
string(枚举) |
|
|
运动方式。取值:left (向左), right (向右), up (向上), down (向下), leftUp (向左上), leftDown (向左下), rightUp (向右上), rightDown (向右下), zoomIn (放大), zoomOut (缩小) |
[+] speed |
float |
|
0 |
运动速度,单位“比例/秒”(每秒相对于输入画面的变化比例)。例如 speed=0.1 ,则 x 方向每秒可变化 0.1*VideoItem.width ,y 方向每秒可变化 0.1*VideoItem.height 。 |
注意事项
- 由于裁剪、旋转、镜像等操作的顺序不同则效果不同,请放置到列表
VideoItem.imageOperations
不同元素内以确保执行顺序;
- 在同一个ImageOperation内若共存以下多个字段,将按该参数表中的顺序执行。
ComposeTimelineSubtitleItem
字段 |
类型 |
必要性 |
默认值 |
说明 |
showStart |
float |
是 |
|
在作品中的播放起点,单位秒 |
showDuration |
float |
是 |
|
在作品中的播放时长,单位秒。必须大于0 |
xpos |
float |
|
0.5 |
放置到作品中的水平横坐标 |
ypos |
float |
|
0.9 |
放置到作品中的竖直纵坐标。xpos, ypos 是字幕锚点的坐标 |
text |
string |
是 |
|
文本内容。仅支持可见文字及其标点符号(不支持 emoji 表情、特殊字符等),如需换行请使用 Unix 换行符 \n。不能超过 600 个 UTF-8 字符数。注意字数过多或字体过大可能会导致文字超出屏幕而不可见。 |
textAlign |
string(枚举) |
|
center |
文本对齐方式,即字幕锚点,取值:left , center , right , bottomLeft , bottomCenter , bottomRight , topLeft , topCenter , topRight |
fontFamily |
string(枚举) |
|
方正黑体简体 |
字体名称。取值:方正黑体简体 , 楷体 , 思源宋体 CN , Noto Sans SC Black , Noto Sans SC SemiBold , Noto Sans SC Medium , Noto Sans SC Thin ;全部字体名称列表及示例请参考文末附录 |
fontSize |
int |
|
40 |
字体大小,即字体高度的像素点数。无大小限制,注意过大会超出屏幕范围,过小会难以看到。 |
fontSpacing |
int |
|
0 |
字间距,单位为像素。无大小限制,注意过大会超出屏幕范围,过小会难以看到。 |
fontBold |
bool |
|
false |
字体是否加粗 |
fontItalic |
bool |
|
false |
斜体 |
fontUnderline |
bool |
|
false |
下划线 |
fontStrikeOut |
bool |
|
false |
删除线 |
fontColor |
string |
|
#FFFFFF |
文字颜色,默认白色。取值范围[#000000, #FFFFFF](十六进制) |
fontAlpha |
float |
|
0 |
文字透明度,取值[0.0,1.0],默认不透明 |
fontOutlineColor |
string |
|
#000000 |
字体描边颜色,默认黑色。取值范围[#000000, #FFFFFF](十六进制) |
fontOutlineAlpha |
float |
|
0 |
字体描边透明度,取值范围[0.9,1.0],默认不透明 |
fontOutlineWidth |
int |
|
2 |
每个字的描边厚度,单位为像素。取值最小为 0,注意值过大会导致文字难以观看。 |
ComposeTimelineSubtitleTrack
ComposeTimelineVideoItem
字段 |
类型 |
必要性 |
默认值 |
说明 |
mediaId |
string |
与sourceUrl二选一 |
|
媒资库的媒资 id |
sourceUrl |
string |
|
|
文件链接。当 mediaId 为空时必须提供 sourceUrl ,发起任务后将自动保存到VOD媒资库 |
type |
string(枚举) |
是 |
video |
素材类型,取值:video , image , mosaic 。注意 gif 动图请填 video 类型。 |
start |
float |
type=video时必需 |
0 |
视频片段取自素材文件的起始时间,单位为秒 |
duration |
float |
type=video时必需 |
|
视频片段时长,单位为秒。默认取视频素材本身长度,表示截取全部素材。必须大于0 |
showStart |
float |
是 |
0 |
截取片段在作品中的播放起点,单位秒 |
showDuration |
float |
是 |
|
截取片段在作品中的播放时长,单位秒。必须大于0 |
durationPaddingType |
string(枚举) |
|
loop |
当 duration < showDuration 时,不足部分的填充方式。
loop :循环播放截取的片段
last_frame :静止播放截取片段的最后一帧 |
audioOperations |
ComposeTimelineAudioOperation[] |
|
|
对输入音频的操作。列表元素最多1个。 |
imageOperations |
ComposeTimelineImageOperation[] |
|
|
对输入图像的操作(包括视频、图片、马赛克)。列表元素最多5个,且裁剪/旋转/镜像三种不允许放在同一个元素内。 |
position |
string(枚举) |
|
custom |
处理后的画面放置到作品中的位置,取值:
custom 自定义xpos ,ypos ,width ,height ;
fill 保持宽高比不变,缩放至填充满整个屏幕,并居中,多余部分裁剪掉;
fit 保持宽高比不变,完整显示整个图像,缩放至最大并居中,可能会留下黑边;
stretch 自动拉伸宽高与屏幕重合,注意图像可能会变形;
center 保持原图像尺寸不变,居中 |
xpos |
float |
|
0.0 |
素材放置到作品中的水平横坐标,允许超出屏幕范围,超出部分在屏幕外自然不可见 |
ypos |
float |
|
0.0 |
素材放置到作品中的竖直纵坐标 |
width |
float |
|
1.0 |
素材放置到作品中的宽度,取值大于0。允许超出屏幕范围 |
height |
float |
|
1.0 |
素材放置到作品中的高度,取值大于0。允许超出屏幕范围 |
温馨提示
ComposeTimelineVideoItem.{xpos,ypos,width,height}
表示素材经过imageOperations
一系列操作之后得到的结果放置到作品中的位置,允许超出作品画面范围,超出部分在屏幕外自然不可见。
ComposeTimlineImageOperation.crop.{xpos,ypos,width,height}
表示对输入画面进行裁剪之后所保留的区域,裁剪区域不能超出输入画面范围。
ComposeTimelineVideoTrack
AI 换发特效特定输入参数
参数 |
类型 |
描述 |
hairColor |
string |
头发颜色, 非必填,默认:Original Hair Color,包括:- Original Hair Color:原发色
- Raspberry Purple:树莓紫
- Milk Tea Goldr:奶茶金
- Dirty Orange:脏橘色
- Sweet Cherry Pink:甜樱粉
- Linen Brown:亚麻棕
- Hatsune Color:初音色
|
特效视频 P 任务输入参数
参数 |
类型 |
描述 |
effect |
string |
特效类型, 包括:- we_are_venom: 我们是毒液
- warmth_of_jesus: 温暖耶稣
- hug_your_love: 拥抱爱人
- muscle_surge: 肌肉激增
- the_tigers_touch: 虎之触
- kiss_kiss: 亲亲
- leggy_run: 长腿奔跑
- alive_art: 活灵活现的艺术
- squish_it: 挤压它
- hulk: 绿巨人
- black_myth_wukong: 黑神话悟空
- sailor_moon: 美少女战士
- sheep_curls: 羊毛卷
- long_hair_magic: 长发魔法
- crazy_cat_woman: 疯狂猫女
- wonder_woman: 神奇女侠
- jokers_rebirth: 小丑重生
- batman: 蝙蝠侠
- colorful_venom: 多彩毒液
- iron_man: 钢铁侠
- chinese_new_year_dress: 春节服装
- chinese_god_of_wealth: 财神
- hot_harley_quinn: 火辣哈莉奎因
- who_is_venom: 谁是毒液
- get_a_venom_buddy: 获得毒液伙伴
- wicked_shots: 邪恶镜头
- lego_blast: 乐高爆炸
- monster_invades: 怪物入侵
|
image |
ImageToVideoImageItem[] |
图片信息 |
prompt |
string |
提示词 |
negativePrompt |
string |
负面提示词,非比填 |
duration |
int |
视频时长, 单位 s,支持: |
resolution |
string |
视频分辨率,支持: |
motionMode |
string |
生成模式,非必填,默认 normal,支持: (normal, fast, --fast only available when duration=5; --resolution=1080p does not support fast) |
style |
string |
风格,非必填,支持: - anime
- 3d_animation
- clay
- comic
- cyberpunk
|
seed |
integer |
随机种子,非必填 |
EffectVideoRequest
特效视频任务输入参数
特效视频 V 任务输入参数
参数 |
类型 |
描述 |
effect |
string |
特效类型, 包括:- hug: 拥抱
- kiss: 亲吻
- christmas_santa_transformation: 变身为圣诞老人
- christmas_santa_gift_delivery: 圣诞老人来送礼
- christmas_toast_celebration: 圣诞节举杯庆祝
- christmas_santa_hug: 圣诞老人来拥抱
- expansion_deformation: 膨胀
- squeeze_deformation: 捏捏
- bomb_effect_deformation: 爆炸
- melt_deformation: 融化
- sweet_smile_live_photo: 甜美微笑
- wind_live_photo: 风动
- camera_motion_live_photo: 镜头动
- walk_live_photo: 走路
- terror_emotion: 恐惧
- smile_emotion: 微笑
- laugh_emotion: 狂笑
- surprise_emotion: 惊讶
- old_photo_animation: 老照片动起来
- hair_swap_wool_curls: 换羊毛卷发型
- hair_swap_twin_tails: 换双马尾发型
- hair_swap_long_hair: 换长发
- interaction_heart_gesture: 比心
- interaction_give_rose: 送玫瑰花
- lunar_newyear_2025_fireworks: 2025新年烟花
- lunar_newyear_dual_toast: 双人举杯
- lunar_newyear_red_envelope_rain: 红包雨
- youth_rewind_memory: 童年回忆
- dynasty_dress_swap: 古风换装
- love_pose_family_heart: 全家福比心
- wish_sender_heart_with_god_of_wealth: 和财神比心
- wish_sender_coin_rain: 财神发金币
- dreamy_wedding: 梦幻婚礼
- romantic_lift: 浪漫公主抱
- sweet_proposal: 甜蜜求婚
- couple_flower_presentation: 情侣送花
- couple_hug: 情侣拥抱
- couple_kiss: 情侣接吻
- couple_wave: 情侣挥手
- cupid_arrow: 丘比特之箭
- pet_lovers: 萌宠恋人
- captain_america: 变身美队
- hulk: 美队同行
- cap_walk: 萌宠恋人
- hulk_dive: 浩克俯冲
|
images |
ImageToVideoImageItem[] |
图片信息 |
hairSwapInput |
EffectHairSwapInput |
AI 换发特效特定输入参数,非必填 |
aspectRatio |
string |
比例,非必填,默认 9:16,部分特效支持 |
视频延长 K 任务输入参数
参数 |
类型 |
描述 |
mediaId |
string |
媒资id(仅支持K10模型,且时长不能超过3分钟) |
prompt |
string |
提示词 |
HighlightUnderstandTaskInfo
精彩集锦视频理解任务信息
名称 |
类型 |
说明 |
projectId |
string |
集锦项目ID |
projectName |
string |
集锦项目名称 |
errMsg |
string |
错误信息 |
ImageToVideoDynamicMask
动态笔刷配置列表
可配置多组(最多6组),每组包含“涂抹区域 mask”与“运动轨迹 trajectories”序列
ImageToVideoHeadtailImages
首尾帧图片信息
ImageToVideoImageItem
图片信息
参数 |
类型 |
描述 |
imageUrl |
string |
图片链接 |
图生视频 K10 任务输入参数, 传参 headtailImages,image 有且仅需有一个
参数 |
类型 |
描述 |
headtailImages |
ImageToVideoHeadtailImages |
首尾帧图片信息, 首尾生必填 |
image |
ImageToVideoImageItem |
图片信息, 图生必填 |
prompt |
string |
提示词 |
negativePrompt |
string |
负面提示词 |
cfgScale |
float |
自由度,非必填,默认0.5,取值范围:[0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
duration |
int |
视频时长, 单位 s,支持: |
motionMode |
string |
生成模式,非必填,默认 std,支持: |
staticMask |
ImageToVideoImageItem |
静态笔刷涂抹区域(用户通过运动笔刷涂抹的 mask 图片) - 图片长宽比必须与输入图片相同,否则任务失败
- staticMask 和 dynamicMasks.mask 这两张图片的分辨率必须一致,否则任务失败
|
dynamicMasks |
ImageToVideoDynamicMask[] |
动态笔刷配置列表,非必填,默认 std,支持: |
图生视频 K15 任务输入参数, 传参 headtailImages,image 有且仅需有一个
图生视频 K16 任务输入参数, 传参 headtailImages,image 有且仅需有一个
参数 |
类型 |
描述 |
headtailImages |
ImageToVideoHeadtailImages |
首尾帧图片信息, 首尾生必填 |
image |
ImageToVideoImageItem |
图片信息, 图生必填 |
prompt |
string |
提示词 |
negativePrompt |
string |
负面提示词 |
cfgScale |
float |
自由度,非必填,默认0.5,取值范围: [0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
duration |
int |
视频时长, 单位 s,支持: |
motionMode |
string |
生成模式,非必填,默认 std,支持: |
图生视频 P35 任务输入参数
参数 |
类型 |
描述 |
image |
ImageToVideoImageItem[] |
图片信息 |
prompt |
string |
提示词 |
negativePrompt |
string |
负面提示词,非必填 |
duration |
int |
视频时长, 单位 s,支持: |
resolution |
string |
视频分辨率,支持: |
motionMode |
string |
生成模式,非必填,默认 normal,支持: (normal, fast, --fast only available when duration=5; --resolution=1080p does not support fast) |
style |
string |
风格,非必填,支持: - anime
- 3d_animation
- clay
- comic
- cyberpunk
|
seed |
integer |
随机种子,非必填 |
ImageToVideoRequest
图生视频任务输入参数
ImageToVideoTrajectory
运动轨迹坐标序列
- 生成5s的视频,轨迹长度不超过77,即坐标个数取值范围:[2, 77]
- 轨迹坐标系,以图片左下角为坐标原点
- 坐标点个数越多轨迹刻画越准确,如只有2个轨迹点则为这两点连接的直线
- 轨迹方向以传入顺序为指向,以最先传入的坐标为轨迹起点,依次链接后续坐标形成运动轨迹
参数 |
类型 |
描述 |
x |
integer |
轨迹点横坐标(在像素二维坐标系下,以输入图片image左下为原点的像素坐标) |
y |
integer |
轨迹点纵坐标(在像素二维坐标系下,以输入图片image左下为原点的像素坐标) |
图生视频 V10 任务输入参数, 传参 characterImages,image 有且仅需有一个
图生视频 V15 任务输入参数, 传参 characterImages,headtailImages,image 有且仅需有一个
参数 |
类型 |
描述 |
characterImages |
ImageToVideoImageItem[] |
参考图片信息, 参考生必填 |
headtailImages |
ImageToVideoHeadtailImages |
首尾帧图片信息, 首尾生必填 |
image |
ImageToVideoImageItem |
图片信息, 图生必填 |
prompt |
string |
生成的提示文本 |
duration |
integer |
视频时长, 单位 s,支持: |
resolution |
string |
分辨率, 支持: |
seed |
integer |
随机种子,非必填 |
aspectRatio |
string |
比例,非必填,默认16:9 , 支持: |
movementAmplitude |
string |
运动幅度,非必填,默认auto, 支持: |
图生视频 V20 任务输入参数, 传参 characterImages,headtailImages,image 有且仅需有一个
参数 |
类型 |
描述 |
characterImages |
ImageToVideoImageItem[] |
参考图片信息, 参考生必填 |
headtailImages |
ImageToVideoHeadtailImages |
首尾帧图片信息, 首尾生必填 |
image |
ImageToVideoImageItem |
图片信息, 图生必填 |
prompt |
string |
生成的提示文本 |
duration |
integer |
视频时长, 单位 s,支持: |
resolution |
string |
分辨率, 支持: |
seed |
integer |
随机种子,非必填 |
aspectRatio |
string |
比例,非必填,默认16:9 , 支持: |
movementAmplitude |
string |
运动幅度,非必填,默认auto, 支持: |
媒资AI分析完成回调事件内容
名称 |
类型 |
说明 |
taskId |
string |
任务ID |
status |
string |
运行状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
|
createTime |
string |
任务创建时间 |
finishTime |
string |
任务完成时间 |
beginProcessTime |
string |
任务开始时间 |
analysisTaskInfo |
MediaAnalysisTaskInfo |
拉取任务信息 |
媒资AI分析结果信息
媒资AI分析结果的场景类型枚举
分析场景 |
描述 |
figure |
人脸 |
keyword |
关键字 |
scenario |
场景 |
entity |
实体 |
logo |
logo |
knowledge_graph |
知识图谱 |
媒资AI分析结果场景列表。AI分析结果一般有多个场景分类,这是一个场景结果的数据结构
媒资AI分析结果分类中的某一个类型的结果。
名称 |
类型 |
说明 |
attribute |
string |
分析结果标签 |
source |
string |
标签来源 |
媒资AI分析任务信息
媒资AI分析任务输入参数
名称 |
类型 |
说明 |
presetId |
string |
AI分析模板ID |
媒资音频编码信息
名称 |
类型 |
说明 |
codec |
string |
音频编码规格 |
channels |
int |
音频文件的声道信息 |
sampleRateInHz |
int |
音频文件的采样率,单位:Hz |
bitRateInBps |
int |
音频文件的码率,单位:bps |
媒资基本信息
名称 |
类型 |
说明 |
mediaId |
string |
媒资ID |
name |
string |
媒资名称 |
description |
string |
媒资描述 |
mediaType |
string |
媒资类型,video/image/audio |
banStatus |
string |
媒资封禁状态, |
createTime |
string |
创建时间 |
categoryId |
string |
媒资分类ID |
tags |
string[] |
媒资标签列表 |
source |
MediaSource |
媒资源信息 |
sourceMetadata |
MediaSourceMetadata |
媒资源文件元信息 |
媒资视频黑边信息
名称 |
类型 |
说明 |
x |
int |
去黑边后的视频左偏移位置,单位:像素 |
y |
int |
去黑边后的视频上偏移位置,单位:像素 |
width |
int |
去黑边后的视频宽度,单位:像素 |
height |
int |
去黑白后的视频高度,单位:像素 |
媒资视频黑边检测输出信息
媒资视频黑边检测任务信息
媒资视频黑边检测任务的输入参数
名称 |
类型 |
说明 |
presetId |
string |
转码模板ID,使用去黑边时必填 |
黑边视频信息
名称 |
类型 |
说明 |
width |
int |
视频宽度,单位:像素 |
height |
int |
视频高度,单位:像素 |
rotate |
int |
视频旋转角度,单位:度 |
媒资详细信息,继承自MediaBasicInfo,还包含以下参数
视频数字水印提取任务信息
名称 |
类型 |
说明 |
mediaId |
string |
媒资ID |
transcodeOutputId |
string |
转码输出ID,即转码模板ID,用于指定媒资的某个转码输出视频 |
status |
string |
运行状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
|
errMsg |
string |
错误信息 |
digitalWmAlgVersion |
int |
数字水印算法版本,支持1、2 |
detectedText |
string |
提取的文字信息,当status为SUCCESS时返回 |
媒资拉取完成回调事件内容
名称 |
类型 |
说明 |
taskId |
string |
任务ID |
status |
string |
运行状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
|
createTime |
string |
任务创建时间 |
finishTime |
string |
任务完成时间 |
fetchTaskInfo |
MediaFetchTaskInfo |
拉取任务信息 |
拉取任务信息
名称 |
类型 |
说明 |
errMsg |
string |
错误信息 |
url |
string |
拉取任务源文件地址。与拉取任务bucket/key二选一 |
bucket |
string |
拉取任务源文件bucket |
key |
string |
拉取任务源文件key |
coverUrl |
string |
拉取任务源文件封面图地址 |
highlightProjectId |
string |
拉取任务生成的媒资,需要导入的集锦项目ID |
mediaBasicInfo |
MediaBasicInfo |
媒资基本信息 |
presetTaskId |
string |
任务类型为模板处理的任务ID。若拉取上传时指定了媒资后续模版处理操作,当该模板处理时会生成一个新任务 |
workflowTaskId |
string |
任务类型为工作流处理的任务ID。若拉取上传时指定了媒资后续工作流处理操作,当该工作流处理时会生成一个新任务 |
媒资模板处理任务信息
媒资进行模板处理任务的输入参数
名称 |
类型 |
说明 |
presetIds |
string[] |
模版ID列表,支持转码、抽帧模板,使用模板处理时必填 |
watermarkIds |
string[] |
明水印模版ID列表,当presetIds是转码模板时,watermarkIds会在每一个转码处理中生效,使用模版处理时选填 |
digitalWatermark |
MediaTranscodeDigitalWatermark |
数字水印嵌入信息,使用模版处理时选填 |
媒资AI审核完成回调事件内容
名称 |
类型 |
说明 |
taskId |
string |
任务ID |
status |
string |
运行状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
|
createTime |
string |
任务创建时间 |
finishTime |
string |
任务完成时间 |
beginProcessTime |
string |
任务开始转码时间 |
regulationTaskInfo |
MediaRegulationTaskInfo |
AI审核任务信息 |
AI审核结果信息
审核结果中的subType表示”审核项”。每种审核类型下细分了不同审核项
审核场景 |
审核类型 |
审核项 |
审核项描述 |
涉黄审核 |
sexual_porn |
behavior, sm, products, children, art |
性行为及露点及招嫖, SM, 性用品及性玩具, 儿童, 艺术品色情 |
涉黄审核 |
sexual_sexy |
male, female |
男性衣着暴露, 女性衣着暴露 |
涉黄审核 |
sexual_intimacy |
intimacy |
亲密行为 |
涉黄审核 |
sexual_vulgar |
vulgar |
低俗行为 |
涉黄审核 |
sexual_special |
pregnant |
孕肚裸露 |
暴恐审核 |
terrorist_group |
terrorist_group |
恐怖组织 |
暴恐审核 |
terrorist |
terrorist |
暴恐人物 |
暴恐审核 |
terror_event |
blood, corpse, murder, explosion, riot, weapon, police, traffic |
血腥, 尸体, 绑架及杀人, 爆炸火灾, 暴乱, 军事武器, 警察部队, 车祸 |
涉政审核 |
politician |
politician_positive, politician_negative, bad_artist |
涉政正面人物, 涉政负面人物, 劣迹艺人 |
涉政审核 |
political_event |
political_event_positive, political_event_negative |
涉政正面事件, 涉政负面事件 |
涉政审核 |
political_group |
political_group_positive, political_group_negative |
涉政正面组织, 涉政负面组织 |
广告审核 |
ad_brand |
brand |
品牌标识 |
广告审核 |
ad_marketing |
qrcode, contact, website, commercial, watermark |
二维码, 联系方式, 网址, 软文推广, 水印 |
广告审核 |
ad_brand_negative |
brand_negative_comment |
品牌负面评论 |
违禁审核 |
bad_behavior |
smoke, drink, bad_behavior_gamble, drug |
吸烟, 喝酒, 赌博, 毒品 |
违禁审核 |
illegal_gamble |
gamble |
赌博 |
违禁审核 |
illegal_forgery |
forgery |
假冒伪劣及造假盗窃 |
违禁审核 |
illegal_trade |
trade |
非法交易 |
违禁审核 |
illegal_privacy |
privacy |
非法获取私人信息 |
质量审核 |
disgust |
disgust_image |
恶心图 |
官方文本黑库 |
official_text_black_lib |
baidu_illegal_textlib |
违禁词库 |
官方图片黑库 |
image_black_lib |
default_image_black_lib |
百度云风控 |
审核结果中的type表示”审核类型”。每类审核场景下包含着多种审核类型,不同审核类型支持的审核物料也不一样
审核场景 |
审核类型 |
描述 |
涉黄审核 |
sexual_porn |
色情审核 |
涉黄审核 |
sexual_sexy |
性感审核 |
涉黄审核 |
sexual_intimacy |
亲密行为审核 |
涉黄审核 |
sexual_vulgar |
低俗行为 |
涉黄审核 |
sexual_special |
特殊行为 |
暴恐审核 |
terrorist_group |
暴恐组织审核 |
暴恐审核 |
terrorist |
暴恐人物审核 |
暴恐审核 |
terror_event |
暴力事件审核 |
涉政审核 |
politician |
涉政人物审核 |
涉政审核 |
political_event |
涉政事件审核 |
涉政审核 |
political_group |
涉政组织审核 |
广告审核 |
ad_brand |
品牌广告审核 |
广告审核 |
ad_marketing |
欺诈及营销广告审核 |
广告审核 |
ad_brand_negative |
品牌负面评论审核 |
违禁审核 |
bad_behavior |
不良行为审核 |
违禁审核 |
illegal_gamble |
赌博审核 |
违禁审核 |
illegal_forgery |
假冒伪劣及造假盗窃审核 |
违禁审核 |
illegal_trade |
非法交易审核 |
违禁审核 |
illegal_privacy |
非法获取私人信息审核 |
质量审核 |
disgust |
恶心 |
AI审核类型结果
AI审核类型结果项
AI审核类型结果项证据
AI审核类型结果项证据位置信息
名称 |
类型 |
说明 |
leftOffsetInPixel |
int |
左偏移 |
topOffsetInPixel |
int |
上偏移 |
widthInPixel |
int |
宽度 |
heightInPixel |
int |
高度 |
AI审核任务信息
AI审核任务输入信息
名称 |
类型 |
说明 |
presetId |
string |
审核模板ID |
媒资源信息
名称 |
类型 |
说明 |
sourceType |
string |
媒资来源,支持:- UPLOAD:上传
- COMPOSE:云剪辑
- FETCH:拉取
- GENERATE:视频生成
|
sourceUrl |
string |
媒资源文件播放地址 |
coverUrl |
string |
媒资封面图地址 |
媒资源文件元信息
名称 |
类型 |
说明 |
etag |
string |
文件ETag,可用于校验文件是否被修改过 |
fileSizeInByte |
int |
文件大小,单位:字节 |
type |
string |
文件类型, |
container |
string |
音视频文件的容器类型 |
durationInSecond |
int |
音视频文件时长,单位:秒 |
durationInMillisecond |
int |
音视频文件时长,单位:毫秒 |
video |
MediaVideoCodec |
视频元信息 |
audio |
MediaAudioCodec |
音频元信息 |
blackBorderArea |
MediaBlackBorderArea |
视频黑边信息 |
字幕任务的ocr识别区域
名称 |
类型 |
说明 |
ocrRegionX |
int |
字幕区域左上角x坐标,相对于视频左上角的偏移量,单位:像素 |
ocrRegionY |
int |
字幕区域左上角y坐标,相对于视频左上角的偏移量,单位:像素 |
ocrRegionWidth |
int |
字幕区域宽度,单位:像素 |
ocrRegionHeight |
int |
字幕区域高度,单位:像素 |
字幕任务输出信息
名称 |
类型 |
说明 |
id |
string |
字幕任务ID(工作流节点ID) |
urls |
string[] |
字幕文件播放地址列表 |
formats |
string[] |
字幕文件格式列表,与urls顺序对应,类型支持: |
字幕任务信息
字幕任务输入信息
名称 |
类型 |
说明 |
startTimeInSecond |
int |
提取字幕开始时间 |
durationTimeInSecond |
int |
提取字幕时长 |
formats |
string[] |
字幕格式,支持: |
subtitleType |
string |
提取字幕类型,支持: |
ocrRegion |
MediaSubtitleOcrRegion |
文字识别区域,仅当字幕类型为AUTO时有效 |
任务基本信息
名称 |
类型 |
说明 |
taskId |
string |
任务ID |
mediaId |
string |
媒资ID |
type |
string |
任务类型,包括- WORKFLOW:工作流处理任务
- PRESET:模板处理任务
- COMPOSE:视频云剪辑任务
- FETCH:媒资拉取任务
- HIGHLIGHT_UNDERSTAND:精彩集锦视频理解任务
- DWM_DETECT:数字水印提取任务
- VIDEO_GENERATE:视频生成任务
|
status |
string |
任务状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
- FINISHED
其中FINISHED包含SUCCESS和FAILED两种可能,工作流和模版处理任务的终态均为FINISHED |
createTime |
string |
任务创建时间 |
finishTime |
string |
任务完成时间 |
任务详细信息
名称 |
类型 |
说明 |
taskId |
string |
任务ID |
type |
string |
任务类型,包括- WORKFLOW:工作流处理任务
- PRESET:模板处理任务
- COMPOSE:视频云剪辑任务
- FETCH:媒资拉取任务
- HIGHLIGHT_UNDERSTAND:精彩集锦视频理解任务
- DWM_DETECT:数字水印提取任务
|
status |
string |
任务状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
- FINISHED
其中FINISHED包含SUCCESS和FAILED两种可能,工作流和模版处理任务的终态均为FINISHED |
createTime |
string |
任务创建时间 |
finishTime |
string |
任务完成时间 |
mediaWorkflowTaskInfo |
MediaWorkflowTaskInfo |
工作流任务信息,仅当type为WORKFLOW时有效 |
mediaPresetTaskInfo |
MediaPresetTaskInfo |
模板任务信息,仅当type为PRESET时有效 |
composeTaskInfo |
ComposeTaskInfo |
视频云剪辑任务信息,仅当type为COMPOSE时有效 |
mediaFetchTaskInfo |
MediaFetchTaskInfo |
媒资拉取任务信息,仅当type为FETCH时有效 |
highlightUnderstandTaskInfo |
HighlightUnderstandTaskInfo |
精彩集锦视频理解任务信息,仅当type为HIGHLIGHT_UNDERSTAND时有效 |
mediaDwmDetectTaskInfo |
MediaDwmDetectTaskInfo |
数字水印提取任务信息,仅当type为DWM_DETECT时有效 |
videoGenerateTaskInfo |
VideoGenerateTaskInfo |
视频生成任务信息,仅当type为VIDEO_GENERATE时有效 |
媒资截图完成回调事件内容
名称 |
类型 |
说明 |
taskId |
string |
任务ID |
status |
string |
运行状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
|
createTime |
string |
任务创建时间 |
finishTime |
string |
任务完成时间 |
beginProcessTime |
string |
任务开始转码时间 |
thumbnailTaskInfo |
MediaThumbnailTaskInfo |
抽帧任务信息 |
抽帧任务结果信息
名称 |
类型 |
说明 |
id |
string |
抽帧模板ID |
urls |
string[] |
抽帧结果播放地址列表 |
抽帧任务信息
抽帧任务输入信息
名称 |
类型 |
说明 |
presetId |
string |
抽帧模板ID |
媒资转码完成回调事件内容
名称 |
类型 |
说明 |
taskId |
string |
任务ID |
status |
string |
运行状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
|
createTime |
string |
任务创建时间 |
finishTime |
string |
任务完成时间 |
beginProcessTime |
string |
任务开始转码时间 |
transcodeTaskInfo |
MediaTranscodeTaskInfo |
转码任务信息 |
转码嵌入数字水印的参数
名称 |
类型 |
说明 |
digitalWmTextContent |
string |
需嵌入的文字内容,长度<=100字符 |
digitalWmAlgVersion |
int |
算法版本号,支持1、2 |
digitalWmStrength |
float |
数字水印嵌入强度,对同一算法,强度越高则抗攻击能力越强,隐蔽性越差。范围 0 ~ 1,默认值 0.5 |
转码结果音频编码信息
名称 |
类型 |
说明 |
channels |
int |
音频文件的声道信息 |
sampleRateInHz |
int |
音频文件的采样率,单位:Hz |
转码结果信息
转码结果元信息
转码结果视频编码信息
名称 |
类型 |
说明 |
durationInSeconds |
int |
音视频文件时长,单位:秒 |
durationInMilliSeconds |
int |
音视频文件时长,单位:毫秒 |
sizeInKiloByte |
double |
音视频文件大小,单位:KB |
widthInPixel |
int |
视频宽度 |
heightInPixel |
int |
视频高度 |
frameRate |
int |
视频媒体的帧率 |
gopAlign |
bool |
是否开启gop对齐 |
mp4MoovSize |
int |
mp4文件moov块大小,单位:Byte |
转码任务信息
转码任务输入信息
名称 |
类型 |
说明 |
presetId |
string |
转码模板ID |
watermarkIds |
string[] |
明水印ID列表 |
媒资上传完成回调事件内容,结构与MediaBasicInfo一致
媒资视频编码信息
名称 |
类型 |
说明 |
codec |
string |
视频文件的编码规格 |
heightInPixel |
int |
视频高度 |
widthInPixel |
int |
视频宽度 |
bitRateInBps |
int |
视频媒体的码率 |
frameRate |
int |
视频媒体的帧率 |
rotate |
int |
旋转角度(部分视频包含该参数) |
dar |
string |
视频显示宽高比,如 "16:9" (部分视频包含该参数) |
工作流视频分析节点信息
工作流黑边检测节点信息
工作流发布节点信息
名称 |
类型 |
说明 |
nodeId |
string |
节点ID |
nodeName |
string |
节点名称 |
status |
string |
运行状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
|
errMsg |
string |
错误信息 |
工作流视频审核节点信息
工作流开始节点信息
名称 |
类型 |
说明 |
nodeId |
string |
节点ID |
nodeName |
string |
节点名称 |
status |
string |
运行状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
|
errMsg |
string |
错误信息 |
工作流字幕提取节点信息
工作流任务信息
媒资进行工作流处理任务的输入参数
名称 |
类型 |
说明 |
workflowId |
string |
工作流id |
工作流截图节点信息
工作流转码节点信息
TextToVideoK10TaskInput
文生视频 K10 任务输入参数
参数 |
类型 |
描述 |
prompt |
string |
提示词 |
negativePrompt |
string |
负面提示词 |
cfgScale |
float |
自由度,非必填,默认0.5,取值范围: [0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
duration |
int |
视频时长, 单位 s,支持: |
motionMode |
string |
生成模式,非必填,默认 std,支持: |
aspectRatio |
string |
比例,非必填,默认 16:9,支持 |
cameraControl |
VideoGenerateCameraControl |
控制摄像机运动的协议,非必填 |
TextToVideoK16TaskInput
文生视频 K16 任务输入参数
参数 |
类型 |
描述 |
prompt |
string |
提示词 |
negativePrompt |
string |
负面提示词 |
cfgScale |
float |
自由度,非必填,默认0.5,取值范围: [0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
duration |
int |
视频时长, 单位 s,支持: |
motionMode |
string |
生成模式,非必填,默认 std,支持: |
aspectRatio |
string |
比例,非必填,默认 16:9,支持 |
cameraControl |
VideoGenerateCameraControl |
控制摄像机运动的协议,非必填 |
TextToVideoP35TaskInput
文生视频 P35 任务输入参数
参数 |
类型 |
描述 |
prompt |
string |
提示词 |
negativePrompt |
string |
负面提示词 |
duration |
int |
视频时长, 单位 s,支持: |
resolution |
string |
视频质量,支持: |
motionMode |
string |
生成模式,非必填,默认 normal,支持: (normal, fast, --fast only available when duration=5; --resolution=1080p does not support fast) |
style |
string |
风格,非必填,支持: - anime
- 3d_animation
- clay
- comic
- cyberpunk
|
seed |
integer |
随机种子,非必填 |
TextToVideoRequest
文生视频任务输入参数
TextToVideoV10TaskInput
文生视频 V10 任务输入参数
参数 |
类型 |
描述 |
duration |
integer |
视频时长, 单位 s,支持: |
prompt |
string |
生成的提示文本 |
seed |
integer |
随机种子,非必填 |
style |
string |
风格, 非必填,默认 general,支持: |
TextToVideoV15TaskInput
文生视频 V15 任务输入参数
参数 |
类型 |
描述 |
prompt |
string |
生成的提示文本 |
duration |
integer |
视频时长, 单位 s,支持: |
resolution |
string |
分辨率, 支持: |
style |
string |
风格, 非必填,默认 general,支持: |
movementAmplitude |
string |
运动幅度, 非必填,默认auto, 支持: |
seed |
integer |
随机种子,非必填 |
aspectRatio |
string |
比例,非必填,默认16:9 , 支持: |
VideoExtendRequest
视频延长任务输入参数
VideoGenerateCameraControl
控制摄像机运动的协议(如未指定,模型将根据输入的文本/图片进行智能匹配)
参数 |
类型 |
描述 |
type |
string |
预定义的运镜类型 - 枚举值:"simple", "down_back", "forward_up", "right_turn_forward", "left_turn_forward"
- simple:简单运镜,此类型下可在"config"中六选一进行运镜
- down_back:镜头下压并后退右下移拉远,此类型下config参数无需填写
- forward_up:镜头前进并上仰右推进上移,此类型下config参数无需填写
- right_turn_forward:先右旋转后前进右 右旋推进,此类型下config参数无需填写
- left_turn_forward:先左旋并前进右 左旋推进,此类型下config参数无需填写
|
config |
VideoGenerateCameraControlConfig |
图片信息, 图生必填 |
VideoGenerateCameraControlConfig
包含六个字段,用于指定摄像机在不同方向上的运动或变化
- 当运镜类型指定simple时必填,指定其他类型时不填
- 以下参数6选1,即指定一个即可
参数 |
类型 |
描述 |
horizontal |
float |
水平运镜,控制摄像机在水平方向上的移动量(沿x轴平移)- 取值范围:[-10, 10],负值表示向左平移,正值表示向右平移
|
vertical |
float |
垂直运镜,控制摄像机在垂直方向上的移动量(沿y轴平移)- 取值范围:[-10, 10],负值表示向下平移,正值表示向上平移
|
pan |
float |
水平摇镜,控制摄像机在水平面上的旋转量(绕y轴旋转)- 取值范围:[-10, 10],负值表示绕y轴向左旋转,正值表示绕y轴向右旋转
|
tilt |
float |
垂直摇镜,控制摄像机在垂直面上的旋转量(沿x轴旋转)- 取值范围:[-10, 10],负值表示绕x轴向下旋转,正值表示绕x轴向上旋转
|
roll |
float |
旋转运镜,控制摄像机的滚动量(绕z轴旋转)- 取值范围:[-10, 10],负值表示绕z轴逆时针旋转,正值表示绕z轴顺时针旋转
|
zoom |
float |
变焦,控制摄像机的焦距变化,影响视野的远近 - 取值范围:[-10, 10],负值表示焦距变长、视野范围变小,正值表示焦距变短、视野范围变大
|
VideoGenerateCompleteEvent
视频生成完成回调事件内容
名称 |
类型 |
说明 |
taskId |
string |
任务ID |
status |
string |
运行状态,包括- READY
- RUNNING
- SUCCESS
- FAILED
|
createTime |
string |
任务创建时间 |
finishTime |
string |
任务完成时间 |
videoGenerateCompleteEvent |
VideoGenerateTaskInfo |
视频生成任务输入参数 |
VideoGenerateTaskInfo
视频生成任务信息
视频生成任务输入参数
名称 |
类型 |
说明 |
type |
string |
任务请求类型,包括: - 参考生视频
- 文生视频
- 图生视频
- 视频延长
- 拥抱
- 亲吻
- 圣诞特效
- 变形特效
- 实况照片
- 情绪特效
- 复活老照片
- AI换发
- 双人互动
- 春节特效
- 童年回忆
- 古风换装
- 全家福比心
- 财神特效
- 梦幻婚礼
- 浪漫公主抱
- 甜蜜求婚
- 情侣降临
- 丘比特之箭
- 萌宠恋人
- 变身美队
- 绿巨人
- 美队同行
- 浩克俯冲
- 我们是毒液
- 温暖耶稣
- 拥抱爱人
- 肌肉激增
- 虎之触
- 亲亲
- 长腿奔跑
- 活灵活现的艺术
- 挤压它
- 绿巨人
- 黑神话悟空
- 美少女战士
- 羊毛卷
- 长发魔法
- 疯狂猫女
- 神奇女侠
- 小丑重生
- 蝙蝠侠
- 多彩毒液
- 钢铁侠
- 春节服装
- 财神
- 火辣哈莉奎因
- 谁是毒液
- 获得毒液伙伴
- 邪恶镜头
- 乐高爆炸
- 怪物入侵
- 巫师帽子
- 僵尸模式
- 僵尸手
|
imageToVideoRequest |
ImageToVideoRequest |
图生视频任务输入参数 |
textToVideoRequest |
TextToVideoRequest |
文生视频任务输入参数 |
effectVideoRequest |
EffectVideoRequest |
特效视频任务输入参数 |
videoExtendRequest |
VideoExtendRequest |
视频延长任务输入参数 |
VideoGenerateTaskOutput
视频生成任务输出参数
![]()