功能介绍
查询用户自定义转码配置模板。 支持指定模板ID查询,或分页全量查询。转码配置模 板ID,最多10个。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/template/transcodings
表5-20 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID,获取方法请参考获取项 目ID
表5-21 Query 参数
参数 是否必选 参数类型 描述
template_id 否 Array 自定义转码模板ID,最多10个
page 否 Integer 分页编号。查询指定
“task_id”时,该参数无效。
默认值:0。
size 否 Integer 每页记录数。取值范围:
[1,100],指定template_id时该 参数无效
请求参数
表5-22 请求 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方式认证时必选,请 求的发生时间。
响应参数
状态码: 200
表5-23 响应 Body 参数
参数 参数类型 描述
template_arra
y Array of TemplateInfo objects
转码模板
total Integer 转码模板总数
表5-24 TemplateInfo
参数 参数类型 描述
template_id Integer 转码模板ID。
template QueryTransT emplate object
转码模板信息。
API 参考 5 自定义转码模板接口
表5-25 QueryTransTemplate
参数 参数类型 描述
template_na
me String 转码模板名称。
video Video object 视频信息。
audio Audio object 音频信息。
common Common
object 通用信息。
表5-26 Video
参数 参数类型 描述
output_policy String 输出策略。
取值如下:
● discard
● transcode 说明
● 当视频参数中的“output_policy”为"discard",且 音频参数中的“output_policy”为“transcode”
时,表示只输出音频。
● 当视频参数中的“output_policy”为"transcode",
且音频参数中的“output_policy”为“discard”
时,表示只输出视频。
● 同时为"discard"时不合法。
● 同时为“transcode”时,表示输出音视频。
codec Integer 视频编码格式。
取值如下:
● 1:表示H.264。
● 2:表示H.265。
bitrate Integer 输出平均码率。
取值范围:0或[40,30000]之间的整数。
单位:kbit/s
若设置为0,则输出平均码率为自适应值。
profile Integer 编码档次,建议设为3。
取值如下:
● 1:VIDEO_PROFILE_H264_BASE
● 2:VIDEO_PROFILE_H264_MAIN
● 3:VIDEO_PROFILE_H264_HIGH
● 4:VIDEO_PROFILE_H265_MAIN
参数 参数类型 描述 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 preset Integer 编码质量等级。
取值如下:
● 1:VIDEO_PRESET_HSPEED2
● 2:VIDEO_PRESET_HSPEED
● 3:VIDEO_PRESET_NORMAL 说明
值越大,表示编码的质量越高,转码耗时也越长。
ref_frames_co
unt Integer 最大参考帧数。
取值范围:
● H264:[1,8]
● H265:固定值4 单位:帧。
max_iframes_i
nterval Integer I帧最大间隔
取值范围:[2,10]。
默认值:5。
单位:秒。
API 参考 5 自定义转码模板接口
参数 参数类型 描述 bframes_coun
t Integer 最大B帧间隔。
取值范围:
● H264:[0,7],默认值为4。
● H265:[0,7],默认值为7。
单位:帧。
frame_rate Integer 帧率。
取值范围:0或[5,60]之间的整数。
单位:帧每秒。
说明若设置的帧率不在取值范围内,则自动调整为0,若设
置的帧率高于片源帧率,则自动调整为片源帧率。
width Integer 视频宽度。
取值范围:
● H.264:0或[32,4096]间2的倍数。
● H.265:0或[160,4096]间4的倍数。
单位:像素。
说明:若视频宽度设置为0,则视频宽度值自适 应。
height Integer 视频高度。
● H.264:0或[32,2880]且必须为2的倍数。
● H.265:0或[96,2880]且必须为4的倍数。
单位:像素。
说明:若视频高度设置为0,则视频高度值自适 应。
black_cut Integer 黑边剪裁类型。
取值如下:
● 0:不开启黑边剪裁。
● 1:开启黑边剪裁,低复杂度算法,针对长视 频(>5分钟)。
● 2:开启黑边剪裁,高复杂度算法,针对短视 频(<=5分钟)。
表5-27 Audio
参数 参数类型 描述
output_policy String 输出策略。
取值如下:
● discard
● transcode 说明
● 当视频参数中的“output_policy”为"discard",且 音频参数中的“output_policy”为“transcode”
时,表示只输出音频。
● 当视频参数中的“output_policy”为"transcode",
且音频参数中的“output_policy”为“discard”
时,表示只输出视频。
● 同时为"discard"时不合法。
● 同时为“transcode”时,表示输出音视频。
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
API 参考 5 自定义转码模板接口
表5-28 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时,不能设置视频参数。
状态码: 403
表5-29 响应 Body 参数
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误描述。
请求示例
GET https://{endpoint}/v1/{project_id}/templates/transcoding?template_id=80985
响应示例
状态码: 200
查询转码模板成功。
{ "template_array" : [ { "template_id" : 80985, "template" : {
"template_name" : "test_template",
"tenant_id" : "05aad1833a000f042fd6c001abb9824b", "video" : {
{ "error_code" : "MPC.10212", "error_msg" : "Operation failed."
}
错误码
请参见错误码。
6 自定义转码模板组接口
6.1 新建转码模板组