更新时间:2024-04-11 GMT+08:00
分享

查询直播转码模板

功能介绍

查询直播转码模板

调用方法

请参见如何调用API

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的值)。

Authorization

String

使用AK/SK方式认证时必填,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必填,请求的发生时间。

X-Project-Id

String

使用AK/SK方式认证时必填,携带项目ID信息。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

查询结果的app数量

domain

String

播放域名

templates

Array of AppQualityInfo objects

转码模板

表5 AppQualityInfo

参数

参数类型

描述

app_name

String

应用名称

quality_info

Array of QualityInfo objects

视频质量信息

表6 QualityInfo

参数

参数类型

描述

quality

String

包含如下取值:

  • lud:超高清,系统缺省名称。

  • lhd:高清,系统缺省名称。

  • lsd:标清,系统缺省名称。

  • lld:流畅,系统缺省名称。

  • userdefine:视频质量自定义。填写userdefine时,templateName字段不能为空。

templateName

String

自定义模板名称。

  • 若需要自定义模板名称,请将quality参数设置为userdefine。

  • 多个自定义模板名称之间不能重复。

  • 自定义模板名称不能与其他模板的quality参数重复。

  • 若quality不为userdefine,请勿填写此字段。

PVC

String

是否使用窄带高清转码。

注意:该字段已不再维护,建议使用hdlb。

包含如下取值:

  • off:不启用。

  • on:启用。

默认值:off。

hdlb

String

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

提示:使用hdlb字段开启高清低码时,PVC字段不生效。

包含如下取值:

  • off:不开启高清低码。

  • on:开启高清低码。

默认值:off。

codec

String

视频编码格式。

包含如下取值:

  • H264:使用H.264。

  • H265:使用H.265。

默认为H264。

width

Integer

视频的长边。其中,横屏为宽,即长边,竖屏为高。单位:像素。 包含如下取值:

  • codec的取值为H264时,width建议取值范围为[32,3840],且必须为2整数倍。

  • codec的取值为H265时,width建议取值范围为[320,3840],且必须为2的整数倍。

注意:width和height全为0时,输出的分辨率和源保持一致;width和height只有一个为0时,输出的分辨率按非0项的比例进行缩放。

默认值:0。

height

Integer

视频的短边。其中,横屏为宽,竖屏为高,即短边。单位:像素。 包含如下取值:

  • codec的取值为H264时,height建议取值范围为[32,2160],且必须为2的整数倍。

  • codec的取值为H265时,height建议取值范围为[240,2160],且必须为2的整数倍。

注意:width和height全为0时,输出的分辨率和源保持一致;width和height只有一个为0时,输出的分辨率按非0项的比例进行缩放。

默认值:0。

bitrate

Integer

转码视频的码率。

单位:Kbps

取值范围:40-30000。

video_frame_rate

Integer

转码视频帧率。

单位:fps

取值范围:0-60,0表示保持帧率不变。

默认值:0。

protocol

String

转码输出支持的协议类型。默认为RTMP。当前只支持RTMP。

包含如下取值:

  • RTMP

iFrameInterval

Integer

最大I帧间隔。

单位:帧数

取值范围:[0, 500],默认值:50。

注意:若希望通过iFrameInterval设置i帧间隔,请将gop设为0,或不传gop参数。

gop

Integer

按时间设置I帧间隔。

单位:秒

取值范围:[0,10],默认值:2。

注意:gop不为0时,则以gop设置i帧间隔,iFrameInterval字段不生效。

bitrate_adaptive

String

自适应码率参数。

包含如下取值:

  • off:关闭码率自适应,目标码率按设定的码率输出。

  • minimum:目标码率按设定码率和源文件码率最小值输出(即码率不上扬)。

  • adaptive:目标码率按源文件码率自适应输出。

默认值:off。

i_frame_policy

String

编码输出I帧策略。

包含如下取值:

  • auto:I帧按设置的gop时长输出。

  • strictSync:编码输出I帧完全和源保持一致(源是I帧则编码输出I帧,源不是I帧则编码非I帧),设置该参数后gop时长设置无效。

默认值:auto。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询直播转码模板。

GET https://{endpoint}/v1/{project_id}/template/transcodings?domain=play.example.com&app_name=live&page=0&size=10

响应示例

状态码: 200

直播转码模板查询成功

{
  "domain" : "play.example.com",
  "total" : 1,
  "templates" : [ {
    "app_name" : "live",
    "quality_info" : [ {
      "quality" : "lsd",
      "hdlb" : "off",
      "codec" : "H264",
      "width" : 1920,
      "height" : 1080,
      "bitrate" : 4500,
      "video_frame_rate" : 20,
      "gop" : 4
    }, {
      "quality" : "userdefine",
      "templateName" : "yourTemplateName",
      "hdlb" : "off",
      "codec" : "H264",
      "width" : 1920,
      "height" : 1080,
      "bitrate" : 4500,
      "video_frame_rate" : 20,
      "gop" : 4
    } ]
  } ]
}

状态码: 400

直播转码模板查询失败

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.live.v1.region.LiveRegion;
import com.huaweicloud.sdk.live.v1.*;
import com.huaweicloud.sdk.live.v1.model.*;


public class ShowTranscodingsTemplateSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowTranscodingsTemplateRequest request = new ShowTranscodingsTemplateRequest();
        try {
            ShowTranscodingsTemplateResponse response = client.showTranscodingsTemplate(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklive.v1.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId) \

    client = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowTranscodingsTemplateRequest()
        response = client.show_transcodings_template(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := live.NewLiveClient(
        live.LiveClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowTranscodingsTemplateRequest{}
	response, err := client.ShowTranscodingsTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

直播转码模板查询成功

400

直播转码模板查询失败

错误码

请参见错误码

分享:

    相关文档

    相关产品