数据结构
AIGCAudioConfig
视频信息, 传参 videoUrl 和 mediaId 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| audioItem | LipSyncAudioItem | 音频信息 |
AIGCVideoItem
视频信息, 传参 videoUrl, mediaId 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| videoUrl | string | 视频链接 |
| mediaId | string | 媒资 ID |
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
事件回调消息
| 名称 | 类型 | 说明 |
|---|---|---|
| eventId | string | 事件 ID |
| eventType | string | 事件类型 |
| eventTime | string | 事件时间戳 |
| mediaUploadCompleteEvent | MediaUploadCompleteEvent | 媒资上传完成回调事件内容 |
| mediaFetchCompleteEvent | MediaFetchCompleteEvent | 媒资拉取完成回调事件内容 |
| mediaTranscodeCompleteEvent | MediaTranscodeCompleteEvent | 媒资转码完成回调事件内容 |
| mediaThumbnailCompleteEvent | MediaThumbnailCompleteEvent | 媒资截图完成回调事件内容 |
| mediaAnalysisCompleteEvent | MediaAnalysisCompleteEvent | 媒资分析完成回调事件内容 |
| mediaRegulationCompleteEvent | MediaRegulationCompleteEvent | 媒资审核完成回调事件内容 |
| composeTaskStatusChangeEvent | ComposeTaskStatusChangeEvent | 视频云剪辑任务状态变更回调事件内容 |
| videoGenerateCompleteEvent | VideoGenerateCompleteEvent | 视频生成完成回调事件内容 |
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
视频云剪辑任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| errMsg | string | 错误信息 |
| output | ComposeTaskOutput | 视频云剪辑任务输出参数 |
ComposeTaskOutput
视频云剪辑任务输出信息
| 名称 | 类型 | 说明 |
|---|---|---|
| mediaId | string | 视频云剪辑视频导入媒资库的媒资 ID |
| url | string | 视频云剪辑视频播放地址 |
ComposeTaskStatusChangeEvent
视频云剪辑任务状态变更回调事件内容
| 名称 | 类型 | 说明 |
|---|---|---|
| taskId | string | 任务 ID |
| status | string | 运行状态,包括
|
| createTime | string | 任务创建时间,例如 2024-10-11T13:48:01Z |
| finishTime | string | 任务完成时间 |
| beginProcessTime | string | 任务开始时间 |
| composeTaskInfo | ComposeTaskInfo | 视频云剪辑任务信息 |
ComposeTimeline
| 字段 | 类型 | 必要性 | 轨道数范围 | 素材结点总数范围 | 说明 |
|---|---|---|---|---|---|
| audioTracks | ComposeTimelineAudioTrack[] | [0,10] | [0,1000] | 音频多轨道 | |
| videoTracks | ComposeTimelineVideoTrack[] | 是 | [1,10] | [1,1000] | 视频多轨道(包括视频、图片) |
| subtitleTracks | ComposeTimelineSubtitleTrack[] | [0,10] | [0,1000] | 字幕多轨道 |
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
| 字段 | 类型 | 必要性 | 说明 |
|---|---|---|---|
| audioItems | ComposeTimelineAudioItem[] | 是 | 素材结点列表(音频文件) |
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 | |
| position | string(枚举) | custom | 字幕位置设置方式: - custom绝对定位,严格按xpos,ypos坐标放置;- relative相对定位,采用marginL,marginR,marginV定位,如遇多个字幕位置重叠将会自动排版避开重叠 |
|
| 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。注意,若position=relative,则不可选center |
|
| marginL | int | postion=relative时,代表屏幕左边缘到字幕的留空 | ||
| marginR | int | postion=relative时,代表屏幕右边缘到字幕的留空 | ||
| marginV | int | postion=relative时,若textAlign=bottomLeft,bottomCenter,bottomRight则代表屏幕底部到字幕的留空;若textAlign=topLeft,topCenter,topRight则代表屏幕顶部到字幕的留空;textAlign=其它值无效 | ||
| 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
| 字段 | 类型 | 必要性 | 说明 |
|---|---|---|---|
| subtitleItems | ComposeTimelineSubtitleItem[] | 是 | 素材结点列表 |
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
| 字段 | 类型 | 必要性 | 说明 |
|---|---|---|---|
| videoItems | ComposeTimelineVideoItem[] | 是 | 素材结点列表(视频文件或图片) |
EffectBeastCompanionInput
与兽为伍 特效特定输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| beast | string | 伴侣类型,非必填,默认:auto,包括:
|
EffectCoveredLiquidMetalInput
液态金属熔化 特效特定输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| metallicColor | string | 颜色,非必填,默认:random,包括:
|
EffectExoticPrincessInput
异域公主 特效特定输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| area | string | 伴侣类型,非必填,默认:auto,包括:
|
EffectHairSwapInput
AI 换发特效特定输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| hairColor | string | 头发颜色,非必填,默认:Original Hair Color,包括:
|
EffectLaduduMeInput
Ladudu 大变身 特效特定输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| color | string | 颜色,非必填,默认:brown,包括:
|
EffectRelaxCutInput
治愈切切 特效特定输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| object | string | 切割对象,如 橘子 |
EffectVideoLTaskInput
特效视频 L 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| effect | string | 特效类型,包括:
|
| image | ImageToVideoImageItem | 图片信息 |
| prompt | string | 提示词,不超过2000字符, 必填 |
EffectVideoPTaskInput
特效视频 P 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| effect | string | 特效类型,包括:
|
| image | ImageToVideoImageItem | 图片信息 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词,非比填 |
| duration | int | 视频时长,单位 s,支持:
|
| resolution | string | 视频分辨率,支持:
|
| motionMode | string | 生成模式,非必填,默认 normal,支持:
|
| style | string | 风格,非必填,支持:
|
| seed | integer | 随机种子,非必填 |
| soundEffectSwitch | boolean | 是否开启背景音乐,非必填,默认 false |
| soundEffectContent | string | 背景音乐类型,非必填,默认自动匹配,支持字符串传入,如 鸟鸣 |
EffectVideoRequest
特效视频任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| model | string | 模型名称,包括:
|
| modelVTaskInput | EffectVideoVTaskInput | 特效任务 V 特定输入参数,非必填 |
| modelPTaskInput | EffectVideoPTaskInput | 特效任务 P 特定输入参数 , 非必填 |
| modelLTaskInput | EffectVideoLTaskInput | 特效任务 L 特定输入参数 , 非必填 |
EffectVideoVTaskInput
特效视频 V 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| effect | string | 特效类型,包括:
|
| images | ImageToVideoImageItem[] | 图片信息 |
| hairSwapInput | EffectHairSwapInput | AI 换发特效特定输入参数,非必填 |
| beastCompanionInput | EffectBeastCompanionInput | 与兽为伍 特效特定输入参数,非必填 |
| exoticPrincessInput | EffectExoticPrincessInput | 异域公主 特效特定输入参数,非必填 |
| relaxCutInput | EffectRelaxCutInput | 治愈切切 特效特定输入参数,非必填 |
| coveredLiquidMetalInput | EffectCoveredLiquidMetalInput | 液态金属熔化 特效特定输入参数,非必填 |
| laduduMeInput | EffectLaduduMeInput | Ladudu 大变身 特效特定输入参数,非必填 |
| aspectRatio | string | 比例,非必填,默认 9:16,部分特效支持
|
| bgm | boolean | 是否开启背景音乐,非必填,默认 false |
ExtendVideoKTaskInput
视频延长 K 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| videoItem | MediaVideoItem | 视频信息 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| cfgScale | float | 自由度,非必填,默认 0.5,取值范围:[0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
ExtendVideoPTaskInput
视频延长 P35、P40、P45、P50 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| videoItem | AIGCVideoItem | 视频信息 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词,非必填 |
| duration | int | 视频时长,单位 s,支持:
|
| resolution | string | 视频分辨率,支持:
|
| motionMode | string | 生成模式,非必填,默认 normal,支持:
|
| style | string | 风格,非必填,支持:
|
| seed | integer | 随机种子,非必填 |
ImageToImageLTaskInput
图生图 L 任务输入参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| model | string | 生成模式,默认 max, 支持:
|
| images | ImageToVideoImageItem[] | 参考图,图片数量支持 1~4 |
| prompt | string | 生成的提示文本,不超过2000字符, 必填 |
| aspectRatio | String | 图片宽高比,默认 1:1,支持:
|
| guidanceScale | string | 提示词引导系数,默认 3.5,支持:1.0~20.0 |
| imgCount | integer | 单次生图张数,默认 1,支持:1~4 |
ImageToImageVTaskInput
图生图 V 任务输入参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| model | string | 模型名称, 支持:
|
| images | ImageToVideoImageItem[] | 参考图,图片数量支持 1~7 |
| prompt | string | 生成的提示文本,不超过2000字符, 必填 |
| aspectRatio | string | 图片宽高比,默认 1:1,支持:
|
| guidanceScale | string | 提示词引导系数,默认 3.5,支持:1.0~20.0 |
| imgCount | integer | 单次生图张数,默认 1,支持:1~4 |
| payload | string | 透传参数 |
ImageToImageRequest
图生图任务输入参数
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| model | string | 是 | 模型名称, 支持:
|
| modelLTaskInput | ImageToImageLTaskInput | 否 | L 模型的特定输入参数 |
| modelVTaskInput | ImageToImageVTaskInput | 否 | V 模型的特定输入参数 |
ImageToVideoDynamicMask
动态笔刷配置列表 可配置多组(最多 6 组),每组包含“涂抹区域 mask”与“运动轨迹 trajectories”序列
| 参数 | 类型 | 描述 |
|---|---|---|
| mask | ImageToVideoHeadtailImages | 动态笔刷涂抹区域(用户通过运动笔刷涂抹的 mask 图片) |
| trajectories | ImageToVideoTrajectory[] | 运动轨迹坐标序列
|
ImageToVideoHeadtailImages
首尾帧图片信息
| 参数 | 类型 | 描述 |
|---|---|---|
| headImage | ImageToVideoImageItem | 首帧图片信息 |
| tailImage | ImageToVideoImageItem | 尾帧图片信息 |
ImageToVideoImageItem
图片信息
| 参数 | 类型 | 描述 |
|---|---|---|
| imageUrl | string | 图片链接 |
PCharacterToVideoImageItem
P 模型参考生图片信息
| 参数 | 类型 | 描述 |
|---|---|---|
| imageUrl | string | 图片链接 |
| type | string | 必须是"subject"(主体), "background" (背景)之一 |
| refName | string | 主体/背景名称,参考生提示词中可以用{}框住,例子:{person1} talking to {person2} |
ImageToVideoK10TaskInput
图生视频 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 图片)
|
| dynamicMasks | ImageToVideoDynamicMask[] | 动态笔刷配置列表,非必填,默认 std,支持:
|
ImageToVideoK15TaskInput
图生视频 K15 任务输入参数,传参 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 图片)
|
| dynamicMasks | ImageToVideoDynamicMask[] | 动态笔刷配置列表,非必填,默认 std,支持:
|
| cameraControl | VideoGenerateCameraControl[] | 动态笔刷配置列表,非必填,默认 std,支持:
|
ImageToVideoK16TaskInput
图生视频 K16 任务输入参数,传参 headtailImages,image, characterImages 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| headtailImages | ImageToVideoHeadtailImages | 首尾帧图片信息, 首尾生必填 |
| image | ImageToVideoImageItem | 图片信息, 图生必填 |
| characterImages | ImageToVideoImageItem[] | 参考图片信息, 参考生必填 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| cfgScale | float | 自由度,非必填,默认 0.5,取值范围:[0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
| duration | int | 视频时长,单位 s,支持:
|
| motionMode | string | 生成模式,非必填,默认 std,支持:
|
| aspectRatio | string | 比例,仅参考生支持,非必填,默认 16:9 , 支持:
|
ImageToVideoK20TaskInput
图生视频 K20 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| image | ImageToVideoImageItem | 图片信息, 图生必填 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| cfgScale | float | 自由度,非必填,默认 0.5,取值范围:[0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
| duration | int | 视频时长,单位 s,支持:
|
ImageToVideoK21MTaskInput
图生视频 K21M 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| image | ImageToVideoImageItem | 图片信息, 图生必填 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| cfgScale | float | 自由度,非必填,默认 0.5,取值范围:[0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
| duration | int | 视频时长,单位 s,支持:
|
ImageToVideoK21TaskInput
图生视频 K21 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| image | ImageToVideoImageItem | 图片信息, 图生必填 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| cfgScale | float | 自由度,非必填,默认 0.5,取值范围:[0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
| duration | int | 视频时长,单位 s,支持:
|
ImageToVideoK25TTaskInput
图生视频 K25T 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| image | ImageToVideoImageItem | 图片信息, 图生必填 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| cfgScale | float | 自由度,非必填,默认 0.5,取值范围:[0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
| duration | int | 视频时长,单位 s,支持:
|
| mode | string | 模式,支持:
|
ImageToVideoP35TaskInput
图生视频 P35 任务输入参数,传参 headtailImages,image 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| image | ImageToVideoImageItem | 图片信息 |
| headtailImages | ImageToVideoHeadtailImages | 首尾帧图片信息, 首尾生必填 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词,非必填 |
| duration | int | 视频时长,单位 s,支持:
|
| resolution | string | 视频分辨率,支持:
|
| motionMode | string | 生成模式,非必填,默认 normal,支持:
|
| style | string | 风格,非必填,支持:
|
| seed | integer | 随机种子,非必填 |
| soundEffectSwitch | boolean | 是否开启背景音乐,非必填,默认 false |
| soundEffectContent | string | 背景音乐类型,非必填,默认自动匹配,支持字符串传入,如 鸟鸣 |
ImageToVideoP40TaskInput
图生视频 P40 任务输入参数,传参 headtailImages,image 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| image | ImageToVideoImageItem | 图片信息 |
| headtailImages | ImageToVideoHeadtailImages | 首尾帧图片信息, 首尾生必填 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词,非必填 |
| duration | int | 视频时长,单位 s,支持:
|
| resolution | string | 视频分辨率,支持:
|
| motionMode | string | 生成模式,非必填,默认 normal,支持:
|
| style | string | 风格,非必填,支持:
|
| seed | integer | 随机种子,非必填 |
| soundEffectSwitch | boolean | 是否开启背景音乐,非必填,默认 false |
| soundEffectContent | string | 背景音乐类型,非必填,默认自动匹配,支持字符串传入,如 鸟鸣 |
| cameraMovement | string | 运镜参数,非必填,支持
|
ImageToVideoP45TaskInput
图生视频 P45 任务输入参数,传参 headtailImages,image,characterImages 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| image | ImageToVideoImageItem | 图片信息 |
| headtailImages | ImageToVideoHeadtailImages | 首尾帧图片信息, 首尾生必填 |
| characterImages | PCharacterToVideoImageItem[] | 参考图片信息, 参考生必填 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词,非必填 |
| duration | int | 视频时长,单位 s,支持:
|
| resolution | string | 视频分辨率,支持:
|
| motionMode | string | 生成模式,非必填,默认 normal,支持:
|
| style | string | 风格,非必填,支持:
|
| seed | integer | 随机种子,非必填 |
| soundEffectSwitch | boolean | 是否开启背景音乐,非必填,默认 false |
| soundEffectContent | string | 背景音乐类型,非必填,默认自动匹配,支持字符串传入,如 鸟鸣 |
| cameraMovement | string | 运镜参数,非必填,支持
|
ImageToVideoP50TaskInput
图生视频 P50 任务输入参数,传参 headtailImages,image 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| image | ImageToVideoImageItem | 图片信息 |
| headtailImages | ImageToVideoHeadtailImages | 首尾帧图片信息, 首尾生必填 |
| characterImages | PCharacterToVideoImageItem[] | 参考图片信息, 参考生必填 |
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词,非必填 |
| duration | int | 视频时长,单位 s,支持:
|
| resolution | string | 视频分辨率,支持:
|
| motionMode | string | 生成模式,非必填,默认 normal,支持:
|
| style | string | 风格,非必填,支持:
|
| seed | integer | 随机种子,非必填 |
| soundEffectSwitch | boolean | 是否开启背景音乐,非必填,默认 false |
| soundEffectContent | string | 背景音乐类型,非必填,默认自动匹配,支持字符串传入,如 鸟鸣 |
ImageToVideoRequest
图生视频任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| model | string | 模型名称,包括:
|
| modelV15TaskInput | ImageToVideoV15TaskInput | V15 模型的特定输入参数 |
| modelV20TaskInput | ImageToVideoV20TaskInput | V20 模型的特定输入参数 |
| modelVQ1TaskInput | ImageToVideoVQ1TaskInput | VQ1 模型的特定输入参数 |
| modelVQ1CTaskInput | ImageToVideoVQ1CTaskInput | VQ1C 模型的特定输入参数 |
| modelP35TaskInput | ImageToVideoP35TaskInput | P35 模型的特定输入参数 |
| modelP40TaskInput | ImageToVideoP40TaskInput | P40 模型的特定输入参数 |
| modelP45TaskInput | ImageToVideoP45TaskInput | P45 模型的特定输入参数 |
| modelP50TaskInput | ImageToVideoP50TaskInput | P50 模型的特定输入参数 |
| modelK16TaskInput | ImageToVideoK16TaskInput | K16 模型的特定输入参数 |
| modelK20TaskInput | ImageToVideoK20TaskInput | K20 模型的特定输入参数 |
| modelK21TaskInput | ImageToVideoK21TaskInput | K21 模型的特定输入参数 |
| modelK21MTaskInput | ImageToVideoK21MTaskInput | K21M 模型的特定输入参数 |
| modelK25TTaskInput | ImageToVideoK25TTaskInput | K25T 模型的特定输入参数 |
ImageToVideoTrajectory
运动轨迹坐标序列
- 生成 5s 的视频,轨迹长度不超过 77,即坐标个数取值范围:[2, 77]
- 轨迹坐标系,以图片左下角为坐标原点
- 坐标点个数越多轨迹刻画越准确,如只有 2 个轨迹点则为这两点连接的直线
- 轨迹方向以传入顺序为指向,以最先传入的坐标为轨迹起点,依次链接后续坐标形成运动轨迹
| 参数 | 类型 | 描述 |
|---|---|---|
| x | integer | 轨迹点横坐标(在像素二维坐标系下,以输入图片 image 左下为原点的像素坐标) |
| y | integer | 轨迹点纵坐标(在像素二维坐标系下,以输入图片 image 左下为原点的像素坐标) |
ImageToVideoV15TaskInput
图生视频 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, 支持:
|
| bgm | boolean | 是否开启背景音乐,非必填,默认 false |
ImageToVideoV20TaskInput
图生视频 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, 支持:
|
| bgm | boolean | 是否开启背景音乐,非必填,默认 false |
ImageToVideoVQ1CTaskInput
图生视频 VQ1C 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| headtailImages | ImageToVideoHeadtailImages | 首尾帧图片信息, 首尾生必填 |
| prompt | string | 生成的提示文本 |
| duration | integer | 视频时长,单位 s,支持:
|
| resolution | string | 分辨率,支持:
|
| seed | integer | 随机种子,非必填 |
| aspectRatio | string | 比例,非必填,默认 16:9 , 支持:
|
| movementAmplitude | string | 运动幅度,非必填,默认 auto, 支持:
|
ImageToVideoVQ1TaskInput
图生视频 VQ1 任务输入参数,传参 headtailImages,image、characterImages 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| headtailImages | ImageToVideoHeadtailImages | 首尾帧图片信息, 首尾生必填 |
| image | ImageToVideoImageItem | 图片信息, 图生必填 |
| characterImages | ImageToVideoImageItem[] | 参考图片信息,最大支持七张图片,参考生必填 |
| prompt | string | 生成的提示文本 |
| duration | integer | 视频时长,单位 s,支持:
|
| resolution | string | 分辨率,支持:
|
| seed | integer | 随机种子,非必填 |
| aspectRatio | string | 比例,非必填,默认 16:9 , 支持:
|
| movementAmplitude | string | 运动幅度,非必填,默认 auto, 支持:
|
| bgm | boolean | 是否开启背景音乐,非必填,默认 false |
ImageToVideoVQ2TTaskInput
图生视频 VQ2T 任务输入参数,传参 headtailImages,image 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| headtailImages | ImageToVideoHeadtailImages | 首尾帧图片信息, 首尾生必填 |
| image | ImageToVideoImageItem | 图片信息, 图生必填 |
| prompt | string | 生成的提示文本 |
| duration | integer | 视频时长,单位 s,支持:
|
| resolution | string | 分辨率,支持:
|
| seed | integer | 随机种子,非必填 |
| movementAmplitude | string | 运动幅度,非必填,默认 auto, 支持:
|
| bgm | boolean | 是否开启背景音乐,非必填,默认 false |
ImageToVideoVQ2PTaskInput
图生视频 VQ2P 任务输入参数,传参 headtailImages,image 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| headtailImages | ImageToVideoHeadtailImages | 首尾帧图片信息, 首尾生必填 |
| image | ImageToVideoImageItem | 图片信息, 图生必填 |
| prompt | string | 生成的提示文本 |
| duration | integer | 视频时长,单位 s,支持:
|
| resolution | string | 分辨率,支持:
|
| seed | integer | 随机种子,非必填 |
| movementAmplitude | string | 运动幅度,非必填,默认 auto, 支持:
|
| bgm | boolean | 是否开启背景音乐,非必填,默认 false |
ImageToVideoVQ2TaskInput
图生视频 VQ2 任务输入参数,传参 headtailImages,image 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| characterImages | ImageToVideoImageItem[] | 参考图片信息,最大支持七张图片,参考生必填 |
| prompt | string | 生成的提示文本 |
| duration | integer | 视频时长,单位 s,支持:
|
| resolution | string | 分辨率,支持:
|
| seed | integer | 随机种子,非必填 |
| movementAmplitude | string | 运动幅度,非必填,默认 auto, 支持:
|
| bgm | boolean | 是否开启背景音乐,非必填,默认 false |
LipSyncAudioItem
音频信息,传参 audioUrl, audioFile 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| audioUrl | string | 视频链接 |
| audioFile | string | 视频文件,Base64 编码 |
LipSyncKRequest
对口型 K 任务输入参数, textConfig,audioConfig 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| videoItem | AIGCVideoItem | 视频信息 |
| textConfig | LipSyncKTextConfig | 文本生成对口型视频配置 |
| audioConfig | AIGCAudioConfig | 音频文件生成对口型视频配置 |
LipSyncKTextConfig
K 模型对口型文本输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| text | string | 生成对口型视频的文本内容,最大长度 120 |
| voiceId | string | 音色 ID |
| voiceLanguage | string | 音色语种,与音色 id 对应 |
| voiceSpeed | string | 语速,有效范围:0.8~2.0 |
LipSyncPRequest
对口型 P 任务输入参数, textConfig,audioConfig 有且仅需有一个
| 参数 | 类型 | 描述 |
|---|---|---|
| videoItem | AIGCVideoItem | 视频信息 |
| textConfig | LipSyncPTextConfig | 文本生成对口型视频配置 |
| audioConfig | AIGCAudioConfig | 音频文件生成对口型视频配置 |
LipSyncPTextConfig
P 模型对口型文本输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| text | string | 生成对口型视频的文本内容,最大支持约 200 字符 |
| voiceId | string | 音色 ID,支持:
|
LipSyncRequest
对口型视频任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| model | string | 模型名称,支持:
|
| modelKTaskInput | LipSyncKRequest | K 模型的特定输入参数 |
| modelPTaskInput | LipSyncPRequest | P 模型的特定输入参数 |
MediaAnalysisCompleteEvent
媒资 AI 分析完成回调事件内容
| 名称 | 类型 | 说明 |
|---|---|---|
| taskId | string | 任务 ID |
| status | string | 运行状态,包括
|
| createTime | string | 任务创建时间 |
| finishTime | string | 任务完成时间 |
| beginProcessTime | string | 任务开始时间 |
| analysisTaskInfo | MediaAnalysisTaskInfo | 拉取任务信息 |
MediaAnalysisOutputInfo
媒资 AI 分析结果信息
| 名称 | 类型 | 说明 |
|---|---|---|
| id | string | AI 分析模板 ID |
| results | MediaAnalysisOutputTypeResult[] | 分析场景列表 |
MediaAnalysisOutputTypeEnum
媒资 AI 分析结果的场景类型枚举
| 分析场景 | 描述 |
|---|---|
| figure | 人脸 |
| keyword | 关键字 |
| scenario | 场景 |
| entity | 实体 |
| logo | logo |
| knowledge_graph | 知识图谱 |
MediaAnalysisOutputTypeResult
媒资 AI 分析结果场景列表。AI 分析结果一般有多个场景分类,这是一个场景结果的数据结构
| 名称 | 类型 | 说明 |
|---|---|---|
| type | string(MediaAnalysisOutputTypeEnum) | 分析场景,枚举 |
| result | MediaAnalysisOutputTypeResultItem[] | 分析结果项 |
MediaAnalysisOutputTypeResultItem
媒资 AI 分析结果分类中的某一个类型的结果。
| 名称 | 类型 | 说明 |
|---|---|---|
| attribute | string | 分析结果标签 |
| source | string | 标签来源 |
MediaAnalysisTaskInfo
媒资 AI 分析任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| mediaId | string | 媒资 ID |
| errMsg | string | 错误信息 |
| analysisInput | MediaAnalysisTaskInput | 分析任务输入参数 |
| analysisOutput | MediaAnalysisOutputInfo | 分析任务输出参数 |
MediaAnalysisTaskInput
媒资 AI 分析任务输入参数
| 名称 | 类型 | 说明 |
|---|---|---|
| presetId | string | AI 分析模板 ID |
MediaAudioCodec
媒资音频编码信息
| 名称 | 类型 | 说明 |
|---|---|---|
| codec | string | 音频编码规格 |
| channels | int | 音频文件的声道信息 |
| sampleRateInHz | int | 音频文件的采样率,单位:Hz |
| bitRateInBps | int | 音频文件的码率,单位:bps |
MediaBasicInfo
媒资基本信息
| 名称 | 类型 | 说明 |
|---|---|---|
| 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 | 媒资源文件元信息 |
MediaBlackBorderArea
媒资视频黑边信息
| 名称 | 类型 | 说明 |
|---|---|---|
| x | int | 去黑边后的视频左偏移位置,单位:像素 |
| y | int | 去黑边后的视频上偏移位置,单位:像素 |
| width | int | 去黑边后的视频宽度,单位:像素 |
| height | int | 去黑白后的视频高度,单位:像素 |
MediaBlackBorderDetectOutputInfo
媒资视频黑边检测输出信息
| 名称 | 类型 | 说明 |
|---|---|---|
| borderArea | MediaBlackBorderArea | 去黑边区域信息 |
| meta | MediaBlackBorderVideoMetaInfo | 视频信息 |
MediaBlackBorderDetectTaskInfo
媒资视频黑边检测任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| mediaId | string | 媒资 ID |
| status | string | 运行状态,包括
|
| errMsg | string | 错误信息 |
| blackBorderOutput | MediaBlackBorderDetectOutputInfo | 黑边检测输出信息 |
MediaBlackBorderDetectTaskInput
媒资视频黑边检测任务的输入参数
| 名称 | 类型 | 说明 |
|---|---|---|
| presetId | string | 转码模板 ID,使用去黑边时必填 |
MediaBlackBorderVideoMetaInfo
黑边视频信息
| 名称 | 类型 | 说明 |
|---|---|---|
| width | int | 视频宽度,单位:像素 |
| height | int | 视频高度,单位:像素 |
| rotate | int | 视频旋转角度,单位:度 |
MediaComposeNodeTaskInfo
视频合成任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| jobId | string | 节点任务 ID |
| mediaId | string | 媒资 ID |
| status | string | 任务状态 |
| composeOutput | MediaComposeOutput | 视频合成任务输出信息 |
MediaComposeNodeTaskInfos
工作流视频合成任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| ComposeNodeTaskInfos | MediaComposeNodeTaskInfo | 视频合成任务信息 |
MediaComposeOutput
视频翻译任务输出信息
| 名称 | 类型 | 说明 |
|---|---|---|
| targetLanguage | string | 目标翻译语言 |
| url | string | 合成结果链接 |
MediaDetail
媒资详细信息,继承自 MediaBasicInfo,还包含以下参数
| 名称 | 类型 | 说明 |
|---|---|---|
| transcodeOutputs | MediaTranscodeOutputInfo[] | 转码输出信息 |
| thumbnailOutputs | MediaThumbnailOutputInfo[] | 抽帧输出信息 |
| subtitleOutputs | MediaSubtitleOutputInfo[] | 字幕输出信息 |
| analysisOutputs | MediaAnalysisOutputInfo[] | AI 分析输出信息 |
| regulationOutputs | MediaRegulationOutputInfo[] | AI 审核输出信息 |
MediaDwmDetectTaskInfo
视频数字水印提取任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| mediaId | string | 媒资 ID |
| transcodeOutputId | string | 转码输出 ID,即转码模板 ID,用于指定媒资的某个转码输出视频 |
| status | string | 运行状态,包括
|
| errMsg | string | 错误信息 |
| digitalWmAlgVersion | int | 数字水印算法版本,支持 1、2 |
| detectedText | string | 提取的文字信息,当 status 为 SUCCESS 时返回 |
MediaFetchCompleteEvent
媒资拉取完成回调事件内容
| 名称 | 类型 | 说明 |
|---|---|---|
| taskId | string | 任务 ID |
| status | string | 运行状态,包括
|
| createTime | string | 任务创建时间 |
| finishTime | string | 任务完成时间 |
| fetchTaskInfo | MediaFetchTaskInfo | 拉取任务信息 |
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。若拉取上传时指定了媒资后续工作流处理操作,当该工作流处理时会生成一个新任务 |
MediaPresetTaskInfo
媒资模板处理任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| mediaId | string | 媒资 ID |
| transcodeTasks | MediaTranscodeTaskInfo[] | 转码任务信息列表,当 presetIds 中包含转码模板时返回 |
| thumbnailTasks | MediaThumbnailTaskInfo[] | 抽帧任务信息列表,当 presetIds 中包含抽帧模板时返回 |
MediaPresetTaskInput
媒资进行模板处理任务的输入参数
| 名称 | 类型 | 说明 |
|---|---|---|
| presetIds | string[] | 模版 ID 列表,支持转码、抽帧模板,使用模板处理时必填 |
| watermarkIds | string[] | 明水印模版 ID 列表,当 presetIds 是转码模板时,watermarkIds 会在每一个转码处理中生效,使用模版处理时选填 |
| digitalWatermark | MediaTranscodeDigitalWatermark | 数字水印嵌入信息,使用模版处理时选填 |
MediaRegulationCompleteEvent
媒资 AI 审核完成回调事件内容
| 名称 | 类型 | 说明 |
|---|---|---|
| taskId | string | 任务 ID |
| status | string | 运行状态,包括
|
| createTime | string | 任务创建时间 |
| finishTime | string | 任务完成时间 |
| beginProcessTime | string | 任务开始转码时间 |
| regulationTaskInfo | MediaRegulationTaskInfo | AI 审核任务信息 |
MediaRegulationOutputInfo
AI 审核结果信息
| 名称 | 类型 | 说明 |
|---|---|---|
| id | string | AI 审核模板 ID |
| label | string | AI 审核整体结果,
|
| results | MediaRegulationOutputTypeResult[] | 审核类型结果列表 |
MediaRegulationOutputSubTypeEnum
审核结果中的 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 | 百度云风控 |
MediaRegulationOutputTypeEnum
审核结果中的 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 | 恶心 |
MediaRegulationOutputTypeResult
AI 审核类型结果
| 名称 | 类型 | 说明 |
|---|---|---|
| type | string(MediaRegulationOutputTypeEnum) | 审核类型 |
| items | MediaRegulationOutputTypeResultItem[] | 审核类型结果列表 |
MediaRegulationOutputTypeResultItem
AI 审核类型结果项
| 名称 | 类型 | 说明 |
|---|---|---|
| subType | string(MediaRegulationOutputSubTypeEnum) | 审核项 |
| timeInSeconds | int | 物料在视频中的秒数 |
| startTimeInSeconds | int | 物料在视频中的起始秒数,和 endTimeInSeconds 同时存在 |
| endTimeInSeconds | int | 物料在视频中的结束秒数,和 startTimeInSeconds 同时存在 |
| confidence | double | 审核结果项的置信度,0~100 的浮点数 |
| label | string | 审核结果项标记 |
| extra | string | 额外信息,如有;例如政治敏感人物识别出来的人名 |
| evidence | MediaRegulationOutputTypeResultItemEvidence[] | 审核项证据列表 |
MediaRegulationOutputTypeResultItemEvidence
AI 审核类型结果项证据
| 名称 | 类型 | 说明 |
|---|---|---|
| location | MediaRegulationOutputTypeResultItemEvidenceLocation | 证据位置信息 |
MediaRegulationOutputTypeResultItemEvidenceLocation
AI 审核类型结果项证据位置信息
| 名称 | 类型 | 说明 |
|---|---|---|
| leftOffsetInPixel | int | 左偏移 |
| topOffsetInPixel | int | 上偏移 |
| widthInPixel | int | 宽度 |
| heightInPixel | int | 高度 |
MediaRegulationTaskInfo
AI 审核任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| mediaId | string | 媒资 ID |
| errMsg | string | 错误信息 |
| regulationInput | MediaRegulationTaskInput | AI 审核任务输入信息 |
| regulationOutput | MediaRegulationOutputInfo | AI 审核任务输出信息 |
MediaRegulationTaskInput
AI 审核任务输入信息
| 名称 | 类型 | 说明 |
|---|---|---|
| presetId | string | 审核模板 ID |
MediaSource
媒资源信息
| 名称 | 类型 | 说明 |
|---|---|---|
| sourceType | string | 媒资来源,支持:
|
| sourceUrl | string | 媒资源文件播放地址 |
| coverUrl | string | 媒资封面图地址 |
MediaSourceMetadata
媒资源文件元信息
| 名称 | 类型 | 说明 |
|---|---|---|
| etag | string | 文件 ETag,可用于校验文件是否被修改过 |
| fileSizeInByte | int | 文件大小,单位:字节 |
| type | string | 文件类型,
|
| container | string | 音视频文件的容器类型 |
| durationInSecond | int | 音视频文件时长,单位:秒 |
| durationInMillisecond | int | 音视频文件时长,单位:毫秒 |
| video | MediaVideoCodec | 视频元信息 |
| audio | MediaAudioCodec | 音频元信息 |
| blackBorderArea | MediaBlackBorderArea | 视频黑边信息 |
MediaSubtitleOcrRegion
字幕任务的 ocr 识别区域
| 名称 | 类型 | 说明 |
|---|---|---|
| ocrRegionX | int | 字幕区域左上角 x 坐标,相对于视频左上角的偏移量,单位:像素 |
| ocrRegionY | int | 字幕区域左上角 y 坐标,相对于视频左上角的偏移量,单位:像素 |
| ocrRegionWidth | int | 字幕区域宽度,单位:像素 |
| ocrRegionHeight | int | 字幕区域高度,单位:像素 |
MediaSubtitleOutputInfo
字幕任务输出信息
| 名称 | 类型 | 说明 |
|---|---|---|
| id | string | 字幕任务 ID(工作流节点 ID) |
| urls | string[] | 字幕文件播放地址列表 |
| formats | string[] | 字幕文件格式列表,与 urls 顺序对应,类型支持:
|
MediaSubtitleTaskInfo
字幕任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| mediaId | string | 媒资 ID |
| status | string | 任务状态,包括
|
| errMsg | string | 任务失败时的错误信息 |
| subtitleInput | MediaSubtitleTaskInput | 字幕任务输入信息 |
| subtitleOutput | MediaSubtitleOutputInfo | 字幕任务输出信息 |
MediaSubtitleTaskInput
字幕任务输入信息
| 名称 | 类型 | 说明 |
|---|---|---|
| startTimeInSecond | int | 提取字幕开始时间 |
| durationTimeInSecond | int | 提取字幕时长 |
| formats | string[] | 字幕格式,支持:
|
| subtitleType | string | 提取字幕类型,支持:
|
| ocrRegion | MediaSubtitleOcrRegion | 文字识别区域,仅当字幕类型为 AUTO 时有效 |
MediaTaskBasicInfo
任务基本信息
| 名称 | 类型 | 说明 |
|---|---|---|
| taskId | string | 任务 ID |
| mediaId | string | 媒资 ID |
| type | string | 任务类型,包括
|
| status | string | 任务状态,包括
|
| createTime | string | 任务创建时间 |
| finishTime | string | 任务完成时间 |
MediaTaskDetail
任务详细信息
| 名称 | 类型 | 说明 |
|---|---|---|
| taskId | string | 任务 ID |
| type | string | 任务类型,包括
|
| status | string | 任务状态,包括
|
| createTime | string | 任务创建时间 |
| finishTime | string | 任务完成时间 |
| mediaWorkflowTaskInfo | MediaWorkflowTaskInfo | 工作流任务信息,仅当 type 为 WORKFLOW 时有效 |
| mediaPresetTaskInfo | MediaPresetTaskInfo | 模板任务信息,仅当 type 为 PRESET 时有效 |
| composeTaskInfo | ComposeTaskInfo | 视频云剪辑任务信息,仅当 type 为 COMPOSE 时有效 |
| mediaFetchTaskInfo | MediaFetchTaskInfo | 媒资拉取任务信息,仅当 type 为 FETCH 时有效 |
| mediaDwmDetectTaskInfo | MediaDwmDetectTaskInfo | 数字水印提取任务信息,仅当 type 为 DWM_DETECT 时有效 |
| videoGenerateTaskInfo | VideoGenerateTaskInfo | 视频生成任务信息,仅当 type 为 VIDEO_GENERATE 时有效 |
MediaThumbnailCompleteEvent
媒资截图完成回调事件内容
| 名称 | 类型 | 说明 |
|---|---|---|
| taskId | string | 任务 ID |
| status | string | 运行状态,包括
|
| createTime | string | 任务创建时间 |
| finishTime | string | 任务完成时间 |
| beginProcessTime | string | 任务开始转码时间 |
| thumbnailTaskInfo | MediaThumbnailTaskInfo | 抽帧任务信息 |
MediaThumbnailOutputInfo
抽帧任务结果信息
| 名称 | 类型 | 说明 |
|---|---|---|
| id | string | 抽帧模板 ID |
| urls | string[] | 抽帧结果播放地址列表 |
MediaThumbnailTaskInfo
抽帧任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| mediaId | string | 媒资 ID |
| errMsg | string | 错误信息 |
| thumbnailInput | MediaThumbnailTaskInput | 抽帧任务输入信息 |
| thumbnailOutput | MediaThumbnailOutputInfo | 抽帧任务输出信息 |
MediaThumbnailTaskInput
抽帧任务输入信息
| 名称 | 类型 | 说明 |
|---|---|---|
| presetId | string | 抽帧模板 ID |
MediaTranscodeCompleteEvent
媒资转码完成回调事件内容
| 名称 | 类型 | 说明 |
|---|---|---|
| taskId | string | 任务 ID |
| status | string | 运行状态,包括
|
| createTime | string | 任务创建时间 |
| finishTime | string | 任务完成时间 |
| beginProcessTime | string | 任务开始转码时间 |
| transcodeTaskInfo | MediaTranscodeTaskInfo | 转码任务信息 |
MediaTranscodeDigitalWatermark
转码嵌入数字水印的参数
| 名称 | 类型 | 说明 |
|---|---|---|
| digitalWmTextContent | string | 需嵌入的文字内容,长度<=100 字符 |
| digitalWmAlgVersion | int | 算法版本号,支持 1、2 |
| digitalWmStrength | float | 数字水印嵌入强度,对同一算法,强度越高则抗攻击能力越强,隐蔽性越差。范围 0 ~ 1,默认值 0.5 |
MediaTranscodeOutputAudioCodec
转码结果音频编码信息
| 名称 | 类型 | 说明 |
|---|---|---|
| channels | int | 音频文件的声道信息 |
| sampleRateInHz | int | 音频文件的采样率,单位:Hz |
MediaTranscodeOutputInfo
转码结果信息
| 名称 | 类型 | 说明 |
|---|---|---|
| id | string | 转码模板 ID |
| url | string | 转码结果播放地址 |
| meta | MediaTranscodeOutputMeta | 转码结果元信息 |
| watermarkIds | string[] | 明水印 ID 列表 |
| digitalWatermark | MediaTranscodeDigitalWatermark | 数字水印信息 |
MediaTranscodeOutputMeta
转码结果元信息
| 名称 | 类型 | 说明 |
|---|---|---|
| video | MediaTranscodeOutputVideoCodec | 转码结果视频编码信息 |
| audio | MediaTranscodeOutputAudioCodec | 转码结果音频编码信息 |
MediaTranscodeOutputVideoCodec
转码结果视频编码信息
| 名称 | 类型 | 说明 |
|---|---|---|
| durationInSeconds | int | 音视频文件时长,单位:秒 |
| durationInMilliSeconds | int | 音视频文件时长,单位:毫秒 |
| sizeInKiloByte | double | 音视频文件大小,单位:KB |
| widthInPixel | int | 视频宽度 |
| heightInPixel | int | 视频高度 |
| frameRate | int | 视频媒体的帧率 |
| gopAlign | bool | 是否开启 gop 对齐 |
| mp4MoovSize | int | mp4 文件 moov 块大小,单位:Byte |
MediaTranscodeTaskInfo
转码任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| mediaId | string | 媒资 ID |
| errMsg | string | 错误信息 |
| transcodeInput | MediaTranscodeTaskInput | 转码任务输入信息 |
| transcodeOutput | MediaTranscodeOutputInfo | 转码任务输出信息 |
MediaTranscodeTaskInput
转码任务输入信息
| 名称 | 类型 | 说明 |
|---|---|---|
| presetId | string | 转码模板 ID |
| watermarkIds | string[] | 明水印 ID 列表 |
MediaTranslationNodeTaskInfo
视频翻译任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| jobId | string | 节点任务 ID |
| mediaId | string | 媒资 ID |
| status | string | 任务状态 |
| translationOutput | MediaTranslationOutput | 视频翻译任务输出信息 |
MediaTranslationNodeTaskInfos
工作流视频翻译任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| translationTaskInfo | MediaTranslationNodeTaskInfo | 视频翻译任务信息 |
MediaTranslationOutput
视频翻译任务输出信息
| 名称 | 类型 | 说明 |
|---|---|---|
| targetLanguage | string | 目标翻译语言 |
| url | string | 字幕SRT链接 |
MediaUnderstandingNodeTaskInfos
工作流视频理解任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| understandingTaskInfo | MediaUnderstandingTaskInfo | 视频理解任务信息 |
MediaUnderstandingOutput
视频理解任务输出信息
| 名称 | 类型 | 说明 |
|---|---|---|
| url | string | 字幕SRT链接 |
MediaUnderstandingTaskInfo
视频理解任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| jobId | string | 节点任务 ID |
| mediaId | string | 媒资 ID |
| status | string | 任务状态 |
| projectId | string | 任务所属项目 |
| understandingOutput | MediaUnderstandingOutput | 视频理解任务输出信息 |
MediaUploadCompleteEvent
媒资上传完成回调事件内容,结构与 MediaBasicInfo 一致
MediaVideoCodec
媒资视频编码信息
| 名称 | 类型 | 说明 |
|---|---|---|
| codec | string | 视频文件的编码规格 |
| heightInPixel | int | 视频高度 |
| widthInPixel | int | 视频宽度 |
| bitRateInBps | int | 视频媒体的码率 |
| frameRate | int | 视频媒体的帧率 |
| rotate | int | 旋转角度(部分视频包含该参数) |
| dar | string | 视频显示宽高比,如 "16:9" (部分视频包含该参数) |
MediaVideoItem
视频信息
| 参数 | 类型 | 描述 |
|---|---|---|
| mediaId | string | 媒资 id |
MediaWorkflowAnalysisNodeTaskInfo
工作流视频分析节点信息
| 名称 | 类型 | 说明 |
|---|---|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| analysisTaskInfo | MediaAnalysisTaskInfo | 视频分析任务信息 |
MediaWorkflowBlackBorderDetectNodeTaskInfo
工作流黑边检测节点信息
| 名称 | 类型 | 说明 |
|---|---|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| blackBorderDetectTaskInfo | MediaBlackBorderDetectTaskInfo | 黑边检测任务信息 |
MediaWorkflowPublishNodeTaskInfo
工作流发布节点信息
| 名称 | 类型 | 说明 |
|---|---|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| status | string | 运行状态,包括
|
| errMsg | string | 错误信息 |
MediaWorkflowRegulationNodeTaskInfo
工作流视频审核节点信息
| 名称 | 类型 | 说明 |
|---|---|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| regulationTaskInfo | MediaRegulationTaskInfo | 视频审核任务信息 |
MediaWorkflowStartNodeTaskInfo
工作流开始节点信息
| 名称 | 类型 | 说明 |
|---|---|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| status | string | 运行状态,包括
|
| errMsg | string | 错误信息 |
MediaWorkflowSubtitleNodeTaskInfo
工作流字幕提取节点信息
| 名称 | 类型 | 说明 |
|---|---|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| subtitleTaskInfo | MediaSubtitleTaskInfo | 字幕任务信息 |
MediaWorkflowTaskInfo
工作流任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| mediaId | string | 媒资 ID |
| workflowId | string | 工作流 ID |
| startNodeTaskInfo | MediaWorkflowStartNodeTaskInfo | 开始节点任务信息 |
| transcodeNodeTaskInfos | MediaWorkflowTranscodeNodeTaskInfo[] | 转码节点任务信息 |
| thumbnailNodeTaskInfos | MediaWorkflowThumbnailNodeTaskInfo[] | 截图节点任务信息 |
| blackBorderDetectNodeTaskInfos | MediaWorkflowBlackBorderDetectNodeTaskInfo[] | 黑边检测节点任务信息 |
| subtitleNodeTaskInfos | MediaWorkflowSubtitleNodeTaskInfo[] | 字幕提取节点任务信息 |
| analysisNodeTaskInfos | MediaWorkflowAnalysisNodeTaskInfo[] | 分析节点任务信息 |
| regulationNodeTaskInfos | MediaWorkflowRegulationNodeTaskInfo[] | 审核节点任务信息 |
| understandingNodeTaskInfos | MediaUnderstandingNodeTaskInfos[] | 视频理解节点任务信息 |
| translationNodeTaskInfos | MediaTranslationNodeTaskInfos[] | 视频翻译节点任务信息 |
| composeNodeTaskInfos | MediaComposeNodeTaskInfos[] | 视频合成节点任务信息 |
| publishNodeTaskInfo | MediaWorkflowPublishNodeTaskInfo | 发布节点任务信息 |
MediaWorkflowTaskInput
媒资进行工作流处理任务的输入参数
| 名称 | 类型 | 说明 |
|---|---|---|
| workflowId | string | 工作流 id |
MediaWorkflowThumbnailNodeTaskInfo
工作流截图节点信息
| 名称 | 类型 | 说明 |
|---|---|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| thumbnailTaskInfos | MediaThumbnailTaskInfo | 截图任务信息 |
MediaWorkflowTranscodeNodeTaskInfo
工作流转码节点信息
| 名称 | 类型 | 说明 |
|---|---|---|
| nodeId | string | 节点 ID |
| nodeName | string | 节点名称 |
| transcodeTaskInfo | MediaTranscodeTaskInfo | 转码任务信息 |
TextToImageLTaskInput
文生图 L 任务输入参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| model | string | 生成模式,默认 max, 支持:
|
| prompt | string | 生成的提示文本,不超过2000字符, 必填 |
| aspectRatio | String | 图片宽高比,默认 1:1,支持:
|
| guidanceScale | string | 提示词引导系数,默认 3.5,支持:1.0~20.0 |
| imgCount | integer | 单次生图张数,默认 1,支持:1~4 |
TextToImageRequest
文生图任务输入参数
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| model | string | 是 | 模型名称, 支持:
|
| modelLTaskInput | TextToImageLTaskInput | 否 | L 模型的特定输入参数 |
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,支持
|
TextToVideoK20TaskInput
文生视频 K20 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| cfgScale | float | 自由度,非必填,默认 0.5,取值范围:[0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
| duration | int | 视频时长,单位 s,支持:
|
| motionMode | string | 生成模式,非必填,默认 std,支持:
|
| aspectRatio | string | 比例,非必填,默认 16:9,支持
|
TextToVideoK21MTaskInput
文生视频 K21M 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| cfgScale | float | 自由度,非必填,默认 0.5,取值范围:[0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
| duration | int | 视频时长,单位 s,支持:
|
| aspectRatio | string | 比例,非必填,默认 16:9,支持
|
TextToVideoK25TTaskInput
文生视频 K25T 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| cfgScale | float | 自由度,非必填,默认 0.5,取值范围:[0, 1],值越大,模型自由度越小,与用户输入的提示词相关性越强 |
| duration | int | 视频时长,单位 s,支持:
|
| aspectRatio | string | 比例,非必填,默认 16:9,支持
|
TextToVideoP35TaskInput
文生视频 P35 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| duration | int | 视频时长,单位 s,支持:
|
| resolution | string | 视频质量,支持:
|
| aspectRatio | string | 比例,支持:
|
| motionMode | string | 生成模式,非必填,默认 normal,支持:
|
| style | string | 风格,非必填,支持:
|
| seed | integer | 随机种子,非必填 |
| soundEffectSwitch | boolean | 是否开启背景音乐,非必填,默认 false |
| soundEffectContent | string | 背景音乐类型,非必填,默认自动匹配,支持字符串传入,如 鸟鸣 |
TextToVideoP40TaskInput
文生视频 P40 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| duration | int | 视频时长,单位 s,支持:
|
| resolution | string | 视频质量,支持:
|
| aspectRatio | string | 比例,支持:
|
| motionMode | string | 生成模式,非必填,默认 normal,支持:
|
| style | string | 风格,非必填,支持:
|
| seed | integer | 随机种子,非必填 |
| soundEffectSwitch | boolean | 是否开启背景音乐,非必填,默认 false |
| soundEffectContent | string | 背景音乐类型,非必填,默认自动匹配,支持字符串传入,如 鸟鸣 |
| cameraMovement | string | 运镜参数,非必填,支持
|
TextToVideoP45TaskInput
文生视频 P45 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| duration | int | 视频时长,单位 s,支持:
|
| resolution | string | 视频质量,支持:
|
| aspectRatio | string | 比例,支持:
|
| motionMode | string | 生成模式,非必填,默认 normal,支持:
|
| style | string | 风格,非必填,支持:
|
| seed | integer | 随机种子,非必填 |
| soundEffectSwitch | boolean | 是否开启背景音乐,非必填,默认 false |
| soundEffectContent | string | 背景音乐类型,非必填,默认自动匹配,支持字符串传入,如 鸟鸣 |
| cameraMovement | string | 运镜参数,非必填,支持
|
TextToVideoP50TaskInput
文生视频 P50 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| prompt | string | 提示词 |
| negativePrompt | string | 负面提示词 |
| duration | int | 视频时长,单位 s,支持:
|
| resolution | string | 视频质量,支持:
|
| aspectRatio | string | 比例,支持:
|
| motionMode | string | 生成模式,非必填,默认 normal,支持:
|
| style | string | 风格,非必填,支持:
|
| seed | integer | 随机种子,非必填 |
| soundEffectSwitch | boolean | 是否开启背景音乐,非必填,默认 false |
| soundEffectContent | string | 背景音乐类型,非必填,默认自动匹配,支持字符串传入,如 鸟鸣 |
TextToVideoRequest
文生视频任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| model | string | 模型名称,包括:
|
| modelV15TaskInput | TextToVideoV15TaskInput | V15 模型的特定输入参数 |
| modelVQ1TaskInput | TextToVideoVQ1TaskInput | VQ1 模型的特定输入参数 |
| modelVQ2TaskInput | TextToVideoVQ2TaskInput | VQ2 模型的特定输入参数 |
| modelP35TaskInput | TextToVideoP35TaskInput | P35 模型的特定输入参数 |
| modelP40TaskInput | TextToVideoP40TaskInput | P40 模型的特定输入参数 |
| modelP45TaskInput | TextToVideoP45TaskInput | P45 模型的特定输入参数 |
| modelP50TaskInput | TextToVideoP50TaskInput | P50 模型的特定输入参数 |
| modelK16TaskInput | TextToVideoK16TaskInput | K16 模型的特定输入参数 |
| modelK20TaskInput | TextToVideoK20TaskInput | K20 模型的特定输入参数 |
| modelK21MTaskInput | TextToVideoK21MTaskInput | K21M 模型的特定输入参数 |
| modelK25TTaskInput | TextToVideoK25TTaskInput | K25T 模型的特定输入参数 |
TextToVideoV15TaskInput
文生视频 V15 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| prompt | string | 生成的提示文本 |
| duration | integer | 视频时长,单位 s,支持:
|
| resolution | string | 分辨率,支持:
|
| style | string | 风格,非必填,默认 general,支持:
|
| movementAmplitude | string | 运动幅度,非必填,默认 auto, 支持:
|
| seed | integer | 随机种子,非必填 |
| aspectRatio | string | 比例,非必填,默认 16:9 , 支持:
|
| bgm | boolean | 是否开启背景音乐,非必填,默认 false |
TextToVideoVQ1TaskInput
文生视频 VQ1 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| prompt | string | 生成的提示文本 |
| duration | integer | 视频时长,单位 s,支持:
|
| resolution | string | 分辨率,支持:
|
| style | string | 风格,非必填,默认 general,支持:
|
| movementAmplitude | string | 运动幅度,非必填,默认 auto, 支持:
|
| seed | integer | 随机种子,非必填 |
| aspectRatio | string | 比例,非必填,默认 16:9 , 支持:
|
| bgm | boolean | 是否开启背景音乐,非必填,默认 false |
TextToVideoVQ2TaskInput
文生视频 VQ2 任务输入参数
| 参数 | 类型 | 描述 |
|---|---|---|
| prompt | string | 生成的提示文本 |
| duration | integer | 视频时长,单位 s,支持:
|
| resolution | string | 分辨率,支持:
|
| style | string | 风格,非必填,默认 general,支持:
|
| movementAmplitude | string | 运动幅度,非必填,默认 auto, 支持:
|
| seed | integer | 随机种子,非必填 |
| aspectRatio | string | 比例,非必填,默认 16:9 , 支持:
|
| bgm | boolean | 是否开启背景音乐,非必填,默认 false |
VideoExtendRequest
视频延长任务输入参数
| 参数 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| model | string | 是 | 模型名称,支持:
|
| modelP35TaskInput | ExtendVideoPTaskInput | 否 | P35 模型的特定输入参数 |
| modelP40TaskInput | ExtendVideoPTaskInput | 否 | P40 模型的特定输入参数 |
| modelP45TaskInput | ExtendVideoPTaskInput | 否 | P45 模型的特定输入参数 |
| modelP50TaskInput | ExtendVideoPTaskInput | 否 | P50 模型的特定输入参数 |
| modelKTaskInput | ExtendVideoKTaskInput | 否 | K 模型的特定输入参数 |
VideoGenerateCameraControl
控制摄像机运动的协议(如未指定,模型将根据输入的文本/图片进行智能匹配)
| 参数 | 类型 | 描述 |
|---|---|---|
| type | string | 预定义的运镜类型
|
| config | VideoGenerateCameraControlConfig | 图片信息, 图生必填 |
VideoGenerateCameraControlConfig
包含六个字段,用于指定摄像机在不同方向上的运动或变化
- 当运镜类型指定 simple 时必填,指定其他类型时不填
- 以下参数 6 选 1,即指定一个即可
| 参数 | 类型 | 描述 |
|---|---|---|
| horizontal | float | 水平运镜,控制摄像机在水平方向上的移动量(沿 x 轴平移)
|
| vertical | float | 垂直运镜,控制摄像机在垂直方向上的移动量(沿 y 轴平移)
|
| pan | float | 水平摇镜,控制摄像机在水平面上的旋转量(绕 y 轴旋转)
|
| tilt | float | 垂直摇镜,控制摄像机在垂直面上的旋转量(沿 x 轴旋转)
|
| roll | float | 旋转运镜,控制摄像机的滚动量(绕 z 轴旋转)
|
| zoom | float | 变焦,控制摄像机的焦距变化,影响视野的远近
|
VideoGenerateCompleteEvent
视频生成完成回调事件内容
| 名称 | 类型 | 说明 |
|---|---|---|
| taskId | string | 任务 ID |
| status | string | 运行状态,包括
|
| createTime | string | 任务创建时间 |
| finishTime | string | 任务完成时间 |
| videoGenerateCompleteEvent | VideoGenerateTaskInfo | 视频生成任务输入参数 |
VideoGenerateTaskInfo
视频生成任务信息
| 名称 | 类型 | 说明 |
|---|---|---|
| errMsg | string | 错误信息 |
| unitPrice | float | 任务消耗积分 |
| videoGenerateTaskInput | VideoGenerateTaskInput | 视频生成任务输入参数 |
| videoGenerateTaskOutput | VideoGenerateTaskOutput | 视频生成任务输出参数 |
VideoGenerateTaskInput
视频生成任务输入参数
| 名称 | 类型 | 说明 |
|---|---|---|
| type | string | 任务请求类型,包括:
|
| imageToVideoRequest | ImageToVideoRequest | 图生视频任务输入参数 |
| textToVideoRequest | TextToVideoRequest | 文生视频任务输入参数 |
| effectVideoRequest | EffectVideoRequest | 特效视频任务输入参数 |
| lipSyncRequest | LipSyncRequest | 对口型任务输入参数 |
| videoExtendRequest | VideoExtendRequest | 视频延长任务输入参数 |
| imageToImageRequest | ImageToImageRequest | 图生图任务输入参数 |
| textToImageRequest | TextToImageRequest | 文生图任务输入参数 |
VideoGenerateTaskOutput
视频生成任务输出参数
| 参数 | 类型 | 描述 |
|---|---|---|
| mediaBasicInfos | MediaBasicInfo[] | 生成媒资基本信息列表 |
