CreateAdaptiveDynamicStreamingTemplate

Last updated: 2020-08-14 09:40:41

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 Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateAdaptiveDynamicStreamingTemplate.
Version Yes String Common parameter. The value used for this API: 2019-06-12.
Region No String Common parameter. This parameter is not required for this API.
Format Yes String Adaptive bitrate streaming format. Valid values:
  • HLS,
  • MPEG-DASH.
  • StreamInfos.N Yes Array of AdaptiveStreamTemplate Parameter 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.
    Name No String Template name. Length limit: 64 characters.
    DisableHigherVideoBitrate No Integer Whether to prohibit transcoding from low bitrate to high bitrate. Valid values:
  • 0: no,
  • 1: yes.

  • Default value: 0.
    DisableHigherVideoResolution No Integer Whether to prohibit transcoding from low resolution to high resolution. Valid values:
  • 0: no,
  • 1: yes.

  • Default value: 0.
    Comment No String Template description. Length limit: 256 characters.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Unique ID of an adaptive bitrate streaming template.
    RequestId String The 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

    https://mps.tencentcloudapi.com/?Action=CreateAdaptiveDynamicStreamingTemplate
    &Name=Adaptive bitrate streaming template 1
    &Format=HLS
    &StreamInfos.0.Video.Codec=libx264
    &StreamInfos.0.Video.Bitrate=2000
    &StreamInfos.0.Audio.Codec=flac
    &StreamInfos.0.Audio.SampleRate=44100
    &<Common request parameters>

    Output Example

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

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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.InvalidMpsUser Operation failed: unauthorized MPS user.
    InvalidParameter Parameter error.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Bitrate Invalid audio/video bitrate.
    InvalidParameterValue.Codec Invalid audio/video codec.
    InvalidParameterValue.DisableHigherVideoBitrate Invalid switch value used to prohibit transcoding from low bitrate to high bitrate.
    InvalidParameterValue.DisableHigherVideoResolution Invalid switch value used to prohibit transcoding from low resolution to high resolution.
    InvalidParameterValue.FillType Invalid parameter: incorrect fill type.
    InvalidParameterValue.Format Incorrect parameter value: Format.
    InvalidParameterValue.Fps Parameter error: video frame rate.
    InvalidParameterValue.Gop Invalid GOP value.
    InvalidParameterValue.Height Parameter error: height.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.RemoveAudio Incorrect parameter value: RemoveAudio.
    InvalidParameterValue.RemoveVideo Incorrect parameter value: RemoveVideo.
    InvalidParameterValue.SampleRate Invalid audio sample rate.
    InvalidParameterValue.SoundSystem Invalid parameter: incorrect audio channel system.
    InvalidParameterValue.Width Parameter error: Wwdth.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help