LiveLive

Compute
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
Domain Name Service
VPC Endpoint
Cloud Connect
Enterprise Switch
Security & Compliance
Anti-DDoS
Web Application Firewall
Host Security Service
Data Encryption Workshop
Database Security Service
Advanced Anti-DDoS
Data Security Center
Container Guard Service
Situation Awareness
Managed Threat Detection
Compass
Cloud Certificate Manager
Anti-DDoS Service
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GaussDB NoSQL
GaussDB(for MySQL)
Distributed Database Middleware
GaussDB(for openGauss)
Developer Services
ServiceStage
Distributed Cache Service
Simple Message Notification
Application Performance Management
Application Operations Management
Blockchain
API Gateway
Cloud Performance Test Service
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
DevCloud
ProjectMan
CodeHub
CloudRelease
CloudPipeline
CloudBuild
CloudDeploy
Cloud Communications
Message & SMS
Cloud Ecosystem
Marketplace
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP License Service
Support Plans
Customer Operation Capabilities
Partner Support Plans
Professional Services
enterprise-collaboration
Meeting
IoT
IoT
Intelligent EdgeFabric
DeveloperTools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Help Center> Live> API Reference> Transcoding Template Management> Creating a Transcoding Template
Updated at: Apr 13, 2022 GMT+08:00

Creating a Transcoding Template

Function

This API is used to create a transcoding template.

URI

POST /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 a project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Ingest domain name.

app_name

Yes

String

Application name.

quality_info

Yes

Array of QualityInfo objects

Video quality information.

Table 4 QualityInfo

Parameter

Mandatory

Type

Description

templateName

No

String

Template name

quality

Yes

String

Possible values are: - FHD - HD - SD - LD - XXX: custom name. XXX must be different from the default name. Custom names must be different.

PVC

No

String

Whether to enable low bitrate HD. PVC in different templates in a template group must be the same. - on: enabled - off: disabled

Default value: off

hdlb

No

String

Whether to enable image enhancement - on: enabled - off: disabled

Default value: off

codec

No

String

Video codec. codec in different templates in a template group must be the same. Possible values are: - H.264 - H.265

The default value is H.264.

width

Yes

Integer

Video width (unit: pixel) - H.264 Value range: 32–3,840. The value must be a multiple of 2. - H.265 Value range: 320–3,840. The value must be a multiple of 4.

height

Yes

Integer

Video height (unit: pixel) - H.264 Value range: 32–2,160. The value must be a multiple of 2. - H.265 Value range: 240–2,160. The value must be a multiple of 4.

bitrate

Yes

Integer

Bitrate of a transcoded video, in kbit/s

Value range: 40–30,000

video_frame_rate

No

Integer

Frame rate of the transcoded video, in fps.

The value ranges from 0 to 30. Value 0 indicates that the frame rate remains unchanged.

protocol

No

String

Output format. RTMP and HLS are supported. protocol in different templates in a template group must be the same. - RTMP - HLS - DASH

The default value is RTMP.

iFrameInterval

No

Integer

I-frame interval (unit: frame)

Value range: 0–500

Default value: 25

gop

No

Integer

I-frame interval set by time

Value range: 0–10

Default value: 4

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

POST https://{endpoint}/v1/{project_id}/template/transcodings

{
  "domain" : "play.example.huawei.com",
  "app_name" : "live",
  "quality_info" : [ {
    "quality" : "SD",
    "PVC" : "off",
    "codec" : "H264",
    "width" : 1920,
    "height" : 1080,
    "bitrate" : 4500,
    "video_frame_rate" : 20,
    "protocol" : "HLS"
  } ]
}

Example Responses

Status code: 400

Failed to create a transcoding template.

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

Status Codes

Status Code

Description

201

Transcoding template created successfully.

400

Failed to create a transcoding template.

Error Codes

See Error Codes.

Did you find this page helpful?

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel