tencent cloud

Feedback

DescribeAdaptiveDynamicStreamingTemplates

Last updated: 2022-05-09 11:32:21

1. API Description

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

This API is used to query the list of adaptive bitrate streaming templates and supports paginated queries by filters.

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 Params. The value used for this API: DescribeAdaptiveDynamicStreamingTemplates.
Version Yes String Common Params. The value used for this API: 2019-06-12.
Region No String Common Params. This parameter is not required for this API.
Definitions.N No Array of Integer Unique ID filter of adaptive bitrate streaming templates. Array length limit: 100.
Offset No Integer Pagination offset. Default value: 0.
Limit No Integer Number of returned entries. Default value: 10. Maximum value: 100.
Type No String Template type filter. Valid values:
  • Preset: preset template;
  • Custom: custom template.
  • 3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible entries.
    AdaptiveDynamicStreamingTemplateSet Array of AdaptiveDynamicStreamingTemplate List of adaptive bitrate streaming template details.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying a list of adaptive bitrate streaming templates

    Input Example

    https://mps.tencentcloudapi.com/?Action=DescribeAdaptiveDynamicStreamingTemplates
    &Definitions.0=10001
    &<Common request parameters>
    

    Output Example

    {
      "Response": {
        "AdaptiveDynamicStreamingTemplateSet": [
          {
            "Comment": "Adaptive bitrate streaming template 1",
            "Definition": 1001,
            "UpdateTime": "2018-10-01T10:00:00Z",
            "DisableHigherVideoBitrate": 1,
            "Name": "Adaptive bitrate streaming template 1",
            "Format": "HLS",
            "DisableHigherVideoResolution": 1,
            "StreamInfos": [
              {
                "RemoveVideo": 0,
                "Audio": {
                  "Codec": "libfdk_aac",
                  "SampleRate": 44100,
                  "AudioChannel": 2,
                  "Bitrate": 200
                },
                "Video": {
                  "Fps": 25,
                  "Width": 1080,
                  "Height": 960,
                  "Vcrf": 23,
                  "Codec": "libx264",
                  "ResolutionAdaptive": "open",
                  "FillType": "black",
                  "Bitrate": 1000,
                  "Gop": 50
                },
                "RemoveAudio": 0
              }
            ],
            "Type": "Preset",
            "CreateTime": "2018-10-01T10:00:00Z"
          }
        ],
        "TotalCount": 1,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
      }
    }
    

    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.InvalidMpsUser Operation failed: unauthorized MPS user.
    InternalError Internal error.
    InvalidParameterValue.Definitions Parameter error: Definitions.
    InvalidParameterValue.Limit Parameter error: Limit.
    InvalidParameterValue.Type Parameter error: incorrect Type value.
    UnauthorizedOperation Unauthorized operation.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support