PrevNext
search by keyword

Recent Pages

Documentation
Cloud Streaming Services
    Documentation
    Download PDF

    ModifyLiveTranscodeTemplate

    Last updated: 2022-01-19 14:59:26
    Download PDF

    1. API Description

    Domain name for API request: live.tencentcloudapi.com.

    This API is used to modify the transcoding template configuration.

    A maximum of 200 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
    This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: ModifyLiveTranscodeTemplate.
    Version Yes String Common parameter. The value used for this API: 2018-08-01.
    Region No String Common parameter. This parameter is not required for this API.
    TemplateId Yes Integer Template ID.
    Vcodec No String Video codec. Valid values: h264, h265, origin (default)

    origin: original codec as the output codec
    Acodec No String Audio codec. Defaut value: aac.
    Note: this parameter is unsupported now.
    AudioBitrate No Integer Audio bitrate. Default value: 0.
    Value range: 0-500.
    Description No String Template description.
    VideoBitrate No Integer Video bitrate in Kbps. Value range: 100-8000.
    Note: the transcoding template requires that the bitrate be unique. Therefore, the final saved bitrate may be different from the input bitrate.
    Width No Integer Width in pixels. Value range: 0-3000.
    It must be a multiple of 2. The original width is 0.
    NeedVideo No Integer Whether to keep the video. 0: no; 1: yes. Default value: 1.
    NeedAudio No Integer Whether to keep the audio. 0: no; 1: yes. Default value: 1.
    Height No Integer Height in pixels. Value range: 0-3000.
    It must be a multiple of 2. The original height is 0.
    Fps No Integer Frame rate in fps. Default value: 0.
    Value range: 0-60
    Gop No Integer Keyframe interval in seconds.
    Value range: 2-6
    Rotate No Integer Rotation angle. Default value: 0.
    Valid values: 0, 90, 180, 270
    Profile No String Encoding quality:
    baseline/main/high.
    BitrateToOrig No Integer Whether to use the original bitrate when the set bitrate is larger than the original bitrate.
    0: no, 1: yes
    Default value: 0.
    HeightToOrig No Integer Whether to use the original height when the set height is higher than the original height.
    0: no, 1: yes
    Default value: 0.
    FpsToOrig No Integer Whether to use the original frame rate when the set frame rate is larger than the original frame rate.
    0: no, 1: yes
    Default value: 0.
    AdaptBitratePercent No Float Bitrate compression ratio of top speed codec video.
    Target bitrate of top speed code = VideoBitrate * (1-AdaptBitratePercent)

    Value range: 0.0-0.5.
    ShortEdgeAsHeight No Integer Whether to use the short side as the video height. 0: no, 1: yes. Default value: 0.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Sample request

    Input Example

    https://live.tencentcloudapi.com/?Action=ModifyLiveTranscodeTemplate
&TemplateId=1001
&Vcodec=h265
&Acodec=aac
&AudioBitrate=600
&Description=test
&VideoBitrate=1500
&Width=250
&NeedVideo=1
&NeedAudio=1
&Height=240
&Fps=30
&Gop=3
&Rotate=0
&Profile=main
&BitrateToOrig=0
&HeightToOrig=0
&FpsToOrig=0
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation.AiTranscodeOptionFail Failed to manipulate the AI API.
    FailedOperation.NotFound No records found.
    InternalError Internal error.
    InternalError.ArgsNotMatch For the transcoding template adding API.
    InternalError.ConfInUsed The template is in use.
    InternalError.ConfNotFound The template does not exist.
    InternalError.InvalidInput Parameter check failed.
    InternalError.NotFound The record does not exist.
    InternalError.RuleAlreadyExist The rule has already been configured.
    InternalError.RuleInUsing The rule is in use.
    InternalError.RuleNotFound The rule does not exist.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Parameter missing.
    tencent
    Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy