Help Center/ Video On Demand/ API Reference/ Transcoding template management/ Queries transcoding templates
Updated on 2024-04-30 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Queries transcoding templates

Function

Queries transcoding templates

URI

GET /v2/{project_id}/asset/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

group_id

No

String

Template ID

is_default

No

Boolean

Whether a default template is used

offset

No

Integer

Offset. The default value is 0. This parameter is invalid when group_id is specified.

limit

No

Integer

Number of records on each page. The value defaults to 10 and ranges from 1 to 100. This parameter is invalid when group_id is specified.

query_string

No

String

Fuzzy search by template name and description. This parameter is invalid when group_id is specified.

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.

It 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 a 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

template_group_list

Array of TransTemplateRsp objects

Template group information.

total

Integer

Total number of records.
Table 5 TransTemplateRsp

Parameter

Type

Description

group_id

String

Template group ID.

name

String

Template group name.

is_default

Boolean

Whether to use the default transcoding template.

type

String

Template group type.

is_auto_encrypt

Boolean

Whether to enable encryption

quality_info_list

Array of QualityInfoList objects

Image quality configuration list.

watermark_template_ids

Array of strings

ID array of the bound watermark template group.

description

String

Template description.

common

CommonInfo object

Low-bitrate HD transcoding switch, low-bitrate HD transcoding version, and multi-stream common parameters.
Table 6 QualityInfoList

Parameter

Type

Description

video

VideoInfo object

Video template information. Configure at least one of the video and audio parameters.

audio

AudioInfo object

Audio template information
Table 7 VideoInfo

Parameter

Type

Description

quality

String

Video quality.

  • The default 4K resolution is 3840 x 2160 and the bitrate is 8000 kbit/s.

  • The default 2K resolution is 2560 x 1440 and the bitrate is 7000 kbit/s.

  • The default FULL_HD resolution is 1920 x 1080 and the bitrate is 3000 kbit/s.

  • The default HD resolution is 1280 x 720 and the bitrate is 1000 kbit/s.

  • The default SD resolution is 854 x 480 and the bitrate is 600 kbit/s.

  • The default FLUENT resolution is 480 x 270 and the bitrate is 300 kbit/s.

width

Integer

Video width.

height

Integer

Video height.

bitrate

Integer

Bitrate, in kbit/s.

frame_rate

Integer

Frame rate (in FPS), which defaults to 0 indicating adaptive frame rate.
Table 8 AudioInfo

Parameter

Type

Description

sample_rate

String

Audio sampling rate. Possible options:

  • AUDIO_SAMPLE_AUTO (default)

  • AUDIO_SAMPLE_22050: 22050 Hz

  • AUDIO_SAMPLE_32000: 32000 Hz

  • AUDIO_SAMPLE_44100: 44100 Hz

  • AUDIO_SAMPLE_48000: 48000 Hz

  • AUDIO_SAMPLE_96000: 96000 Hz

bitrate

Integer

Audio bitrate, in kbit/s.

channels

String

Number of audio channels. Possible options:

  • AUDIO_CHANNELS_1: mono

  • AUDIO_CHANNELS_2: stereo

  • AUDIO_CHANNELS_5_1: 5.1 audio
Table 9 CommonInfo

Parameter

Type

Description

pvc

Boolean

Low-bitrate HD transcoding switch.

video_codec

String

Video encoding format.

audio_codec

String

Audio encoding format.

  • AAC: AAC (default)

  • HEAAC1: HEAAC1

  • HEAAC2: HEAAC2

  • MP3: MP3

is_black_cut

Boolean

Black bar cropping type. The default value is false, indicating that black bar cropping is disabled.

format

String

Format.

hls_interval

Integer

Segment file duration. The value ranges from 2 to 10 (in seconds) and defaults to 5.

upsample

Boolean

Upsampling.

adaptation

String

  • SHORT: Adaptive width

  • LONG: Adaptive height

  • NONE: Adaptive width and height

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

Queries transcoding templates.

GET https://{endpoint}/v2/{project_id}/asset/template/transcodings?group_id={group_id}

Example Responses

Status code: 200

The information is returned when the request succeeded.

{
  "template_group_list" : [ {
    "group_id" : "9751249d25f14587b212544d6fd8dcf8",
    "name" : "non_transcoding_template_group",
    "is_default" : false,
    "type" : "non_transcoding_template_group",
    "is_auto_encrypt" : false,
    "quality_info_list" : [ {
      "video" : {
        "quality" : "UNKNOW",
        "width" : 0,
        "height" : 0,
        "bitrate" : 0,
        "frame_rate" : 0
      },
      "audio" : null
    } ],
    "watermark_template_ids" : null,
    "description" : null,
    "common" : {
      "pvc" : false,
      "is_black_cut" : false,
      "format" : "UNKNOW",
      "upsample" : false,
      "adaptation" : "NONE",
      "video_codec" : null,
      "audio_codec" : "AAC",
      "hls_interval" : 0
    }
  } ],
  "total" : 0
}

Status code: 403

The information is returned when the request failed.

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

Status Codes

Status Code

Description

200

The information is returned when the request succeeded.

403

The information is returned when the request failed.

Error Codes

See Error Codes.