SetCasterSceneConfig - ApsaraVideo Live

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	SetCasterSceneConfig	The operation that you want to perform. Set the value to SetCasterSceneConfig.
ComponentId.N	String	No	[ "a2b8e671-2fe5-4642-a2ec-bf931826**", "a2b8e671-2fe5-4642-a2ec-28374657**"]	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.
CasterId	String	Yes	80787064-1c94-4dc1-85ce-9409960a****	The ID of the production studio. If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID. If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane. Note You can find the ID of the production studio in the Instance Name column.
SceneId	String	Yes	242b4e2c-c30f-4442-85ba-2e3e4e3d****	The ID of the scene.
LayoutId	String	No	0c6da077-f037-49e8-8440-3be13393****	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.

Response parameters

Parameter	Type	Example	Description
RequestId	String	CF60DB6A-7FD6-426E-9288-122CC1A52FA7	The request ID.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=SetCasterSceneConfig
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&SceneId=242b4e2c-c30f-4442-85ba-2e3e4e3d****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<SetCasterSceneConfigResponse>
	<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
</SetCasterSceneConfigResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "SetCasterSceneConfigResponse" : {
    "RequestId" : "CF60DB6A-7FD6-426E-9288-122CC1A52FA7"
  }
}

Error codes

For a list of error codes, see Service error codes.