Configures all settings of a scene. This is done by clearing all previous settings of the scene and applying new settings, including the layout setting, to the scene.
Operation description
Usage notes
This operation configures a scene by clearing all previous settings of the scene and applying new settings, including the layout setting, to the scene.
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. For more information, see QPS limits.
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:SetCasterSceneConfig | update | *Caster acs:live:*:{#accountId}:caster/{#CasterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ComponentId | array | No | The IDs of the components. Components in the scene are listed from the bottom to the top in an array. Note
N indicates a sequence number. Examples: ComponentId.1 indicates the ID of the first component. ComponentId.2 indicates the ID of the second component. | |
| string | No | The ID of component N. Components in the scene are listed from the bottom to the top in an array. Note
N indicates a sequence number. Examples: ComponentId.1 indicates the ID of the first component. ComponentId.2 indicates the ID of the second component. | [ "a2b8e671-2fe5-4642-a2ec-bf931826****", "a2b8e671-2fe5-4642-a2ec-28374657****"] | |
| 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.
| 80787064-1c94-4dc1-85ce-9409960a**** |
| SceneId | string | Yes | The ID of the scene. | 242b4e2c-c30f-4442-85ba-2e3e4e3d**** |
| LayoutId | string | No | The ID of the layout. If you call the DescribeCasterLayouts operation to query the layouts of the production studio, check the value of the response parameter LayoutId to obtain the ID. | 0c6da077-f037-49e8-8440-3be13393**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidCasterId.Malformed | %s |
| 400 | InvalidUserId.Malformed | %s |
| 400 | InvalidSceneId.Malformed | %s |
| 400 | InvalidCaptionResource | %s |
| 400 | IncorrectSceneStatus | %s |
| 400 | ComponentNumberExceed | %s |
| 400 | IncorrectSceneStatus.Idle | %s |
| 400 | IncorrectSceneStatus.ConfigError | %s |
| 400 | InvalidParameter.Malformed | %s |
| 401 | IllegalOperation | %s |
| 404 | InvalidCaster.NotFound | %s |
| 404 | InvalidScene.NotFound | %s |
| 404 | InvalidLayout.NotFound | %s |
| 404 | InvalidComponent.NotFound | %s |
| 404 | ResourceInChannel.NotFound | %s |
| 412 | ResourceInChannel.PreConditionFailed | %s |
| 412 | ResourceInChannel.Invalid | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|