功能描述
提交一个视频合成任务。
授权说明
通过子账号使用时,需要授予
ci:CreateMediaJobs
权限,详情请参见 数据万象 action。子账号使用异步处理接口时,需要授予
cam:passrole
权限,异步处理接口会通过 CAM 的“角色”进行 COS 的资源读写操作,PassRole 权限用于传递角色, 具体请查看 访问管理-写操作-PassRole 接口。服务开通
使用该功能需提前开通数据万象,并绑定存储桶。详情请参见 绑定存储桶。
使用该功能需提前通过控制台或接口开通媒体处理服务 。详情请参见 开通媒体处理服务。
使用限制
费用说明
请求
请求示例
POST /jobs HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
说明:
请求头
请求体
该请求操作的实现需要有如下请求体。
<Request><Tag>VideoSynthesis</Tag><Operation><TranscodeTemplateId>t160606b9752148c4absdfaf2f55163b1f</TranscodeTemplateId><WatermarkTemplateId>t146d70eb241c44c63b6efc1cc93ccfc5d</WatermarkTemplateId><VideoSynthesis><KeepAudioTrack>false</KeepAudioTrack><SpliceInfo><Url>https://test-123456789.cos.ap-chongqing.myqcloud.com/input/car.mp4</Url><Width>640</Width></SpliceInfo><SpliceInfo><Url>https://test-123456789.cos.ap-chongqing.myqcloud.com/input/game.mp4</Url><X>700</X><Width>640</Width><Height>960</Height></SpliceInfo></VideoSynthesis><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
具体的数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 保存请求的容器 | Container | 是 |
Container 类型 Request 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 创建任务的 Tag:VideoSynthesis | String | 是 |
Input | Request | 待操作的文件信息 | Container | 是 |
Operation | Request | 操作规则 | Container | 是 |
CallBackFormat | Request | 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式 | String | 否 |
CallBackType | Request | 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型 | String | 否 |
CallBack | Request | 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调 | String | 否 |
CallBackMqConfig | Request | Container | 否 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 文件路径 | String | 是 |
Container 类型
Operation
的具体数据描述如下:节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
VideoSynthesis | Request.Operation | 视频合成模板参数 | Container | 是 |
TranscodeTemplateId | Request.Operation | 转码模板 ID | String | 否 |
Transcode | Request.Operation | 转码模板参数 | Container | 否 |
WatermarkTemplateId | Request.Operation | 水印模板 ID,可以传多个水印模板 ID,最多传3个 | String 数组 | 否 |
Watermark | Request.Operation | Container 数组 | 否 | |
Output | Request.Operation | 结果输出配置 | Container | 是 |
UserData | Request.Operation | 透传用户信息,可打印的 ASCII 码,长度不超过1024 | String | 否 |
JobLevel | Request.Operation | 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0 | String | 否 |
说明:
转码参数必须设置,可以通过 TranscodeTemplateId 或 Transcode 设置, TranscodeTemplateId 优先级更高。
水印参数可选,可以通过 WatermarkTemplateId 或 Watermark 设置,WatermarkTemplateId 优先级更高。
Container 类型 VideoSynthesis 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
KeepAudioTrack | Request.Operation.VideoSynthesis | 是否保留源视频音轨,取值 true/false,默认值 false | String | 否 |
SpliceInfo | Request.Operation.VideoSynthesis | 待合成的视频 | Container 数组 | 是 |
Container 类型 SpliceInfo 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Url | Request.Operation.VideoSynthesis.SpliceInfo | 同 bucket 的视频文件地址 | String | 是 |
X | Request.Operation.VideoSynthesis.SpliceInfo | 该视频在画面中的横坐标,默认值 0 | String | 否 |
Y | Request.Operation.VideoSynthesis.SpliceInfo | 该视频在画面中的纵坐标,默认值 0 | String | 否 |
Width | Request.Operation.VideoSynthesis.SpliceInfo | 该视频在画面中的宽,默认原视频宽 | String | 否 |
Height | Request.Operation.VideoSynthesis.SpliceInfo | 该视频在画面中的高,默认原视频高 | String | 否 |
Name | Request.Operation.VideoSynthesis.SpliceInfo | 该视频流的自定义名称, 长度不超过64个字符,仅支持中文、英文、数字、_、-和* | String | 否 |
Container 类型 Transcode 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
TimeInterval | Request.Operation.Transcode | Container | 否 | |
Container | Request.Operation.Transcode | Container | 否 | |
Video | Request.Operation.Transcode | Container | 否 | |
Audio | Request.Operation.Transcode | Container | 否 | |
TransConfig | Request.Operation.Transcode | Container | 否 | |
AudioMix | Request.Operation.Transcode | Container | 否 | |
AudioMixArray | Request.Operation.Transcode | 混音参数数组,最多同时传2个 | Container 数组 | 否 |
说明:
不传 Video,相当于删除视频信息。不传 Audio,相当于删除音频信息。Video 和 Audio 不可以同时不传。
AudioMix 和 AudioMixArray 在 Audio.Remove 为 false 时生效。
AudioMixArray 是一个数组,每一个子项内容同 AudioMix 。AudioMix 优先级更高,设置 AudioMix 时,AudioMixArray 无效。
Container 类型 Output 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Region | Request.Operation.Output | 存储桶的地域 | String | 是 |
Bucket | Request.Operation.Output | 存储结果的存储桶 | String | 是 |
Object | Request.Operation.Output | 输出结果的文件名 | String | 是 |
Request.Operation.Output.Object 支持的通配符如下:
通配符 | 含义 |
${ext} | 封装格式 |
${jobid} | 任务Id |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><JobsDetail><Code>Success</Code><Message/><JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId><State>Submitted</State><CreationTime>2022-06-27T14:44:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><Tag>VideoSynthesis</Tag><Operation><TranscodeTemplateId>t160606b9752148c4absdfaf2f55163b1f</TranscodeTemplateId><WatermarkTemplateId>t146d70eb241c44c63b6efc1cc93ccfc5d</WatermarkTemplateId><VideoSynthesis><KeepAudioTrack>false</KeepAudioTrack><SpliceInfo><Url>https://test-123456789.cos.ap-chongqing.myqcloud.com/input/car.mp4</Url><Width>640</Width></SpliceInfo><SpliceInfo><Url>https://test-123456789.cos.ap-chongqing.myqcloud.com/input/game.mp4</Url><X>700</X><Width>640</Width><Height>960</Height></SpliceInfo></VideoSynthesis><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
JobsDetail | Response | 任务的详细信息 | Container 数组 |
Container 节点
JobsDetail
的内容:节点名称(关键字) | 父节点 | 描述 | 类型 |
Code | Response.JobsDetail | 错误码,只有 State 为 Failed 时有意义 | String |
Message | Response.JobsDetail | 错误描述,只有 State 为 Failed 时有意义 | String |
JobId | Response.JobsDetail | 新创建任务的 ID | String |
Tag | Response.JobsDetail | 新创建任务的 Tag:VideoSynthesis | String |
State | Response.JobsDetail | 任务状态 Submitted:已提交,待执行 Running:执行中 Success:执行成功 Failed:执行失败 Pause:任务暂停,当暂停队列时,待执行的任务会变为暂停状态 Cancel:任务被取消执行 | String |
Progress | Response.JobsDetail | 任务进度百分比,只有在State为 Submitted、Running、Success、Pause 时有意义,范围为[0, 100] | String |
CreationTime | Response.JobsDetail | 任务的创建时间 | String |
StartTime | Response.JobsDetail | 任务的开始时间 | String |
EndTime | Response.JobsDetail | 任务的结束时间 | String |
QueueId | Response.JobsDetail | String | |
Input | Response.JobsDetail | 该任务的输入资源地址 | Container |
Operation | Response.JobsDetail | 该任务的规则 | Container |
Container 节点 Input 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Region | Response.JobsDetail.Input | 存储桶的地域 | String |
Bucket | Response.JobsDetail.Input | 存储结果的存储桶 | String |
Object | Response.JobsDetail.Input | 输出结果的文件名 | String |
Container 节点 Operation 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
VideoSynthesis | Response.JobsDetail.Operation | 同请求中的 Request.Operation.VideoSynthesis | Container |
TranscodeTemplateId | Response.JobsDetail.Operation | 同请求中的 Request.Operation.TranscodeTemplateId | String |
Transcode | Response.JobsDetail.Operation | 同请求中的 Request.Operation.Transcode | Container |
Watermark | Response.JobsDetail.Operation | 同请求中的 Request.Operation.Watermark | Container 数组 |
WatermarkTemplateId | Response.JobsDetail.Operation | 同请求中的 Request.Operation.WatermarkTemplateId | String 数组 |
Output | Response.JobsDetail.Operation | 同请求中的 Request.Operation.Output | Container |
MediaInfo | Response.JobsDetail.Operation | Container | |
MediaResult | Response.JobsDetail.Operation | Container | |
DigitalWatermark | Response.JobsDetail.Operation | 同请求中的 Request.Operation.DigitalWatermark | Container |
UserData | Response.JobsDetail.Operation | 透传用户信息 | String |
JobLevel | Response.JobsDetail.Operation | 任务优先级 | String |
错误码
实际案例
请求
POST /jobs HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057Host: test-1234567890.ci.ap-chongqing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Tag>VideoSynthesis</Tag><Operation><TranscodeTemplateId>t160606b9752148c4absdfaf2f55163b1f</TranscodeTemplateId><WatermarkTemplateId>t146d70eb241c44c63b6efc1cc93ccfc5d</WatermarkTemplateId><VideoSynthesis><KeepAudioTrack>false</KeepAudioTrack><SpliceInfo><Url>https://test-123456789.cos.ap-chongqing.myqcloud.com/input/car.mp4</Url><Width>640</Width></SpliceInfo><SpliceInfo><Url>https://test-123456789.cos.ap-chongqing.myqcloud.com/input/game.mp4</Url><X>700</X><Width>640</Width><Height>960</Height></SpliceInfo></VideoSynthesis><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation><CallBack>http://callback.demo.com</CallBack><CallBackFormat>JSON</CallBackFormat></Request>
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><JobsDetail><Code>Success</Code><Message/><JobId>je8f65004eb8511eaaed4f377124a303c</JobId><State>Submitted</State><Progress>0</Progress><CreationTime>2019-07-07T12:12:12+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><QueueId>p2242ab62c7c94486915508540933a2c6</QueueId><Tag>VideoSynthesis</Tag><Operation><TranscodeTemplateId>t160606b9752148c4absdfaf2f55163b1f</TranscodeTemplateId><WatermarkTemplateId>t146d70eb241c44c63b6efc1cc93ccfc5d</WatermarkTemplateId><VideoSynthesis><KeepAudioTrack>false</KeepAudioTrack><SpliceInfo><Url>https://test-123456789.cos.ap-chongqing.myqcloud.com/input/car.mp4</Url><Width>640</Width></SpliceInfo><SpliceInfo><Url>https://test-123456789.cos.ap-chongqing.myqcloud.com/input/game.mp4</Url><X>700</X><Width>640</Width><Height>960</Height></SpliceInfo></VideoSynthesis><Output><Region>ap-chongqing</Region><Bucket>test-123456789</Bucket><Object>output/out.${ext}</Object></Output><UserData>This is my data.</UserData><JobLevel>0</JobLevel></Operation></JobsDetail></Response>