All Products
Search

This Product

    ApsaraVideo Live:UpdateCasterSceneAudio

    Document Center

    ApsaraVideo Live:UpdateCasterSceneAudio

    Last Updated:Nov 14, 2024

    Modifies the audio configurations of a scene.

    Operation description

    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.

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    live:UpdateCasterSceneAudioupdate
    *Caster
    acs:live:*:{#accountId}:caster/{#CasterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AudioLayerarray<object>No

    The audio configurations.

    objectNo
    FilterstringNo

    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 }
    FixedDelayDurationintegerNo

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

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

    		0
    ValidChannelstringNo

    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 (default): both the left and right channels
    		all
    VolumeRatefloatNo

    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.
    		1
    MixListarrayNo

    The location IDs of the audio layers, which are in the same order as the audio layers.

    stringNo

    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
    CasterIdstringYes

    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.
    		LIVEPRODUCER_POST-cn-0pp1czt****
    SceneIdstringYes

    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.

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

    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

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError message
    400InvalidCasterId.Malformed%s
    400InvalidUserId.Malformed%s
    400InvalidParameter.Malformed%s
    400InvalidAudioLayersAndMixListSize.Mismatch%s
    400IncorrectSceneStatus%s
    400IncorrectSceneStatus.ConfigError%s
    400InvalidMixList.ExceedNorm%s
    401IllegalOperation%s
    404InvalidCaster.NotFound%s
    404InvalidScene.NotFound%s
    404ResourceInChannel.NotFound%s
    412ResourceInChannel.PreConditionFailed%s
    412ResourceInChannel.Invalid%s
    500InternalError%s

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-03-06The Error code has changedView Change Details