Tencent Cloud

ModifyRoundPlay

Last updated: 2023-11-29 10:56:59

1. API Description

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

This API is used to modify a playlist.
The modification will only take effect for new playback requests. For ongoing playback, the old playlist will be playable for seven days after the modification.

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: ModifyRoundPlay.
Version	Yes	String	Common Params. The value used for this API: 2018-07-17.
Region	No	String	Common Params. This parameter is not required.
RoundPlayId	Yes	String	The playlist ID, which is unique.
SubAppId	No	Integer	The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.
StartTime	No	String	The playback start time, in ISO 8601 date format.
RoundPlaylist.N	No	Array of RoundPlayListItemInfo	The files on the list. Array length limit: 100.
Name	No	String	The playlist name (not longer than 64 characters).
Desc	No	String	The playlist description (not longer than 256 characters).
Status	No	String	Playback status, optional values: Disabled: End playback, and the carousel task cannot be started again after the end.
PlayBackMode	No	String	Play mode, optional values: Loop: Play the playlist in a loop; Linear: Play once, stop playing after the playlist is played.

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 Modifying a playlist

This example shows you how to modify a playlist. You can use this API to modify the videos on a list, the playlist name, and the description.

Input Example

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

{
    "RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
    "RoundPlaylist": [
        {
            "FileId": "528xxx5487985271487",
            "AudioVideoType": "Transcode",
            "Definition": 100210
        }
    ]
}

Output Example

{
    "Response": {
        "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

Tencent Cloud CLI 3.0

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.
InvalidParameterValue	Incorrect parameter value.
ResourceNotFound	The resource does not exist.

tencent cloud

Recent Pages

ModifyRoundPlay

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Modifying a playlist

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

ModifyRoundPlay

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Modifying a playlist

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?