Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create a carousel playlist. Maximum quantity: 100.
Each file in the Carousel Playlist can specify a source file or a transcoded file.
The designated file must be in hls format. All playlist files should preferably maintain the same bitrate and resolution.
A maximum of 20 requests can be initiated per second for this API.
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 | Playback start time in ISO 8601 format. For details, see ISO date format description. |
| RoundPlaylist.N | Yes | Array of RoundPlayListItemInfo | Carousel list. |
| SubAppId | No | Integer | ID of the VOD application. For customers who activate VOD after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application). |
| Name | No | String | Carousel playbill name. Length limit: 64 characters. |
| Desc | No | String | Carousel playlist description, with a length limit of 256 characters. |
| PlayBackMode | No | String | Playback mode. Optional values: Default value: Loop. |
| RoundPlayId | No | String | Unique playlist ID. Length limit: 64 characters. Only allow a combination of uppercase and lowercase letters (a-zA-Z), digits (0-9), and hyphens (-). If a playlist with the same RoundPlayId exists, return the InvalidParameterValue.RoundPlayAlreadyExists error. Default value: empty, which means it is assigned by the system. |
| ExpiredTime | No | String | Expiration time, formatted according to the ISO 8601 standard. For details, see ISO date format description. Playback stops after expiry. "9999-12-31T23:59:59+08:00" means no expiration. Default value: 9999-12-31T23:59:59+08:00. |
| Parameter Name | Type | Description |
|---|---|---|
| RoundPlayId | String | Unique identifier of the carousel playlist. |
| Url | String | Carousel playback address. |
| 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. |
Create a new carousel playlist. You can specify the carousel list.
POST / HTTP/1.1
Host: vod.intl.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
}
]
}{
"Response": {
"RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
"Url": "http://domain/round-play/bffb15f07530b57bc1aabb01fac74bca/playlist.m3u8",
"RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
}
}Create a new Carousel Playlist that expires after 2024-12-10T20:00:00+08:00.
POST / HTTP/1.1
Host: vod.intl.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
}
],
"RoundPlayId": "bffb15f07530b57bc1aabb01fac74bcb",
"ExpiredTime": "2024-12-10T20:00:00+08:00"
}
{
"Response": {
"RoundPlayId": "bffb15f07530b57bc1aabb01fac74bcb",
"Url": "http://domain/round-play/bffb15f07530b57bc1aabb01fac74bcb/playlist.m3u8",
"RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Parameter error. |
| InvalidParameterValue.ExpiredTime | ExpiredTime error. |
| InvalidParameterValue.RoundPlayAlreadyExists | A playlist with the same ID already exists. |
| InvalidParameterValue.RoundPlaylist | Invalid RoundPlaylist parameter length. |
| InvalidParameterValue.StartTime | Parameter value error: StartTime is invalid. |
| LimitExceeded.PlayList | Playlist length is too large. |
| LimitExceeded.RoundPlays | Exceeds the total number of playlists limit. |
| LimitExceeded.RunningRoundPlays | The number of running playlists exceeds the maximum limit. |
文档反馈