文档首页 > > API参考> 转码模板管理>

查询直播转码模板

查看PDF
编辑

查询直播转码模板

分享
更新时间：2021/03/05 GMT+08:00

功能介绍

查询直播转码模板

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/template/transcodings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

domain

是

String

播放域名

app_name

否

String

应用名称

page

否

Integer

分页编号，默认为0。

size

否

Integer

每页记录数。

取值范围：1-100。

默认为10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

查询结果的总元素数量

domain

String

播放域名

templates

Array of AppQualityInfo objects

转码模板
表5 AppQualityInfo

参数

参数类型

描述

app_name

String

应用名称

quality_info

Array of QualityInfo objects

视频质量信息
表6 QualityInfo

参数

参数类型

描述

templateName

String

模板名称。

quality

String

包含如下取值：

  • FHD： 超高清，系统缺省名称

  • HD： 高清，系统缺省名称

  • SD： 标清，系统缺省名称

  • LD： 流畅，系统缺省名称

  • XXX： 租户自定义名称。用户自定义名称不能与系统缺省名称冲突；多个自定义名称不能重复

PVC

String

是否使用窄带高清转码，模板组里不同模板的PVC选项必须相同。

  • on：启用。

  • off：不启用。 默认为off

hdlb

String

是否启用高清低码，较PVC相比画质增强。

  • on：启用。

  • off：不启用。 默认为off。

codec

String

视频编码格式，模板组里不同模板的编码格式必须相同。

  • H264：使用H.264。

  • H265：使用H.265。 默认为H264。

width

Integer

视频宽度（单位：像素）

  • H264 取值范围：32-3840，必须为2的倍数 。

  • H265 取值范围：320-3840 ，必须为4的倍数。

height

Integer

视频高度（单位：像素）

  • H264 取值范围：32-2160，必须为2的倍数。

  • H265 取值范围：240-2160，必须为4的倍数。

bitrate

Integer

转码视频的码率（单位：Kbps）。 取值范围：40-30000。

video_frame_rate

Integer

转码视频帧率（单位：fps）。 取值范围：0-30，0表示保持帧率不变。

protocol

String

转码输出支持的协议类型。当前只支持RTMP和HLS，且模板组里不同模板的输出协议类型必须相同。

  • RTMP

  • HLS

  • DASH

默认为RTMP。

iFrameInterval

Integer

I帧间隔（单位：帧）。

取值范围：0-500。

默认为25。

gop

Integer

按时间设置I帧间隔，与“iFrameInterval”选择一个设置即可。

取值范围：[0,10]

默认值：4

状态码： 400

表7 响应Body参数

参数

参数类型

描述

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

直播转码模板查询失败

错误码

请参见错误码。

父主题： 转码模板管理
分享：

    相关文档

    相关产品