Modifies the audio configurations of a scene.

Usage note

You can enable or disable the enable audio follow video (AFV) mode using this operation.

QPS limit

A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, 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.

CasterId String Yes 48e95adf-580b-4661-9ee9-6fbc6e48****

The ID of the production studio.

If you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response.

If you create a production studio through the ApsaraVideo Live Console, log in to the console, then check the ID of the production studio through the following path:

Production Studios > Production Studio Management

Note The CasterId is reflected in the Name column on the Production Studio Management page.
SceneId String Yes a2b8e671-2fe5-4642-a2ec-bf93880e1****

The ID of the scene. For more information about the scenes, see Query the scenes of production studios.

RegionId String No cn-shanghai

The ID of the region.
FollowEnable Integer No 1

Specifies whether to enable audio follow video (AFV). By default, AFV is enabled. If you do not specify this parameter, the scene retains the last configuration. Valid values:

  • 0: the audio mixing mode.
  • 1: the AFV mode.
AudioLayer.N.VolumeRate Float No 1

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

  • The default value 1.0 indicates that audio layer N plays audio streams at the original volume.
  • A value smaller than 1.0 indicates that audio layer N plays audio streams at a lower volume than the original one.
  • A value greater than 1.0 indicates that audio layer N plays audio streams at a higher volume than the original one.
AudioLayer.N.ValidChannel String No all

The valid voice channels of 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.FixedDelayDuration Integer No 0

The fixed delay of audio layer N. You can use this parameter to synchronize the audio with subtitles.

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

MixList.N RepeatList No RV01

The location ID of audio layer N in the production studio.

Make sure that the audio layers specified by this parameter are in the same order as those specified by the AudioLayers parameter. If channels are enabled, set this parameter to the location IDs of channels. Otherwise, set this parameter to the location IDs of video resources.

The variable N in request parameter names indicates the sequence number of the audio layer. Examples:

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

Response parameters

Parameter Type Example Description
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=UpdateCasterSceneAudio
&CasterId=48e95adf-580b-4661-9ee9-6fbc6e48****
&SceneId=a2b8e671-2fe5-4642-a2ec-bf93880e1****
&<Common request parameters>

Sample success responses

XML format 

<UpdateCasterSceneAudioResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</UpdateCasterSceneAudioResponse>

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.