All Products
Search

This Product

    :CreateLiveTranscodeTemplate

    Document Center

    :CreateLiveTranscodeTemplate

    Last Updated:Mar 30, 2026

    Creates a live stream transcoding template, which can be referenced when submitting a transcoding job.

    Operation description

    Only Shanghai region supports real-time media transcoding.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ice:CreateLiveTranscodeTemplate

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Type

    string

    Yes

    The type of the template. Valid values:

    • normal

    • narrow-band

    • audio-only

    • origin

    normal
    Name

    string

    Yes

    The name of the template.

    my template
    TemplateConfig

    object

    No

    The configuration of the template.

    VideoParams

    object

    No

    The video parameters.

    Codec

    string

    No

    The encoding type. Valid values:

    • H.264

    • H.265

    H.264
    Height

    string

    No

    The height of the output video. Valid values: Height ≥ 128 max (Height,Width) ≤ 2560 min (Height,Width) ≤ 1440

    Note: The resolution of the output video that is transcoded by using the H.265 Narrowband HD transcoding template cannot exceed 1280 × 720 pixels.

    720
    Width

    string

    No

    The width of the output video. Valid values: Width ≥ 128 max (Height,Width) ≤ 2560 min (Height,Width) ≤ 1440

    Note: The resolution of the output video that is transcoded by using the H.265 Narrowband HD transcoding template cannot exceed 1280 × 720 pixels.

    1280
    Fps

    string

    No

    The frame rate of the output video. Unit: frames per second (FPS). Valid values: 1 to 60.

    25
    Bitrate

    string

    No

    The bitrate of the output video. Unit: Kbit/s. Valid values: 1 to 6000.

    2500
    Gop

    string

    No

    The group of pictures (GOP) of the output video. Unit: frame. Valid values: 1 to 3000.

    1000
    Profile

    string

    No

    The encoding profile. The profile determines how a video is encoded. In most cases, a greater value indicates better image quality and higher resource consumption. Valid values: 1: baseline. This value is suitable for mobile devices. 2: main. This value is suitable for standard-definition devices. 3: high. This value is suitable for high-definition devices.

    2
    AudioParams

    object

    No

    The audio parameters.

    Codec

    string

    No

    The audio codec. Valid values:

    • AAC

    • MP3

    AAC
    Bitrate

    string

    No

    The bitrate of the output audio. Unit: Kbit/s. Valid values: 1 to 1000.

    100
    Samplerate

    string

    No

    The audio sampling rate. Valid values: 22050 to 96000.

    Note: If you set AudioProfile to aac_ld, the audio sampling rate cannot exceed 44,100.

    44100
    Channels

    string

    No

    The number of sound channels. Valid values: 1: mono 2: binaural

    2
    Profile

    string

    No

    The audio codec profile. Valid values when the Codec parameter is set to AAC:

    • aac_low

    • aac_he

    • aac_he_v2

    • aac_ld

    aaclow

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    ******3B-0E1A-586A-AC29-742247******
    TemplateId

    string

    The ID of the template.

    ****20b48fb04483915d4f2cd8ac****

    Examples

    Success response

    JSON format

    {
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "TemplateId": "****20b48fb04483915d4f2cd8ac****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParam.Height Invalid Parameters: Height
    400 InvalidParam.Width Invalid Parameters: Width
    400 InvalidParam.Fps Invalid Parameters: Fps
    403 OperationDenied Your account has not enabled the ICE service.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.