查询直播转码模板

功能描述

查询直播转码模板。

请求URI

GET /v1/{project_id}/template/transcodings

请求参数

请求样例

GET https://live.cn-north-1.myhuaweicloud.com/v1/${project_id}/template/transcodings?domain=play.example.com&app_name=live

返回参数

• 直播转码模板查询成功

  表1 查询成功返回参数说明

  参数	类型	说明
  total	integer	查询结果的总模板数量。
  domain	string	播放域名。
  templates	AppQualityInfo[]	转码模板。

  表2 AppQualityInfo参数说明

  参数	类型	说明
  app_name	string	应用名称。
  quality_info	QualityInfo[]	视频质量信息。

  表3 QualityInfo参数说明

  参数	类型	说明
  templateName	-	模板名称。
  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的倍数。
  iFrameInterval	Integer	I帧间隔（单位：帧）。 取值范围：0-500。 默认为25。
  bitrate	integer	转码视频的码率（单位：Kbps）。 取值范围：40-30000。
  video_frame_rate	integer	转码视频帧率（单位：fps）。 取值范围：0-30， 0表示自适应，即保持帧率不变。
  protocol	string	转码输出支持的协议类型。当前只支持RTMP和HLS，且模板组里不同模板的输出协议类型必须相同。 RTMP HLS DASH 默认为RTMP。

• 直播转码模板查询失败

  表4 查询失败返回参数说明

  参数	类型	说明
  error_code	string	错误码。
  error_msg	string	错误描述。

返回样例

• 处理成功返回（返回200 OK）。

  {
      "domain": "play.example.com",
      "total": 1,
      "templates": [
          {
              "app_name": "live",
              "quality_info": [
                  {
                      "templateName": "bb",
                      "quality": "lsd",
                      "PVC": "off",
                      "hdlb": "off",
                      "codec": "H264",
                      "width": 854,
                      "height": 480,
                      "bitrate": 600,
                      "video_frame_rate": 0,
                      "protocol": "HLS",
                      "iFrameInterval": 0
                  }
              ]
          }
      ]
  }
  

• 处理失败返回（其他响应码，如返回400）。

  {
    "error_code": "LIVE100011001",
    "error_msg": "Request Illegal"
  }
  

状态码

状态码请参见状态码。