功能描述
提交一个转码任务。
授权说明
授权策略中 action 设置为 ci:CreateMediaJobs
。查看所有 action。
服务开通
使用该功能需提前开通数据万象,并绑定存储桶。详情请参见 绑定存储桶。
使用限制
使用该接口时,请先确认相关限制条件。详情请参见 使用限制。
请求
请求示例
POST /jobs HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml
<body>
说明Authorization: Auth String(详情请参见 请求签名 文档)。通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。
请求头
此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。
请求体
该请求操作的实现需要有如下请求体。
Transcode input/demo.mp4 t1460606b9752148c4ab182f55163ba7cd t1318c5f428d474afba1797f84091cbe22 t1318c5f428d474afba1797f84091cbe23 t1318c5f428d474afba1797f84091cbe24 150 150 75 75 https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt Text 123456789ab V1 false ap-chongqing test-123456789 output/out.${ext} This is my data. 0 http://callback.demo.com JSON
具体的数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 保存请求的容器 | Container | 是 |
Container 类型 Request 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 创建任务的Tag:Transcode | String | 是 |
Input | Request | 待操作的文件信息 | Container | 是 |
Operation | Request | 操作规则 | Container | 是 |
QueueType | Request | 任务所在的队列类型,限制为 SpeedTranscoding, 表示为开启倍速转码 | String | 否 |
CallBackFormat | Request | 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式 | String | 否 |
CallBackType | Request | 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型 | String | 否 |
CallBack | Request | 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调 | String | 否 |
CallBackMqConfig | Request | 任务回调TDMQ配置,当 CallBackType 为 TDMQ 时必填。详情请参见 CallBackMqConfig | Container | 否 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 文件路径 | String | 是 |
Container 类型 Operation 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
TemplateId | Request.Operation | 转码模板 ID | String | 否 |
Transcode | Request.Operation | 转码模板参数 | Container | 否 |
WatermarkTemplateId | Request.Operation | 水印模板 ID,可以传多个水印模板 ID,最多传3个 | String 数组 | 否 |
Watermark | Request.Operation | 水印模板参数,同创建水印模板接口中的 Request.Watermark,最多传3个 | Container 数组 | 否 |
RemoveWatermark | Request.Operation | 去除水印参数, H265、AV1编码暂不支持该参数 | Container | 否 |
Subtitles | Request.Operation | 字幕参数,H265、AV1编码和非mkv封装暂不支持该参数 | Container | 否 |
DigitalWatermark | Request.Operation | 数字水印参数,详情请参见 DigitalWatermark | Container | 否 |
Output | Request.Operation | 结果输出配置 | Container | 是 |
UserData | Request.Operation | 透传用户信息,可打印的 ASCII 码,长度不超过1024 | String | 否 |
JobLevel | Request.Operation | 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0 | String | 否 |
说明转码参数必须设置,可以通过 TemplateId 或 Transcode 设置, TemplateId 优先级更高。水印参数可选,可以通过 WatermarkTemplateId 或 Watermark 设置,WatermarkTemplateId 优先级更高。Container 类型 Transcode 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
TimeInterval | Request.Operation.Transcode | 同创建转码模板接口中的 Request.TimeInterval | Container | 否 |
Container | Request.Operation.Transcode | 同创建转码模板接口中的 Request.Container | Container | 否 |
Video | Request.Operation.Transcode | 同创建转码模板接口中的 Request.Video | Container | 否 |
Audio | Request.Operation.Transcode | 同创建转码模板接口中的 Request.Audio | Container | 否 |
TransConfig | Request.Operation.Transcode | 同创建转码模板接口中的 Request.TransConfig | Container | 否 |
AudioMix | Request.Operation.Transcode | 混音参数,详情见 AudioMix | Container | 否 |
AudioMixArray | Request.Operation.Transcode | 混音参数数组,最多同时传2个 | Container 数组 | 否 |
说明不传 Video,相当于删除视频信息。不传 Audio,相当于删除音频信息。Video 和 Audio 不可以同时不传。AudioMix 和 AudioMixArray 在 Audio.Remove 为 false 时生效。AudioMixArray 是一个数组,每一个子项内容同 AudioMix 。AudioMix 优先级更高,设置 AudioMix 时,AudioMixArray 无效。Container 类型 RemoveWatermark 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Dx | Request.Operation.RemoveWatermark | 距离左上角原点 x 偏移,范围为[1, 4096] | string | 是 |
Dy | Request.Operation.RemoveWatermark | 距离左上角原点 y 偏移,范围为[1, 4096] | string | 是 |
Width | Request.Operation.RemoveWatermark | 宽,范围为[1, 4096] | string | 是 |
Height | Request.Operation.RemoveWatermark | 高,范围为[1, 4096] | string | 是 |
Container 类型 Subtitles 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Subtitle | Request.Operation.Subtitles | 字幕参数 | Container数组 | 是 |
Container 类型 Subtitle 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Url | Request.Operation.Subtitles.Subtitle | 同 bucket 的字幕地址,支持 srt 和 vtt 格式,需要 encode | string | 是 |
Embed | Request.Operation.Subtitles.Subtitle | 是否开启硬字幕,取值范围 ture/false,默认值 false | string | 否 |
FontType | Request.Operation.Subtitles.Subtitle | 字体类型,参考下方的 FontType 表。当 Embed 为 true 时必填 。 | string | 否 |
FontSize | Request.Operation.Subtitles.Subtitle | 字体大小,值范围:[5 100],单位 px。当 Embed 为 true 时必填 | string | 否 |
FontColor | Request.Operation.Subtitles.Subtitle | 字体颜色,格式:0xRRGGBB。当 Embed 为 true 时必填 | string | 否 |
OutlineColor | Request.Operation.Subtitles.Subtitle | 轮廓颜色,格式:0xRRGGBB。当 Embed 为 true 时必填 | string | 否 |
VMargin | Request.Operation.Subtitles.Subtitle | 字幕距离视频下边缘的百分比,取值范围 [1, 100]。当 Embed 为 true 时必填 | string | 否 |
Subtitle 的 FontType 具体数据描述如下:
字体名称 | 支持的语言 | 描述 |
simfang.ttf | 中/英 | 仿宋 |
simhei.ttf | 中/英 | 黑体 |
simkai.ttf | 中/英 | 楷体 |
simsun.ttc | 中/英 | 宋体 |
STHeiti-Light.ttc | 中/英 | 华文黑体 |
STHeiti-Medium.ttc | 中/英 | 华文黑体中 |
youyuan.TTF | 中/英 | 幼圆 |
ahronbd.ttf | 英 | 无 |
ariblk.ttf | 英 | 无 |
arial.ttf | 英 | 无 |
Helvetica.dfont | 英 | 无 |
HelveticaNeue.dfont | 英 | 无 |
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 数据,包含完整节点数据的内容展示如下:
Success j8d121820f5e411ec926ef19d53ba9c6f Submitted 0 2022-06-27T15:23:10+0800 - - p2242ab62c7c94486915508540933a2c6 Transcode test-123456789 input/demo.mp4 ap-chongqing t1460606b9752148c4ab182f55163ba7cd trans_993874 t1318c5f428d474afba1797f84091cbe22 t1318c5f428d474afba1797f84091cbe23 t1318c5f428d474afba1797f84091cbe24 150 150 75 75 https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt Text 123456789ab V1 false Running ap-chongqing test-123456789 output/out.${ext} This is my data. 0
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
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:Transcode | String |
State | Response.JobsDetail | 任务状态Submitted:已提交,待执行Running:执行中Success:执行成功Failed:执行失败Pause:任务暂停,当暂停队列时,待执行的任务会变为暂停状态Cancel:任务被取消执行 | String |
Progress | Response.JobsDetail | 任务进度百分比,范围为[0, 100] | String |
CreationTime | Response.JobsDetail | 任务的创建时间 | String |
StartTime | Response.JobsDetail | 任务的开始时间 | String |
EndTime | Response.JobsDetail | 任务的结束时间 | String |
QueueId | Response.JobsDetail | 任务所属的 队列 ID | 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 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
TemplateId | Response.JobsDetail.Operation | 任务的模板 ID | String |
TemplateName | Response.JobsDetail.Operation | 任务的模板名称, 当 TemplateId 存在时返回 | 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 数组 |
RemoveWatermark | Response.JobsDetail.Operation | 同请求中的 Request.Operation.RemoveWatermark | Container |
Output | Response.JobsDetail.Operation | 同请求中的 Request.Operation.Output | Container |
MediaInfo | Response.JobsDetail.Operation | 输出文件的媒体信息,详见 MediaInfo,任务未完成时不返回 | Container |
MediaResult | Response.JobsDetail.Operation | 输出文件的基本信息,详见 MediaResult,任务未完成时不返回 | Container |
DigitalWatermark | Response.JobsDetail.Operation | 同请求中的 Request.Operation.DigitalWatermark | Container |
UserData | Response.JobsDetail.Operation | 同请求中的 Request.Operation.UserData | String |
JobLevel | Response.JobsDetail.Operation | 同请求中的 Request.Operation.JobLevel | String |
错误码
该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。
实际案例
请求1:使用转码模板 ID
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
Transcode input/demo.mp4 t1460606b9752148c4ab182f55163ba7cd t1318c5f428d474afba1797f84091cbe22 t1318c5f428d474afba1797f84091cbe23 t1318c5f428d474afba1797f84091cbe24 150 150 75 75 https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt Text 123456789ab V1 false ap-chongqing test-123456789 output/out.${ext} This is my data. 0 http://callback.demo.com JSON
响应1
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****
Success j8d121820f5e411ec926ef19d53ba9c6f Submitted 0 2022-06-27T15:23:11+0800 - - p2242ab62c7c94486915508540933a2c6 Transcode test-123456789 input/demo.mp4 ap-chongqing t1460606b9752148c4ab182f55163ba7cd trans_993874 t1318c5f428d474afba1797f84091cbe22 t1318c5f428d474afba1797f84091cbe23 t1318c5f428d474afba1797f84091cbe24 150 150 75 75 https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt Text 123456789ab V1 false Running ap-chongqing test-123456789 output/out.${ext} This is my data. 0
请求2:使用转码处理参数
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
Transcode input/demo.mp4 mp4 H.264 high 1000 1280 30 medium aac 44100 128 4 scale false 1 0 60 https://test-xxx.cos.ap-chongqing.myqcloud.com/mix1.mp3 Once true true 3 false 0 true 1.7 https://test-xxx.cos.ap-chongqing.myqcloud.com/mix2.mp3 Once true true 3 false 0 true 1.7 Text Absolute 128 128 TopRight 0 100.5 水印内容 30 simfang.ttf 0xRRGGBB 30 150 150 75 75 https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt Text 123456789ab V1 false ap-chongqing test-123456789 output/out.${ext} This is my data. 0 http://callback.demo.com JSON
响应2
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****
Success j8d121820f5e411ec926ef19d53ba9c6f Submitted 0 2022-06-27T15:23:10+0800 - - p2242ab62c7c94486915508540933a2c6 Transcode test-123456789 input/demo.mp4 ap-chongqing mp4 H.264 high 1000 1280 30 medium aac 44100 128 4 scale false 1 0 60 https://test-xxx.cos.ap-chongqing.myqcloud.com/mix1.mp3 Once true true 3 false 0 true 1.7 https://test-xxx.cos.ap-chongqing.myqcloud.com/mix2.mp3 Once true true 3 false 0 true 1.7 Text Absolute 128 128 TopRight 0 100.5 水印内容 30 0xRRGGBB 30 150 150 75 75 https://test-xxx.cos.ap-chongqing.myqcloud.com/test1.srt https://test-xxx.cos.ap-chongqing.myqcloud.com/test2.srt Text 123456789ab V1 false Running ap-chongqing test-123456789 output/out.${ext} This is my data. 0
对象存储官网1折活动,限时活动,即将结束,速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/145135.html