tencent cloud



Last updated: 2022-08-23 16:03:09

1. API Description

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

This API is used to modify a player configuration.

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: ModifySuperPlayerConfig.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required for this API.
Name Yes String Player configuration name.
SubAppId No Integer The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.
AudioVideoType No String Type of audio/video played. Valid values:
  • AdaptiveDynamicStreaming
  • Transcode
  • Original
  • DrmSwitch No String Switch of DRM-protected adaptive bitstream playback:
  • ON: enabled, indicating to play back only output adaptive bitstreams protected by DRM;
  • OFF: disabled, indicating to play back unencrypted output adaptive bitstreams.
  • AdaptiveDynamicStreamingDefinition No Integer ID of the unencrypted adaptive bitrate streaming template that allows output.
    DrmStreamingsInfo No DrmStreamingsInfoForUpdate Content of the DRM-protected adaptive bitrate streaming template that allows output.
    TranscodeDefinition No Integer ID of the transcoding template allowed for playback
    ImageSpriteDefinition No Integer ID of the image sprite generating template that allows output.
    ResolutionNames.N No Array of ResolutionNameInfo Display name of player for substreams with different resolutions.
    Domain No String Domain name used for playback. If its value is Default, the domain name configured in Default Distribution Configuration will be used.
    Scheme No String Scheme used for playback. Valid values:
  • Default: the scheme configured in Default Distribution Configuration will be used;
  • HTTP;
  • HTTPS.
  • Comment No String Template description. Length limit: 256 characters.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying a player configuration

    Input Example

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifySuperPlayerConfig
    <Common request parameters>
        "AdaptiveDynamicStreamingDefinition": "20",
        "Name": "test"

    Output Example

        "Response": {
            "RequestId": "12ae8d8e-dce3-4151-7d4b-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 Code Description
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    ResourceNotFound The resource does not exist.
    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