tencent cloud

All product documents
APIs
DocumentationAPIsVideo on DemandCarousel-Related APIsHandleCurrentPlaylist
HandleCurrentPlaylist
Last updated: 2025-02-14 17:29:45
HandleCurrentPlaylist
Last updated: 2025-02-14 17:29:45

1. API Description

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

Operate the current play list . Supported operations include:

  • Insert: Insert a playing program into the current playlist.
  • Delete: Remove a playing program from the playlist.

    • 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: HandleCurrentPlaylist.
    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 Yes Integer VOD subapplication id..
    RoundPlayId Yes String The unique identifier of the playlist.
    Operation Yes String Operation type, available options:
  • insert: insert program into the current playlist.
  • inserttemporary: temporarily insert program into the current playlist. can only be inserted after the currently playing program. temporarily inserted programs are only effective during this carousel process.
  • delete: delete program from the playlist. cannot delete currently playing programs.
    • .
    ItemId No String Playlist program id. required when operation is insert, indicating the program list will be inserted after this program. the insertion position must be after the currently playing program.
    RoundPlaylist.N No Array of RoundPlayListItemInfo Program list. required when operation is insert, inserttemporary, delete, indicating the list of programs to be operated on. the list length can be up to a maximum of 10.

    3. Output Parameters

    Parameter Name Type Description
    RoundPlaylist Array of RoundPlayListItemInfo List of successfully operated programs.
    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 Insert a Program After Program A003 In the Current Playlist

    Input Example

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

{
    "SubAppId": 123,
    "RoundPlayId": "130",
    "Operation": "Insert",
    "ItemId": "a003",
    "RoundPlaylist": [
        {
            "FileId": "528xxx5487985271487",
            "AudioVideoType": "Transcode",
            "Definition": 100210
        }
    ]
}

    Output Example

    {
    "Response": {
        "RoundPlaylist": [
            {
                "ItemId": "a01",
                "AudioVideoType": "Transcode",
                "Definition": 100,
                "FileId": "528xxx5487985271487"
            }
        ],
        "RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

    Example2 Delete the Program In the Playlist

    Input Example

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

{
    "SubAppId": 123,
    "RoundPlayId": "130",
    "Operation": "Delete",
    "RoundPlaylist": [
        {
            "ItemId": "a004",
            "FileId": "",
            "AudioVideoType": ""
        }
    ]
}

    Output Example

    {
    "Response": {
        "RoundPlaylist": [
            {
                "ItemId": "a004",
                "AudioVideoType": "",
                "Definition": 100,
                "FileId": ""
            }
        ],
        "RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
    }
}

    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
    InvalidParameterValue.FileId The FileId does not exist.
    InvalidParameterValue.Index Index parameter error.
    InvalidParameterValue.RoundPlayId RoundPlayId parameter error.
    InvalidParameterValue.RoundPlaylist RoundPlaylist parameter length error.
    InvalidParameterValue.SubAppId Incorrect parameter value: application id.
    LimitExceeded.PlayList Playlist length too large.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon