Modifies the audio configurations of a scene.

Usage notes

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. For more information, see QPS limit on an API operation in ApsaraVideo Live.

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 UpdateCasterSceneAudio

The operation that you want to perform. Set the value to UpdateCasterSceneAudio.

AudioLayer.N.VolumeRate Float No 1

The multiple of the original volume at which the audio layer N plays audio. Valid values: 0 to 10.0. Default value: 1.0.

  • 1.0: specifies that the audio layer N plays audio at the original volume.
  • A value smaller than 1: specifies that the audio layer N plays audio at a volume that is less than the original volume.
  • A value greater than 1: specifies that the audio layer N plays audio at a volume that is more than the original volume.
AudioLayer.N.FixedDelayDuration Integer No 0

The fixed delay of the audio layer N. This parameter is used to synchronize the audio with subtitles.

Unit: millisecond. Valid values: 0 to 5000. Default value: 0.

AudioLayer.N.ValidChannel String No all

The sound channels that are used for volume input in the audio layer N. Valid values:

  • leftChannel: the left channel.
  • rightChannel: the right channel.
  • all: both the left and right channels. This is the default value.
AudioLayer.N.Filter String No { "enableAgc":0, "enableAns":1 }

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.
MixList.N String No RV01

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.

CasterId String Yes LIVEPRODUCER_POST-cn-0pp1czt****

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 a2b8e671-2fe5-4642-a2ec-bf93880e1****

The ID of the scene. If you call the DescribeCasterScenes operation to query scenes of the production studio, check the value of the ComponentId parameter to obtain the ID.

FollowEnable Integer No 1

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.

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 Example Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The request ID.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=UpdateCasterSceneAudio
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&SceneId=a2b8e671-2fe5-4642-a2ec-bf93880e1****
&<Common request parameters>

Sample success responses

XML format

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

<?xml version="1.0" encoding="UTF-8" ?>
<UpdateCasterSceneAudioResponse>
	<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</UpdateCasterSceneAudioResponse>

JSON format

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

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

Error codes

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