6.3 更新转码模板组 6.4 删除转码模板组
6.1 新建转码模板组
功能介绍
新建转码模板组,最多支持一进六出。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/{project_id}/template_group/transcodings 表6-1 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID,获取方法请参考获取项 目ID
API 参考 6 自定义转码模板组接口
请求参数
表6-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方式认证时必选,请 求的发生时间。
表6-3 请求 Body 参数
参数 是否必选 参数类型 描述
name 否 String 模板组名称
videos 否 Array of VideoObj objects
视频信息列表
audio 否 Audio object 音频信息 video_commo
n 否 VideoCommo
n object 视频通用信息
common 否 Common
object 通用信息
表6-4 VideoObj
参数 是否必选 参数类型 描述
width 是 Integer 视频宽度(单位:像素)
● H264:范围[32,4096],必 须为2的倍数
● H265:范围[320,4096],必 须是4的倍数
参数 是否必选 参数类型 描述
height 是 Integer 视频高度(单位:像素)
● H264:范围[32,2880],必 须为2的倍数
● H265:范围[240,2880],必 须是4的倍数
bitrate 是 Integer 输出平均码率。
取值范围:0或[40,30000]之间
output_policy 否 String 输出策略。
取值如下:
● discard
● transcode 说明
● 同时为"discard"时不合法。
● 同时为“transcode”时,表示 输出音视频。
codec 是 Integer 音频编码格式。
取值如下:
● 1:AAC格式。
● 2:HEAAC1格式 。
● 3:HEAAC2格式。
● 4:MP3格式 。
API 参考 6 自定义转码模板组接口
参数 是否必选 参数类型 描述
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
表6-6 VideoCommon
参数 是否必选 参数类型 描述
output_policy 否 String 输出策略。
取值如下:
● discard
● transcode 说明
● 同时为"discard"时不合法。
● 同时为“transcode”时,表示 输出音视频。
codec 否 Integer 视频编码格式。
取值如下:
● 1:表示H.264。
● 2:表示H.265。
profile 否 Integer 编码档次,建议设为3。
取值如下:
● 1:VIDEO_PROFILE_H264_BAS E
● 2:VIDEO_PROFILE_H264_MAI N
● 3:VIDEO_PROFILE_H264_HIG H
● 4:VIDEO_PROFILE_H265_MAI N
API 参考 6 自定义转码模板组接口
参数 是否必选 参数类型 描述
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
说明
● H264:[1,8],默认值为 4 。
● H265:固定值4。
单位:帧。
max_iframes_i
nterval 否 Integer I帧最大间隔
取值范围:[2,10]。
默认值:5。
单位:秒。
参数 是否必选 参数类型 描述 bframes_coun
t 否 Integer 最大B帧间隔。
取值范围:
● H264:[0,7],默认值为 4。
● H265:[0,7],默认值为 7。
单位:帧。
frame_rate 否 Integer 帧率
取值范围:0或[5,60]之间的整 数,0表示自适应
单位:帧每秒
aspect_ratio 否 Integer 纵横比,图像缩放方式 black_cut 否 Integer 黑边剪裁类型
取值如下:
hls_interval 是 Integer HLS分片间隔,仅封装类型
“pack_type”取值为1或3时,
该参数生效。
取值范围:[2,10]。
单位:秒。
dash_interval 是 Integer DASH间隔,仅封装类型
“pack_type”取值为2或3时,
该参数生效。
取值范围:[2,10]。
单位:秒。
API 参考 6 自定义转码模板组接口
参数 是否必选 参数类型 描述 pack_type 是 Integer 封装类型。
取值如下:
● 1:HLS
● 2:DASH
● 3:HLS+DASH
● 4:MP4
● 5:MP3
● 6:ADTS
说明pack_type设置为5和6时,不能设 置视频参数。
up TemplateGro
up object 模板组信息。
表6-9 TemplateGroup
参数 参数类型 描述
group_id String 模板组id
name String 模板组名称
template_ids Array of
integers 模板组模板ID videos Array of
VideoAndTe mplate objects
视频信息列表
audio Audio object 音频信息 video_commo
n VideoCommo
n object 视频通用信息
common Common
object 通用信息
表6-10 VideoAndTemplate
参数 参数类型 描述
template_id Integer 模板ID
width Integer 视频宽度(单位:像素)
● H264:范围[32,4096],必须为2的倍数
● H265:范围[320,4096],必须是4的倍数 height Integer 视频高度(单位:像素)
● H264:范围[32,2880],必须为2的倍数
● H265:范围[240,2880],必须是4的倍数 bitrate Integer 输出平均码率。
取值范围:0或[40,30000]之间的整数。
单位:kbit/s
若设置为0,则输出平均码率为自适应值。
表6-11 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格式 。
API 参考 6 自定义转码模板组接口
参数 参数类型 描述
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
表6-12 VideoCommon
参数 参数类型 描述
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。
参数 参数类型 描述
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],默认值为4 。
● H265:固定值4。
单位:帧。
API 参考 6 自定义转码模板组接口
参数 参数类型 描述 max_iframes_i
nterval Integer I帧最大间隔
取值范围:[2,10]。
默认值:5。
单位:秒。
bframes_coun
t Integer 最大B帧间隔。
取值范围:
● H264:[0,7],默认值为4。
● H265:[0,7],默认值为7。
单位:帧。
frame_rate Integer 帧率
取值范围:0或[5,60]之间的整数,0表示自适应 单位:帧每秒
aspect_ratio Integer 纵横比,图像缩放方式 black_cut Integer 黑边剪裁类型
取值如下:
表6-13 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时,不能设置视频参数。
状态码: 400
表6-14 响应 Body 参数
参数 参数类型 描述
error_code String 错误码。
error_msg String 错误描述。
请求示例
```POST https://{endpoint}/v1/{project_id}/template_group/transcodings { "name" : "my_templateGroup",
"videos" : [{
"pack_type" : 1,
{ "template_group" : {
"group_id" : "f7fc420b17db414fb11652671581bb6d", "name" : "my_templateGroup",
"template_ids" : [ 286548 ],
"output_policy" : "transcode", "codec" : 1,
"output_policy" : "transcode", "codec" : 1,
{ "error_code" : "MPC.10202",
"error_msg" : "Invalid request parameter."
}
状态码
状态码 描述
201 新建转码模板组成功。
400 新建转码模板组失败。
错误码
请参见错误码。