Configures the background of the episode list.
Operation description
- Create a production studio in playlist mode, and then call this operation to add the background material. For information about how to create a production studio, see CreateCaster .
- You can call this operation to create, update, or delete the background of the episode list. To delete the background, leave the ResourceType, ResourceUrl, and MaterialId parameters empty.
-
When you select media resources from ApsaraVideo VOD, we recommend that you select resources that are stored in hosted OSS buckets. Resources stored in non-hosted OSS buckets have a validity period. Pay attention to the validity if you select resources that are stored in non-hosted OSS buckets.
-
When you add media resources to a production studio, we recommend that you select resources from ApsaraVideo Live and ApsaraVideo VOD. If you add a third-party stream by specifying a streaming URL, there is a possibility that the stream fails to be played. You must pay attention to the quality and validity of the third-party stream.
QPS limit
You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:SetShowListBackground | update | *Caster acs:live:*:{#accountId}:caster/{#CasterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| CasterId | string | Yes | The ID of the production studio.
Note
You can find the ID of the production studio in the Instance ID/Name column.
| LIVEPRODUCER_POST-cn-0pp1czt**** |
| ResourceType | string | No | The resource type. Valid values:
Note
Set this parameter to one of the preceding values, or leave this parameter empty.
| VOD |
| MaterialId | string | No | The ID of the material in ApsaraVideo VOD. Note
Specify either this parameter or the ResourceUrl parameter.
| a2b8e671-2fe5-4642-a2ec-bf93880e**** |
| ResourceUrl | string | No | The URL of the third-party material. | http://****/atestObject****.m3u8 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "987DA143-A39C-5B5D-AF5B-3B07944A0036"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidUserId.Malformed | %s |
| 400 | MissingParameter | %s |
| 400 | InvalidParameter.Malformed | %s |
| 400 | InvalidParameter.PageSize | %s |
| 400 | InvalidParameter.PageNum | %s |
| 400 | InvalidParameter.Status | %s |
| 400 | InvalidParameter.StartTime | %s |
| 400 | InvalidParameter.EndTime | %s |
| 400 | LiveServiceNotFound | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.