All Products
Search

This Product

    ApsaraVideo Live:UpdateCasterSceneAudio

    Document Center

    ApsaraVideo Live:UpdateCasterSceneAudio

    Last Updated:Aug 15, 2025

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

    Operation description

    First, call the CreateCaster operation to create a production studio. Then, you can call this operation to update the audio configuration of a scene. This operation supports the audio mixing mode and the audio-follows-video (AFV) mode.

    QPS limits

    You can make up to 10 queries per second (QPS) per Alibaba Cloud account. API calls that exceed this limit are throttled, which may affect your business. We recommend that you adhere to this limit.

    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:UpdateCasterSceneAudio

    update

    *Caster

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The ID of the region.

    cn-shanghai
    AudioLayer

    array<object>

    No

    The audio configurations.

    object

    No

    The audio configuration.

    Filter

    string

    No

    Specifies whether to enable the features provided by the 3A audio algorithm. This parameter consists of the following fields:

    • enableAgc: (Optional) Specifies whether to enable the automatic gain control (AGC) feature of the 3A algorithm. Valid values: 0 (disabled, default) and 1 (enabled).

    • enableAns: (Optional) Specifies whether to enable the intelligent noise reduction feature of the 3A algorithm. Valid values: 0 (disabled, default) and 1 (enabled).

    • ansMode: (Optional) The mode of the intelligent noise reduction feature. This field is active only when enableAns is set to 1. Valid values: 0 (speech noise reduction, default) and 1 (music noise reduction).

    Note

    For better noise reduction, set ansMode to 1.

    • enableBeautify: (Optional) Specifies whether to enable voice beautification. Valid values: 0 (disabled, default) and 1 (enabled).

    • voiceBeautifyMode: (Optional) The voice beautification mode. This field is active only when enableBeautify is set to 1. Valid values: 0 (magnetic male voice, default) and 1 (fresh female voice).

    { "enableAgc":0, "enableAns":1 }
    FixedDelayDuration

    integer

    No

    The fixed latency of the audio layer. This parameter is used to synchronize the audio with captions.

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

    0
    ValidChannel

    string

    No

    The sound channels that are used for volume input. Valid values:

    • leftChannel: the left sound channel.

    • rightChannel: the right sound channel.

    • all (default): both sound channels.

    all
    VolumeRate

    number

    No

    The volume multiplier for the audio stream. Valid values: 0 to 10.0. Default value: 1.0.

    • 1.0: The original volume is used.

    • A value less than 1 decreases the volume.

    • A value greater than 1 increases the volume.

    1
    MixList

    array

    No

    The list of associated location IDs. The order of the location IDs must be the same as the order of the audio layers.

    RV01

    string

    No

    The location ID of the resource.

    The order of location IDs must be consistent with the order of the audio layers. If a channel is enabled, use the location ID of the channel. Otherwise, use the location ID of the video source.

    RV01
    CasterId

    string

    Yes

    The ID of the production studio.

    • If you create a production studio by calling the CreateCaster operation, you can obtain the ID from the CasterId parameter in the response.

    • If you create a production studio in the LIVE console, go to the LIVE Console > Production Studio > Cloud Production Studio page to view the ID.

    Note

    The name of the production studio in the list on the Cloud Production Studio page is the ID of the production studio.

    LIVEPRODUCER_POST-cn-0pp1czt****
    SceneId

    string

    Yes

    The ID of the scene. If you query the list of scenes in a production studio by calling the DescribeCasterScenes operation, you can obtain the ID from the ComponentId parameter in the response.

    a2b8e671-2fe5-4642-a2ec-bf93880e1****
    FollowEnable

    integer

    No

    Specifies whether to enable the AFV mode. If you leave this parameter empty, the last configuration is retained. Valid values:

    • 0: audio mixing mode.

    • 1: audio-follows-video mode.

    1

    In the request parameters, N indicates the sequence number. For example:

    • AudioLayer.N.VolumeRate specifies the volume multiplier for the Nth element.

    • AudioLayer.1.VolumeRate specifies the volume multiplier for the first element.

    • AudioLayer.2.VolumeRate specifies the volume multiplier for the second element.

    Response parameters

    Parameter

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    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
    412 ResourceInChannel.PreConditionFailed %s
    412 ResourceInChannel.Invalid %s
    500 InternalError %s
    404 InvalidCaster.NotFound %s
    404 InvalidScene.NotFound %s
    404 ResourceInChannel.NotFound %s

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.