查询直播转码模板
功能介绍
查询直播转码模板
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/template/transcodings
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain |
是 |
String |
推流域名 |
app_name |
否 |
String |
应用名称 |
page |
否 |
Integer |
分页编号,默认为0。 |
size |
否 |
Integer |
每页记录数。 取值范围:1-100。 默认为10。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
查询结果的总元素数量 |
domain |
String |
播放域名 |
templates |
Array of AppQualityInfo objects |
转码模板 |
参数 |
参数类型 |
描述 |
---|---|---|
templateName |
String |
模板名称。 |
quality |
String |
包含如下取值:
|
PVC |
String |
是否使用窄带高清转码,模板组里不同模板的PVC选项必须相同。
|
hdlb |
String |
是否启用高清低码,较PVC相比画质增强。
|
codec |
String |
视频编码格式,模板组里不同模板的编码格式必须相同。
|
width |
Integer |
视频宽度(单位:像素)
|
height |
Integer |
视频高度(单位:像素)
|
bitrate |
Integer |
转码视频的码率(单位:Kbps)。 取值范围:40-30000。 |
video_frame_rate |
Integer |
转码视频帧率(单位:fps)。 取值范围:0-30,0表示保持帧率不变。 |
protocol |
String |
转码输出支持的协议类型。当前只支持RTMP和HLS,且模板组里不同模板的输出协议类型必须相同。
默认为RTMP。 |
iFrameInterval |
Integer |
I帧间隔(单位:帧)。 取值范围:0-500。 默认为25。 |
gop |
Integer |
按时间设置I帧间隔,与“iFrameInterval”选择一个设置即可。 取值范围:[0,10] 默认值:4 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v1/{project_id}/template/transcodings?domain=play.example.huawei.com&app_name=live&page=0&size=10
响应示例
状态码: 200
直播转码模板查询成功
{ "domain" : "play.example.huawei.com", "total" : 1, "templates" : [ { "app_name" : "live", "quality_info" : [ { "PVC" : "off", "bitrate" : 4500, "codec" : "H264", "height" : 1080, "protocol" : "HLS", "quality" : "SD", "video_frame_rate" : 20, "width" : 1920 }, { "PVC" : "off", "bitrate" : 4500, "codec" : "H264", "height" : 1080, "protocol" : "HLS", "quality" : "HD", "video_frame_rate" : 20, "width" : 1920 } ] } ] }
状态码: 400
直播转码模板查询失败
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" }
状态码
状态码 |
描述 |
---|---|
200 |
直播转码模板查询成功 |
400 |
直播转码模板查询失败 |
错误码
请参见错误码。
