Querying Transcoding Templates

Function

This API is used to query transcoding templates.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/template/transcodings

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
domain	Yes	String	Ingest domain name.
app_name	No	String	Application name.
page	No	Integer	Page number,default value: 0
size	No	Integer	Number of records on each page. The value ranges from 1 to 100 The default value is 10.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication.
X-Project-Id	No	String	Project ID. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Number of apps in the query result.
domain	String	Streaming domain name.
templates	Array of AppQualityInfo objects	Transcoding Template

**Table 5** AppQualityInfo
Parameter	Type	Description
app_name	String	Application name.
quality_info	Array of QualityInfo objects	Video quality information.

**Table 6** QualityInfo
Parameter	Type	Description
quality	String	The options are as follows: lud: ultra HD (default name) lhd: HD (default name) lsd: SD (default name) lld: smooth (default name) userdefine: custom video quality. When userdefine is specified, the templateName field cannot be empty.
templateName	String	Customizes a template name. To customize a template name, set quality to userdefine. The name of each custom template must be unique. The name of a custom template cannot be the same as the value of quality of another template. If quality is not set to userdefine, do not set this parameter.
PVC	String	Indicates whether to use narrowband HD transcoding. Note: This field is no longer used. Use hdlb instead. The options are as follows: off: disabled on: enabled Default value: off
hdlb	String	Indicates whether to enable low-bitrate HD. The image quality is better than PVC. Note: When the hdlb field is used to enable low-bitrate HD, the PVC field does not take effect. The options are as follows: off: Low-bitrate HD is disabled. on: Low-bitrate HD is enabled. Default value: off
codec	String	Video encoding format. The options are as follows: H264: H.264 is used. H265: H.265 is used. The default value is H264.
width	Integer	Long side of the video. The landscape is a width, that is, a long side, and the portrait is a height. Unit: pixel. The options are as follows: When codec is set to H264, the recommended value range of width is [32, 3840] and the value must be an integer multiple of 2. When codec is set to H265, the recommended value range of width is [320, 3840] and the value must be an integer multiple of 2. Note: If the input value of both sides is 0, the output video resolution is the same as the source video resolution. If the value of one side is set to 0, the output video resolution will be scaled proportionally according to the input value of the other side. Default value: 0
height	Integer	Short side of the video. The landscape is a width, and the portrait is a height, that is, a short side. Unit: pixel. The options are as follows: When codec is set to H264, the recommended value range of height is [32, 2160] and the value must be an integer multiple of 2. When codec is set to H265, the recommended value range of height is [240, 2160] and the value must be an integer multiple of 2. Note: If the input value of both sides is 0, the output video resolution is the same as the source video resolution. If the value of one side is set to 0, the output video resolution will be scaled proportionally according to the input value of the other side. Default value: 0
bitrate	Integer	Bitrate of the transcoded video. Unit: kbit/s Value range: 40–30,000
video_frame_rate	Integer	Frame rate of the transcoded video. Unit: FPS Value range: 0–60. The value 0 indicates that the frame rate remains unchanged. Default value: 0
protocol	String	Protocol type supported by transcoded outputs. The default value is RTMP. Currently, only RTMP is supported. The options are as follows: RTMP
iFrameInterval	Integer	Maximum I-frame interval. Unit: number of frames Value range: 0–500. Default value: 50. Note: If you want to set the I-frame interval using iFrameInterval, set gop to 0 or do not set gop.
gop	Integer	I-frame interval by time. Unit: second Value range: 0–10. Default value: 2. Note: If gop is not 0, the I-frame interval is set based on gop, and the iFrameInterval field does not take effect.
bitrate_adaptive	String	Adaptive bitrate parameter. The options are as follows: off: Bitrate adaptation is disabled. The target bitrate is output as specified. minimum: The target bitrate is the smaller value between the specified bitrate and the bitrate of the source file. That is, the bitrate does not increase. adaptive: The target bitrate is adaptive to the bitrate of the source file. Default value: off
i_frame_policy	String	Policy for outputting I-frames during encoding. The options are as follows: auto: I-frames are output based on the configured GOP duration. strictSync: The output I-frames are the same as those of the source. If the source contains I-frames, the output I-frames are encoded. If the source does not contain I-frames, the output non-I-frames are encoded. After this parameter is set, the GOP duration is invalid. Default value: auto

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error description

Example Requests

Queries transcoding templates.

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

Example Responses

Status code: 200

Transcoding templates queried successfully.

{
  "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
    } ]
  } ]
}

Status code: 400

Failed to query the transcoding templates.

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

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           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());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["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)

          

        

      
     

      
       
         
         
           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)
    }
}

          

        

      
     