1. API Description

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

This API is used to create an adaptive bitrate streaming template. Up up to 100 such templates can be created.

A maximum of 20 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.

Parameter NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: CreateAdaptiveDynamicStreamingTemplate.
VersionYesStringCommon Params. The value used for this API: 2019-06-12.
RegionNoStringCommon Params. This parameter is not required for this API.
FormatYesStringAdaptive bitrate streaming format. Valid values:
  • HLS,
  • StreamInfos.NYesArray of AdaptiveStreamTemplateParameter information of output substreams for transcoding to adaptive bitrate streaming. Up to 10 substreams can be output.
    Note: the frame rate of each substream must be consistent; otherwise, the frame rate of the first substream is used as the output frame rate.
    NameNoStringTemplate name. Length limit: 64 characters.
    DisableHigherVideoBitrateNoIntegerWhether to prohibit transcoding from low bitrate to high bitrate. Valid values:
  • 0: no,
  • 1: yes.

  • Default value: 0.
    DisableHigherVideoResolutionNoIntegerWhether to prohibit transcoding from low resolution to high resolution. Valid values:
  • 0: no,
  • 1: yes.

  • Default value: 0.
    CommentNoStringTemplate description. Length limit: 256 characters.

    3. Output Parameters

    Parameter NameTypeDescription
    DefinitionIntegerUnique ID of an adaptive bitrate streaming template.
    RequestIdStringThe unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating an adaptive bitrate streaming template

    Input Example

    &Name=Adaptive bitrate streaming template 1
    &<Common request parameters>

    Output Example

        "Response": {
            "Definition": 30018,
            "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"

    5. Developer Resources


    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 CodeDescription
    FailedOperation.InvalidMpsUserOperation failed: unauthorized MPS user.
    InvalidParameterParameter error.
    InvalidParameterValueIncorrect parameter value.
    InvalidParameterValue.BitrateInvalid audio/video bitrate.
    InvalidParameterValue.CodecInvalid audio/video codec.
    InvalidParameterValue.DisableHigherVideoBitrateInvalid switch value used to prohibit transcoding from low bitrate to high bitrate.
    InvalidParameterValue.DisableHigherVideoResolutionInvalid switch value used to prohibit transcoding from low resolution to high resolution.
    InvalidParameterValue.FillTypeInvalid parameter: incorrect fill type.
    InvalidParameterValue.FormatIncorrect parameter value: Format.
    InvalidParameterValue.FpsParameter error: video frame rate.
    InvalidParameterValue.GopInvalid GOP value.
    InvalidParameterValue.HeightParameter error: height.
    InvalidParameterValue.NameIncorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.RemoveAudioIncorrect parameter value: RemoveAudio.
    InvalidParameterValue.RemoveVideoIncorrect parameter value: RemoveVideo.
    InvalidParameterValue.SampleRateInvalid audio sample rate.
    InvalidParameterValue.SoundSystemInvalid parameter: incorrect audio channel system.
    InvalidParameterValue.WidthParameter error: Wwdth.
    LimitExceeded.TooMuchTemplateLimit reached: the number of templates exceeds the limit.