Modifies the attributes of a playlist.
Usage notes
This operation allows you to change the position of a program in a playlist, how many times a playlist is played, and the specific point in time at which the program of the highest priority in a playlist is played.
QPS limit
You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ModifyShowList |
The operation that you want to perform. Set the value to ModifyShowList. |
CasterId | String | Yes | LIVEPRODUCER_POST-cn-0pp1czt**** |
The ID of the production studio instance.
Note The value displayed in the Name column for an instance on the Production Studio Management
page is the ID of the instance.
|
ShowId | String | No | a2b8e671-2fe5-4642-a2ec-bf93880e**** |
The ID of the program for which you want to change the position in the playlist. Note You can call the AddShowIntoShowList or DescribeShowList operation and check the value of the response parameter ShowId to obtain the program
ID.
|
RepeatTimes | Integer | No | 5 |
The number of additional times the playlist is played. Note The RepeatTimes parameter specifies the number of repetitions. For example, if you
set the value to 0, the playlist is played once. If you set the value to 1, the playlist
is played twice.
|
Spot | Integer | No | 1 |
The position of the program in the playlist. Place the ID of the program for which you want to change the position in the playlist in Spot. Note The value must be greater than or equal to 0 and less than or equal to the total number
of programs in the playlist.
|
HighPriorityShowId | String | No | a2b8e671-2fe5-4642-a2ec-bf93880e**** |
The program of the highest priority. Note You can configure this parameter only before the playlist starts.
|
HighPriorityShowStartTime | String | No | 2021-11-23T12:30:00 |
The time at which the program of the highest priority is played. Format: _yyyy-MM-dd'T'HH:mm:ss_. Note
You can configure this parameter only before the playlist starts. After you configure this parameter, when the specified time point is reached, any program that is playing stops and the program of the highest priority in the playlist starts to play. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
The ID of the request. |
Examples
Sample requests
http(s):/live.aliyuncs.com/?Action=ModifyShowList
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&<Common request parameters>
Sample success responses
XML
format
<ModifyShowListResponse>
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</ModifyShowListResponse>
JSON
format
{"RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"}
Error codes
For a list of error codes, visit the API Error Center.
Sample code
public static DefaultAcsClient initClient(String accessKeyId, String accessKeySecret) throws ClientException {
String regionId = "cn-shanghai";
DefaultProfile profile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
DefaultAcsClient client = new DefaultAcsClient(profile);
return client;
}
private static CommonResponse ModfiyShowList(DefaultAcsClient client, String casterId, String showId, Integer repeatTimes, Integer spot,
String highPriorityShowId, String highPriorityShowStartTime) throws ClientException {
CommonRequest modfiyShowListRequest = new CommonRequest();
modfiyShowListRequest.setSysDomain("live.aliyuncs.com");
modfiyShowListRequest.setSysVersion("2016-11-01");
modfiyShowListRequest.setSysAction("ModifyShowList");
if (casterId != null) {
modfiyShowListRequest.putQueryParameter("CasterId", casterId);
}
if (showId != null) {
modfiyShowListRequest.putQueryParameter("ShowId", showId);
}
if (repeatTimes != null) {
modfiyShowListRequest.putQueryParameter("RepeatTimes", repeatTimes.toString());
}
if (spot != null) {
modfiyShowListRequest.putQueryParameter("Spot", spot.toString());
}
if (highPriorityShowId != null) {
modfiyShowListRequest.putQueryParameter("HighPriorityShowId", highPriorityShowId.toString());
}
if (highPriorityShowStartTime != null) {
modfiyShowListRequest.putQueryParameter("HighPriorityShowStartTime", highPriorityShowStartTime.toString());
}
CommonResponse modfiyShowListResponse = client.getCommonResponse(modfiyShowListRequest);
System.out.println("If the attributes of the playlist are modified, the following value is returned:" + JSON.toJSONString(modfiyShowListResponse));
return modfiyShowListResponse;
}
public void modifyShowList() throws ClientException {
DefaultAcsClient client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
String showId= "";
Integer repeatTimes=10;
String highPriorityShowId="";
String highPriorityShowStartTime = "2021-11-23T12:30:00";
modfiyShowList(client,testCasterId, showId,repeatTimes,0,highPriorityShowId, highPriorityShowStartTime);
}