tencent cloud

Feedback

ModifySuperPlayerConfig

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

    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 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.
    Name Yes String Player configuration name.
    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
  • 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 The player displays names for substreams of 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, 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 Modify SuperPlayer Config

    Modify SuperPlayer Config

    Input Example

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifySuperPlayerConfig
    <Public Request Parameter>
    
    {
        "AdaptiveDynamicStreamingDefinition": "20",
        "Name": "test"
    }
    

    Output Example

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