8.3 查询转码任务
8.1 新建转码任务
功能介绍
新建转码任务可以将视频进行转码，并在转码过程中压制水印、视频截图等。视频转 码前需要配置转码模板。 待转码的音视频需要存储在与媒体处理服务同区域的OBS桶 中，且该OBS桶已授权。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/{project_id}/transcodings 表8-1 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID
请求参数
表8-2 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 否 String 用户Token。
通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。
Authorization 否 String 使用AK/SK方式认证时必选，携 带的鉴权信息。
X-Project_Id 否 String 使用AK/SK方式认证时必选，携 带项目ID信息, 与路径参数中的 项目ID相同。
X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请 求的发生时间。
表8-3 请求 Body 参数
参数 是否必选 参数类型 描述
input 否 ObsObjInfo
object 源文件存储地址，非追加音频等 场景，该参数必选。
output 是 ObsObjInfo
object 输出文件存储地址。
trans_templat
e_id 否 Array of
integers 转码模板ID，没带
av_parameter参数时，必须带
● 视频bitrate，height，
width。
av_parameter
s 否 Array of
AvParameter s objects
转码参数。
参数 是否必选 参数类型 描述 output_filena
mes 否 Array of
strings 输出文件名称，每一路转码输出 对应一个名称，需要与转码模板
user_data 否 String 用户自定义数据，该字段可在查 询接口或消息通知中按原内容透 传给用户。
watermarks 否 Array of WatermarkR equest objects
图片水印参数，数组，最多支持 10个成员。
thumbnail 否 Thumbnail
object 截图信息。
说明仅“trans_template_id”对应的转 码模板或“av_parameters”中设 置的输出分辨率为1920×1080、
1280×720、854×480或480×270 时，视频转码才会输出对应的截图 文件；否则将不输出截图文件。
priority 否 Integer 任务优先级，取值如下：
● 9代表高优先级。
● 6代表中优先级，默认为6。
暂时只支持6和9。
subtitle 否 Subtitle
object 字幕参数。
encryption 否 Encryption
object 视频加密控制参数。
crop 否 Crop object 截取前多少秒做转码。
audio_track 否 AudioTrack
object 音轨参数。
multi_audio 否 MultiAudio
object 音频多语言多声道参数。
video_process 否 VideoProcess
object 视频处理控制参数 audio_process 否 AudioProcess
object 音频处理控制参数
表8-4 ObsObjInfo
参数 是否必选 参数类型 描述
bucket 是 String OBS的bucket名称。
location 是 String OBS桶所在的区域，且必须与使 用的MPC区域保持一致。
object 是 String OBS对象路径，遵守OSS Object 定义。
● 当用于指示input时,需要指定 到具体对象。
● 当用于指示output时, 只需指 定到转码结果期望存放的路 径。
file_name 否 String 文件名，仅用于转封装指定输出 名称。
● 当指定了此参数时，输出的 对象名为object/
file_name 。
● 当不指定此参数时，输出的 对象名为object/xxx，其中 xxx由MPC指定。
表8-5 AvParameters
参数 是否必选 参数类型 描述
video 否 VideoParame
ters object 视频参数 audio 否 Audio object 音频参数
common 是 Common
object 公共参数
API 参考 8 媒资转码接口
表8-6 VideoParameters
参数 是否必选 参数类型 描述
output_policy 否 String 输出策略。
取值如下：
● discard
● transcode 说明
● 当视频参数中的
“output_policy”为
"discard"，且音频参数中的
“output_policy”为
“transcode”时，表示只输出 音频。
● 当视频参数中的
“output_policy”为
"transcode"，且音频参数中的
“output_policy”为
“discard”时，表示只输出视 频。
● 同时为"discard"时不合法。
● 同时为“transcode”时，表示 输出音视频。
codec 否 Integer 视频编码格式。
取值如下：
● 1：VIDEO_CODEC_H264
● 2：VIDEO_CODEC_H265
bitrate 否 Integer 输出平均码率。
取值范围：0或[40,30000]之间 的整数。
单位：kbit/s
若设置为0，则输出平均码率为 自适应值。
参数 是否必选 参数类型 描述
profile 否 Integer 编码档次
取值如下：
● 1：VIDEO_PROFILE_H264_BAS E
● 2：VIDEO_PROFILE_H264_MAI N
● 3：VIDEO_PROFILE_H264_HIG H
● 4：VIDEO_PROFILE_H265_MAI N
level 否 Integer 编码级别
取值如下：
● 1：VIDEO_LEVEL_1_0
● 2：VIDEO_LEVEL_1_1
● 3：VIDEO_LEVEL_1_2
● 4：VIDEO_LEVEL_1_3
● 5：VIDEO_LEVEL_2_0
● 6：VIDEO_LEVEL_2_1
● 7：VIDEO_LEVEL_2_2
● 8：VIDEO_LEVEL_3_0
● 9：VIDEO_LEVEL_3_1
● 10：VIDEO_LEVEL_3_2
● 11：VIDEO_LEVEL_4_0
● 12：VIDEO_LEVEL_4_1
● 13：VIDEO_LEVEL_4_2
● 14：VIDEO_LEVEL_5_0
● 15：VIDEO_LEVEL_5_1
● 16：VIDEO_LEVEL_x_x
API 参考 8 媒资转码接口
参数 是否必选 参数类型 描述
preset 否 Integer 编码质量等级
取值如下：
● 1：VIDEO_PRESET_HSPEED2 (只用于h.265, h.265 default)
● 2：VIDEO_PRESET_HSPEED (只用于h.265)
● 3：VIDEO_PRESET_NORMAL (h264/h.265可用，h.264 default)
ref_frames_co
unt 否 Integer 最大参考帧数。
取值范围：
● H264：[1，8]，默认值为 4 。
● H265：固定值4。
单位：帧。
max_iframes_i
nterval 否 Integer I帧最大间隔
取值范围：[2，10]。
● H264：[0，7]，默认值为 4。
● H265：[0，7]，默认值为 7。
单位：帧。
frame_rate 否 Integer 帧率。
取值范围：0或[5,60]，0表示自
参数 是否必选 参数类型 描述
width 否 Integer 视频宽度（单位：像素）
● H264：范围[32,4096]，必 须为2的倍数
● H265：范围[320,4096]，必 须是4的倍数
height 否 Integer 视频高度（单位：像素）
● H264：范围[32,2880]，必 须为2的倍数
● H265：范围[240,2880] ，必 须是4的倍数
black_cut 否 Integer 黑边剪裁类型
● 0：不开启黑边剪裁
output_policy 否 String 输出策略。
取值如下：
● discard
● transcode 说明
● 同时为"discard"时不合法。
● 同时为“transcode”时，表示 输出音视频。
API 参考 8 媒资转码接口
参数 是否必选 参数类型 描述
codec 是 Integer 音频编码格式。
取值如下：
● 1：AAC格式。
● 2：HEAAC1格式 。
● 3：HEAAC2格式。
● 4：MP3格式 。 sample_rate 是 Integer 音频采样率。
取值如下：
● 1：AUDIO_SAMPLE_AUTO
● 2：AUDIO_SAMPLE_22050
（22050Hz）
● 3：AUDIO_SAMPLE_32000
（32000Hz）
● 4：AUDIO_SAMPLE_44100
（44100Hz）
● 5：AUDIO_SAMPLE_48000
（48000Hz）
● 6：AUDIO_SAMPLE_96000
（96000Hz）
bitrate 否 Integer 音频码率。
取值范围：0或[8,1000]。
单位：kbit/s。
channels 是 Integer 声道数。
取值如下：
● 1：AUDIO_CHANNELS_1
● 2：AUDIO_CHANNELS_2
● 6：AUDIO_CHANNELS_5_1
表8-8 Common
参数 是否必选 参数类型 描述
PVC 是 Boolean 是否开启高清低码功能。
取值如下：
● false：关闭。
● true：开启。
参数 是否必选 参数类型 描述
hls_interval 是 Integer HLS分片间隔，仅封装类型
“pack_type”取值为1或3时，
该参数生效。
取值范围：[2，10]。
单位：秒。
dash_interval 是 Integer DASH间隔，仅封装类型
“pack_type”取值为2或3时，
该参数生效。
取值范围：[2，10]。
单位：秒。
pack_type 是 Integer 封装类型。
取值如下：
● 1：HLS
● 2：DASH
● 3：HLS+DASH
● 4：MP4
● 5：MP3
● 6：ADTS
说明pack_type设置为5和6时，不能设 置视频参数。
表8-9 WatermarkRequest
参数 是否必选 参数类型 描述
input 否 ObsObjInfo
object 源文件地址，如果是图片水印，
则该参数必选。
template_id 否 String 水印模板。可通过新建水印模板 接口创建水印模板。
text_context 否 String 文字水印内容，内容需做 Base64编码，若类型为文字水 印 (type字段为Text)，则此配置 项不能为空
mark 否 ImageWater
mark object 图片水印参数，用于覆盖图片水 印模板中的同名参数。
API 参考 8 媒资转码接口
参数 是否必选 参数类型 描述 text_waterma
rk 否 TextWaterma
rk object 文字水印配置，若设置
“text_context”，则此配置项 不能为空。
表8-10 ImageWatermark
参数 是否必选 参数类型 描述
参数 是否必选 参数类型 描述
referpos 否 String 水印的位置。
取值如下：
● TopRight：右上角。
● TopLeft：左上角。
● BottomRight：右下角。
● BottomLeft：左下角。
timeline_start 否 String 水印开始时间，与
“timeline_duration”配合使
● Original：只做简单缩放，不 做其他处理。
● Grayed：彩色图片变灰。
● Transparent：透明化。
width 否 String 水印图片宽，值有两种形式：
height 否 String 水印图片高，值有两种形式：
● 整数型代表水印图片高的像
参数 是否必选 参数类型 描述
base 否 String 水印叠加母体
取值如下：
● input ：水印叠加在输入片源 上，转码输出后实际大小按 图像等比例缩放
● output ：水印叠加在转码输 出文件上。
表8-11 TextWatermark
参数 是否必选 参数类型 描述
dx 否 String 水印图片起点相对输出视频顶点
的水平偏移量。
设置方法有如下两种：
● 整数型：表示图片起点水平 偏移视频顶点的像素值，单 位px。取值范围：[0，4096]
● 小数型：表示图片起点相对 于视频分辨率宽的水平偏移 比率。取值范围：(0，1)，
支持4位小数，如0.9999，超 出部分系统自动丢弃。
示例：输出视频分辨率宽 1920，设置“dx”为“0.1”，
“referpos”为“TopRight”
（右上角），则水印图片右上角 到视频右顶点在水平方向上偏移 距离为192。
参数 是否必选 参数类型 描述
referpos 否 String 水印的位置。
取值如下：
● TopRight：右上角。
● TopLeft：左上角。
● BottomRight：右下角。
● BottomLeft：左下角。
timeline_start 否 String 水印开始时间，与
“timeline_duration”配合使
font_name 否 String 字体，当前支持fzyouh font_size 否 Integer 字体大小。
取值范围：[4, 120]
font_color 否 String 字体颜色。 目前颜色支持 black，blue，white，green，
red，yellow，brown，gold，
pink，orange，purple。
API 参考 8 媒资转码接口
参数 是否必选 参数类型 描述
base 否 String 水印叠加母体 取值如下：
● input：水印叠加在输入片源 上，转码输出后实际大小按 图像等比例缩放
● output：水印叠加在转码输 出文件上。 默认值：input
表8-12 Thumbnail
参数 是否必选 参数类型 描述
tar 否 Integer 是否压缩抽帧图片生成tar包
● 0：表示压缩
● 1：表示不压缩
out 否 ObsObjInfo
object 截图输出路径，不填写时与转码 输出在一起
params 是 ThumbnailPa
ra object 截图参数。
表8-13 ThumbnailPara
参数 是否必选 参数类型 描述
type 否 String 采样类型。
取值如下：
● "TIME"：根据时间间隔采样 截图。
● "DOTS"：指定时间点截图。
选择同步截图时，需指定此 类型。
默认值："TIME"
time 否 Integer 采样截图的时间间隔值。
默认值：12。
单位：秒
start_time 否 Integer 采样类型为“TIME”模式的开 始时间，和“time”配合使用。
默认值：0。
单位：秒。
参数 是否必选 参数类型 描述
duration 否 Integer 采样类型为“TIME”模式的持 续时间，和“time”、
说明“duration”必须大于等0，若设置 为0，则截图持续时间从
“start_time”到视频结束。
dots 否 Array of
integers 指定时间截图时的时间点数组，
最多支持10个。
format 否 Integer 截图文件格式。
取值如下：
1：表示jpg格式 aspect_ratio 否 Integer 纵横比。
width 否 Integer 图片宽度
取值范围：(96,3840]
单位：px
height 否 Integer 图片高度
取值范围：(96,2160]
单位：px
API 参考 8 媒资转码接口
参数 是否必选 参数类型 描述
max_length 否 Integer 截图最长边的尺寸。宽边尺寸按 照该尺寸与原始视频像素等比缩 放计算。
取值范围：[240,3840]
单位：像素
说明该参数和width/height选择使用，
以width/height优先，若width/
height都不等于0，则图片尺寸按 width/height得出；反之，则图片 尺寸按 max_length 得出。 若该参 数和width/height都未选择，则按 源片源宽高输出截图
表8-14 Subtitle
参数 是否必选 参数类型 描述
input 否 ObsObjInfo
object 字幕文件地址。
inputs 否 Array of MulInputFileI nfo objects
多字幕文件地址。
subtitle_type 否 Integer 字幕类型。取值如下：
● 0，表示不输出字幕
● 1，表示外部字幕文件嵌入视 频流
● 2，表示输出WebVTT格式字 幕
表8-15 MulInputFileInfo
参数 是否必选 参数类型 描述
language 否 String 语言标签。
input 否 ObsObjInfo
object 输入字幕文件地址。
表8-16 Encryption
参数 是否必选 参数类型 描述
hls_encrypt 否 HlsEncrypt
object 视频加密控制参数。
表8-17 HlsEncrypt
参数 是否必选 参数类型 描述
key 是 String 内容加密秘钥
url 是 String 秘钥获取服务的地址
iv 否 String 初始向量，base64binary，随机
数
algorithm 否 String 加密算法。
● AES-128-CTR
● AES-128-CBC
● SM4CBC
默认值：AES-128-CTR
表8-18 Crop
参数 是否必选 参数类型 描述
duration 否 Integer 截取的视频时长。
单位：秒 从0秒开始算起
表8-19 AudioTrack
参数 是否必选 参数类型 描述
type 否 Integer 音轨选取方式。
● 0：默认选取
● 1：手动选择
● 1：手动选择