查询转码模板组
功能介绍
查询转码模板组列表。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/template_group/transcodings
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
否 |
Array of strings |
转码模板组ID,最多10个 |
group_name |
否 |
Array of strings |
转码模板组名,最多10个 |
page |
否 |
Integer |
分页编号。查询指定“group_id”时,该参数无效。 默认值:0。 |
size |
否 |
Integer |
每页记录数。取值范围:[1,100],指定group_id时该参数无效。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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
参数 |
参数类型 |
描述 |
---|---|---|
template_group_list |
Array of TemplateGroup objects |
模板组信息列表。 |
total |
Integer |
转码模板组总数 |
参数 |
参数类型 |
描述 |
---|---|---|
group_id |
String |
模板组id |
name |
String |
模板组名称 |
template_ids |
Array of integers |
模板组模板ID |
videos |
Array of VideoAndTemplate objects |
视频信息列表 |
audio |
Audio object |
音频信息 |
video_common |
VideoCommon object |
视频通用信息 |
common |
Common object |
通用信息 |
参数 |
参数类型 |
描述 |
---|---|---|
template_id |
Integer |
模板ID |
width |
Integer |
视频宽度(单位:像素)
|
height |
Integer |
视频高度(单位:像素)
|
bitrate |
Integer |
输出平均码率。 取值范围:0或[40,30000]之间的整数。 单位:kbit/s 若设置为0,则输出平均码率为自适应值。 |
stream_name |
String |
流名称 |
参数 |
参数类型 |
描述 |
---|---|---|
output_policy |
String |
输出策略:
取值如下:
|
codec |
Integer |
音频编码格式。 取值如下:
|
sample_rate |
Integer |
音频采样率。 取值如下:
说明:
当编码格式为MP3时,音频采样率取值不为6 |
bitrate |
Integer |
音频码率。 取值范围:0或[8,1000]。 单位:kbit/s。 |
channels |
Integer |
声道数。 取值如下:
当媒体的封装格式是音频格式(MP3)时,声道数不支持设为5.1声道。 |
参数 |
参数类型 |
描述 |
---|---|---|
output_policy |
String |
输出策略:
取值如下:
|
codec |
Integer |
视频编码格式。 取值如下:
|
profile |
Integer |
编码档次,建议设为3。 取值如下:
|
level |
Integer |
编码级别。 取值如下:
|
preset |
Integer |
编码质量等级。 取值如下:
默认值1。 |
max_iframes_interval |
Integer |
I帧最大间隔 取值范围:[2,10]。 默认值:5。 单位:秒。 |
bframes_count |
Integer |
最大B帧间隔。 取值范围:
单位:帧。 |
frame_rate |
Integer |
帧率 取值范围:0或[5,60]之间的整数,0表示自适应 单位:帧每秒 |
black_cut |
Integer |
黑边剪裁类型 取值如下:
|
参数 |
参数类型 |
描述 |
---|---|---|
PVC |
Boolean |
是否开启高清低码功能。 取值如下:
(数字0表示关闭,其余正整数,负数都表示true) |
hls_interval |
Integer |
HLS分片间隔,仅封装类型“pack_type”取值为1或3时,该参数生效。 取值范围:[2,10]。 单位:秒。 |
dash_interval |
Integer |
DASH间隔,仅封装类型“pack_type”取值为2或3时,该参数生效。 取值范围:[2,10]。 单位:秒。 |
pack_type |
Integer |
封装类型。 取值如下:
说明:
pack_type设置为5和6时,不能设置视频参数。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
GET https://{endpoint}/v1/{project_id}/template_group/transcodings?page=0&size=10
响应示例
状态码: 200
查询转码模板组成功。
{ "total" : 1, "template_group_list" : [ { "group_id" : "397565a34913415c91955254add0461a", "name" : "test_templageGroup", "template_ids" : [ 276195 ], "videos" : [ { "template_id" : 276195, "width" : 854, "height" : 480, "bitrate" : 500 } ], "audio" : { "output_policy" : "transcode", "codec" : 1, "bitrate" : 0, "sample_rate" : 1, "channels" : 2 }, "video_common" : { "output_policy" : "transcode", "codec" : 1, "profile" : 3, "level" : 15, "preset" : 3, "max_iframes_interval" : 5, "bframes_count" : 4, "frame_rate" : 0, "black_cut" : 0 }, "common" : { "PVC" : false, "hls_interval" : 5, "dash_interval" : 5, "pack_type" : 4 } } ] }
状态码: 403
查询转码模板组失败。
{ "error_code" : "MPC.10212", "error_msg" : "Operation failed." }
状态码
状态码 |
描述 |
---|---|
200 |
查询转码模板组成功。 |
403 |
查询转码模板组失败。 |
错误码
请参见错误码。