tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateSuperPlayerConfig

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

    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 create a player configuration. Up to 100 configurations 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 Params. The value used for this API: CreateSuperPlayerConfig.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    Name Yes String Player configuration name, which can contain up to 64 letters, digits, underscores, and hyphens (such as test_ABC-123) and must be unique under a user.
    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.
    AudioVideoType No String Type of audio/video played. Valid values:
  • AdaptiveDynamicStreaming
  • Transcode
  • Original

    • Default value: AdaptiveDynamicStream
    DrmSwitch No String Whether to allow only adaptive bitrate streaming playback protected by DRM. Valid values:
  • ON: allow only adaptive bitrate streaming playback protected by DRM
  • OFF: allow adaptive bitrate streaming playback not protected by DRM

    • Default value: OFF
    This parameter is valid when AudioVideoType is AdaptiveDynamicStream.
    AdaptiveDynamicStreamingDefinition No Integer ID of the adaptive bitrate streaming template allowed for playback not protected by DRM.

    This parameter is required if AudioVideoType is AdaptiveDynamicStream and DrmSwitch is OFF.
    DrmStreamingsInfo No DrmStreamingsInfo Content of the adaptive bitrate streaming template allowed for playback protected by DRM.

    This parameter is required if AudioVideoType is AdaptiveDynamicStream and DrmSwitch is ON.
    TranscodeDefinition No Integer ID of the transcoding template allowed for playback

    This parameter is required if AudioVideoType is Transcode.
    ImageSpriteDefinition No Integer ID of the image sprite generating template that allows output.
    ResolutionNames.N No Array of ResolutionNameInfo The player displays names for substreams of different resolutions. If left unfilled or filled in a blank array, the default configuration is used:
  • MinEdgeLength: 240, Name: smooth;
  • MinEdgeLength: 480, Name: SD;
  • MinEdgeLength: 720, Name: HD;
  • MinEdgeLength: 1080, Name: Full HD;
  • MinEdgeLength: 1440, Name: 2K;
  • MinEdgeLength: 2160, Name: 4K;
  • MinEdgeLength: 4320, Name: 8K.
    • Domain No String Domain name used for playback. If it is left empty or set to Default, the domain name configured in Default Distribution Configuration will be used.
    Scheme No String Scheme used for playback. If it is left empty or set to Default, the scheme configured in Default Distribution Configuration will be used. Other valid values:
  • HTTP;
  • HTTPS.
    		•
    Comment No String Template description. Length limit: 256 characters.

    3. Output Parameters

    Parameter Name Type Description
    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 CreateSuperPlayerConfig

    CreateSuperPlayerConfig

    Input Example

    POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSuperPlayerConfig
<Public Request Parameter>

{
    "AdaptiveDynamicStreamingDefinition": "10",
    "Name": "test"
}

    Output Example

    {
    "Response": {
        "RequestId": "12ae8d8e-dce3-4151-1d4b-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 Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    LimitExceeded Quota limit is exceeded.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy