查询直播转码模板
功能描述
查询直播转码模板
请求URL
GET /v1/{project_id}/template/transcodings
请求参数
参数 |
位置 |
类型 |
说明 |
缺省值 |
必选项 |
|---|---|---|---|---|---|
project_id |
path |
string |
项目ID |
N/A |
是 |
domain |
query |
string |
播放域名 |
N/A |
是 |
app_name |
query |
string |
应用名称 |
N/A |
否 |
page |
query |
integer |
分页编号 |
0 |
否 |
size |
query |
integer |
每页记录数，取值范围1,100 |
10 |
否 |
请求样例
GET https://live.hwcloud.com/v1/${project_id}/template/transcodings?domain=xxx&app_name=xxx
返回参数
直播转码模板查询成功
参数 |
类型 |
说明 |
缺省值 |
必选项 |
|---|---|---|---|---|
total |
integer |
查询结果的总元素数量 |
N/A |
是 |
domain |
string |
播放域名 |
N/A |
是 |
templates |
AppQualityInfo[] |
转码模板 |
N/A |
是 |
AppQualityInfo结构定义：
参数 |
类型 |
说明 |
缺省值 |
必选项 |
|---|---|---|---|---|
app_name |
string |
应用名称 |
N/A |
否 |
quality_info |
QualityInfo[] |
视频质量信息 |
N/A |
否 |
QualityInfo结构定义：
参数 |
类型 |
说明 |
缺省值 |
必选项 |
|---|---|---|---|---|
quality |
string |
包含如下取值， FHD //超高清，系统缺省名称 HD //高清，系统缺省名称 SD //标清，系统缺省名称 LD //流畅，系统缺省名称 XXX //租户自定义名称。用户自定义名称不能与系统缺省名称冲突；多个自定义名称不能重复 |
N/A |
是 |
PVC |
string |
是否使用窄带高清转码，模板组里不同模板的PVC选项必须相同。
|
on |
否 |
codec |
string |
视频编码格式，模板组里不同模板的编码格式必须相同。
|
H264 |
否 |
width |
integer |
视频宽度（单位：像素） H264：范围32,3840，必须为2的倍数 H265：范围320,3840 ,必须是4的倍数 |
N/A |
是 |
height |
integer |
视频高度（单位：像素） H264：范围32,2160,必须为2的倍数 H265：范围240,2160 ,必须是4的倍数 |
N/A |
是 |
bitrate |
integer |
输出平均码率（单位：Kbps）有效值范围40,30000 |
N/A |
是 |
video_frame_rate |
integer |
转码视频帧率。单位：fps。取值范围：0, 30， 0表示自适应，即保持帧率不变 |
N/A |
是 |
protocol |
string |
转码输出支持的协议类型。当前只支持RTMP和HLS，且模板组里不同模板的输出协议类型必须相同。
|
RTMP |
否 |
直播转码模板查询失败
参数 |
类型 |
说明 |
缺省值 |
必选项 |
|---|---|---|---|---|
error_code |
string |
错误码 |
N/A |
是 |
error_msg |
string |
错误描述 |
N/A |
是 |
返回样例
处理成功返回（返回200）
{ "domain": "play.example.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": "LIVE100011001", "error_msg": "Request Illegal" }
