UpdateCasterSceneAudio - ApsaraVideo Live - Alibaba Cloud Documentation Center

Modifies the audio configurations of a scene. This operation also allows you to add an audio configuration or apply an existing audio configuration to a new scene.

Operation description

You can call the CreateCaster operation to create a production studio and then call this operation to modify the audio configurations of a scene in the production studio. This operation supports the audio mixing mode and the audio follows video (AFV) mode.

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:UpdateCasterSceneAudio	update	Caster `acs:live::{#accountId}:caster/{#CasterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
AudioLayer	array<object>	No	The audio configurations.
	object	No	The audio configuration.
Filter	string	No	Specifies whether to enable the features provided by the audio 3A algorithms. This parameter consists of the following fields: enableAgc: specifies whether to enable automatic gain control (AGC). This field is optional. Valid values: 0 and 1. 0 is the default value, which specifies that AGC is disabled. 1 specifies that AGC is enabled. enableAns: specifies whether to enable active noise suppression (ANS). This field is optional. Valid values: 0 and 1. 0 is the default value, which specifies that ANS is disabled. 1 specifies that ANS is enabled. ansMode: specifies the mode for ANS. This field is optional and takes effect only if you set enableAns to 1. Valid values: 0 and 1. 0 is the default value, which specifies the speech noise reduction mode. 1 specifies the music noise reduction mode. Note To ensure a better noise reduction effect, we recommend that you set ansMode to 1. enableBeautify: specifies whether to enable voice change. This field is optional. Valid values: 0 and 1. 0 is the default value, which specifies that voice change is disabled. 1 specifies that voice change is enabled. voiceBeautifyMode: specifies the mode for voice change. This field is optional and takes effect only if you set enableBeautify to 1. Valid values: 0 and 1. 0 is the default value, which specifies the magnetic male voice mode. 1 specifies the fresh female voice mode.	{ "enableAgc":0, "enableAns":1 }
FixedDelayDuration	integer	No	The fixed delay of the audio layer. This parameter is used to synchronize the audio with subtitles. Unit: milliseconds. Valid values: 0 to 5000. Default value: 0.	0
ValidChannel	string	No	The sound channels that are used for volume input in the audio layer. Valid values: leftChannel: the left channel rightChannel: the right channel all (default): both the left and right channels	all
VolumeRate	float	No	The multiple of the original volume at which the audio layer plays audio. Valid values: 0 to 10.0. Default value: 1.0. 1.0: specifies that the audio layer plays audio at the original volume. A value smaller than 1: specifies that the audio layer plays audio at a volume that is less than the original volume. A value greater than 1: specifies that the audio layer plays audio at a volume that is more than the original volume.	1
MixList	array	No	The location IDs of the audio layers, which are in the same order as the audio layers.
	string	No	The location ID of the audio layer N in the production studio. Make sure that the value is consistent with the specified order of the audio layer. If channels are enabled, set this parameter to the location ID of the channel. If channels are disabled, set this parameter to the location ID of the input source.	RV01
CasterId	string	Yes	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 ID/Name column.	LIVEPRODUCER_POST-cn-0pp1czt****
SceneId	string	Yes	The ID of the scene. If you call the DescribeCasterScenes operation to query scenes of the production studio, check the value of the response parameter ComponentId to obtain the ID.	a2b8e671-2fe5-4642-a2ec-bf93880e1****
FollowEnable	integer	No	The audio mode. By default, the AFV mode is used. If you do not specify this parameter, the scene retains the last configuration. Valid values: 0: the audio mixing mode. 1: the AFV mode.	1

N in the preceding request parameters indicates the sequence number. Examples:

The AudioLayer.N.VolumeRate parameter specifies the multiple of the original volume at which the audio layer N plays audio.
The AudioLayer.1.VolumeRate parameter specifies the multiple of the original volume at which the first audio layer plays audio.
The AudioLayer.2.VolumeRate parameter specifies the multiple of the original volume at which the second audio layer plays audio.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Sample success responses

JSONformat

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidCasterId.Malformed	%s
400	InvalidUserId.Malformed	%s
400	InvalidParameter.Malformed	%s
400	InvalidAudioLayersAndMixListSize.Mismatch	%s
400	IncorrectSceneStatus	%s
400	IncorrectSceneStatus.ConfigError	%s
400	InvalidMixList.ExceedNorm	%s
401	IllegalOperation	%s
404	InvalidCaster.NotFound	%s
404	InvalidScene.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
2023-03-06	The Error code has changed	View Change Details