Apply Scene Layout via SetCasterSceneConfig - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Sets the full scene configuration for a production studio by clearing the existing scene configuration and applying layout information to the specified scene.

Operation description

Calls this operation to set the full scene configuration for a production studio by clearing the existing scene configuration and applying layout information to the specified scene.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:SetCasterSceneConfig

update

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
ComponentId	array	No	The list of component IDs. The components are arranged in bottom-to-top order within the array. Note N indicates the sequence number. For example: ComponentId.1 indicates the first component ID. ComponentId.2 indicates the second component ID.	[ "a2b8e671-2fe5-4642-a2ec-bf931826**", "a2b8e671-2fe5-4642-a2ec-28374657**"]
	string	No	The list of component IDs. The components are arranged in bottom-to-top order within the array. Note N indicates the sequence number. For example: ComponentId.1 indicates the first component ID. ComponentId.2 indicates the second component ID.	[ "a2b8e671-2fe5-4642-a2ec-bf931826**", "a2b8e671-2fe5-4642-a2ec-28374657**"]
CasterId	string	Yes	The production studio ID. If you created the production studio by calling the CreateCaster operation, check the CasterId parameter returned by the CreateCaster operation. If you created the production studio in the ApsaraVideo Live console, go to ApsaraVideo Live console > Production Studios > China Cloud Production Studio to view the ID. Note The name of the production studio in the production studio list on the China Cloud Production Studio page is the production studio ID.	80787064-1c94-4dc1-85ce-9409960a****
SceneId	string	Yes	The scene ID. The scene must have been started by calling StartCasterScene. Otherwise, the IncorrectSceneStatus error is returned.	242b4e2c-c30f-4442-85ba-2e3e4e3d****
LayoutId	string	No	The layout ID. If you call the DescribeCasterLayouts operation to query the layout list of a production studio, check the LayoutId parameter returned by the DescribeCasterLayouts operation.	0c6da077-f037-49e8-8440-3be13393****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CF60DB6A-7FD6-426E-9288-122CC1A52FA7

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	InvalidSceneId.Malformed	%s, please check and try again later.	The parameter SceneId is invalid, please check and try again.
400	InvalidCaptionResource	%s, please check and try again later.	The resource referenced by the voice caption component does not exist or is not a live source. Please check and try again.
400	IncorrectSceneStatus	%s, please check and try again later.	Scene status is not supported, please check and try again.
400	ComponentNumberExceed	%s, please check and try again later.	The number of components exceeds the limit. Please check and try again.
400	IncorrectSceneStatus.Idle	%s, please check and try again later.	Scene status is idle, please check and try again.
400	IncorrectSceneStatus.ConfigError	%s, please check and try again later.	Scene configuration error, please check and try again.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
412	ResourceInChannel.PreConditionFailed	%s, please try again later.	Resource pre-verification failed, please try again later.
412	ResourceInChannel.Invalid	%s, please check and try again later.	Resource and channel material address are inconsistent, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.
404	InvalidScene.NotFound	%s, please check and try again later.	Scene does not exist, please check and try again.
404	InvalidLayout.NotFound	%s, please check and try again later.	LayoutId does not exist, please check and try again.
404	InvalidComponent.NotFound	%s, please check and try again later.	The component to be operated does not exist. Please check and try again.
404	ResourceInChannel.NotFound	%s, please check and try again later.	The resource does not exist. Please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.