tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateRoundPlay

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

    1. API Description

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

    This API is used to create a playlist. You can create at most 100 playlists.
    For each video on the list, you can either use the original file or a transcoding file.
    The files must be in HLS format. Preferably, they should have the same bitrate and resolution.

    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: CreateRoundPlay.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    StartTime Yes String The playback start time, in ISO 8601 date format.
    RoundPlaylist.N Yes Array of RoundPlayListItemInfo The files on the list.
  • Array length limit: 100.
    		•
    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.
    Name No String The playlist name (not longer than 64 characters).
    Desc No String The playlist description (not longer than 256 characters).
    PlayBackMode No String Play mode, optional values:
  • Loop: Play the playlist in a loop;
  • Linear: Play once, stop playing after the playlist is played.

    • Default value: Loop.

    3. Output Parameters

    Parameter Name Type Description
    RoundPlayId String The playlist ID, which is unique.
    Url String The playlist URL.
    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 Creating a playlist

    This example shows you how to create a playlist and specify the files on the list.

    Input Example

    POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRoundPlay
&<Common Request Parameters>

{
    "StartTime": "2022-06-01T00:00:00+08:00",
    "RoundPlaylist": [
        {
            "FileId": "528xxx5487985271487",
            "AudioVideoType": "Transcode",
            "Definition": 100210
        }
    ]
}

    Output Example

    {
    "Response": {
        "RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
        "Url": "http://domain/round-play/bffb15f07530b57bc1aabb01fac74bca/playlist.m3u8",
        "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
    FailedOperation Operation failed.
    InvalidParameter Invalid parameter.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy