tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSuperPlayerConfigs

Last updated: 2024-03-27 16:09:33

    1. API Description

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

    We have stopped updating this API. Currently, you no longer need a player configuration to use player signatures. For details, see Player Signature.
    This API is used to query player configurations. It supports pagination.

    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: DescribeSuperPlayerConfigs.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Names.N No Array of String Player configuration name filter. Array length limit: 100.
    Offset No Integer Pagination offset. Default value: 0.
    Limit No Integer Number of entries to be returned. Default value: 10. Maximum value: 100.
    Type No String Player configuration type filter. Valid values:
  • Preset: preset configuration;
  • Custom: custom configuration.
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible entries.
    PlayerConfigSet Array of PlayerConfig Player configuration array.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying player configurations

    Input Example

    POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSuperPlayerConfigs
<Common request parameters>

{
    "Names": [
        "test"
    ]
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "PlayerConfigSet": [
            {
                "Name": "test",
                "Type": "Custom",
                "DrmSwitch": "OFF",
                "AdaptiveDynamicStreamingDefinition": 10,
                "ImageSpriteDefinition": 10,
                "ResolutionNameSet": [
                    {
                        "MinEdgeLength": 480,
                        "Name": "SD"
                    },
                    {
                        "MinEdgeLength": 1440,
                        "Name": "2K"
                    }
                ],
                "TranscodeDefinition": 0,
                "AudioVideoType": "AdaptiveDynamicStream",
                "Domain": "xxx.vod2.myqcloud.com",
                "Scheme": "HTTPS",
                "Comment": "",
                "DrmStreamingsInfo": {
                    "FairPlayDefinition": 0,
                    "SimpleAesDefinition": 0,
                    "WidevineDefinition": 0
                },
                "CreateTime": "2019-10-11T10:00:00Z",
                "UpdateTime": "2019-10-11T10:00:00Z"
            }
        ],
        "RequestId": "12ae8d8e-dce3-4151-9d4b-4594145287e1"
    }
}

    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 Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy