CreateSuperPlayerConfig

Last updated: 2020-11-24 18:54:23

1. API Description

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

This API is used to create a superplayer 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 parameter. The value used for this API: CreateSuperPlayerConfig.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
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.
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.

  • Default value: OFF.
    AdaptiveDynamicStreamingDefinition No Integer ID of the unencrypted adaptive bitrate streaming template that allows output, which is required if DrmSwitch is OFF.
    DrmStreamingsInfo No DrmStreamingsInfo Content of the DRM-protected adaptive bitrate streaming template that allows output, which is required if DrmSwitch is ON.
    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. If this parameter is left empty or an empty array, the default configuration will be used:
  • MinEdgeLength: 240, Name: LD;
  • MinEdgeLength: 480, Name: SD;
  • MinEdgeLength: 720, Name: HD;
  • MinEdgeLength: 1080, Name: FHD;
  • 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.
    SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

    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 Creating a superplayer configuration

    Input Example

    https://vod.tencentcloudapi.com/?Action=CreateSuperPlayerConfig
    &Name=test
    &AdaptiveDynamicStreamingDefinition=10
    &<Public request parameters>

    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
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    LimitExceeded Quota limit is exceeded.
    UnauthorizedOperation Unauthorized operation.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help