Queries the audio configurations of a scene.

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 DescribeCasterSceneAudio

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

CasterId String Yes 97df6b7f-3490-47d2-ac50-88338765****

The ID of the production studio.

SceneId String Yes 97df6b7f-3490-47d2-ac50-88339087****

The ID of the scene.

RegionId String No cn-shanghai

The ID of the region.

Response parameters

Parameter Type Example Description
AudioLayers Array of AudioLayer

The configurations of the audio layer.

AudioLayer
FixedDelayDuration Integer 2000

The fixed delay of the audio layer. Unit: milliseconds.

ValidChannel String all

The valid voice channels of the audio layer. Valid values:

  • left: the left channel.
  • right: the right channel.
VolumeRate Float 1

The volume of the audio layer.

CasterId String 97df6b7f-3490-47d2-ac50-88338765****

The ID of the production studio.

FollowEnable Integer 1

Indicates whether audio follow video (AFV) is enabled. By default, AFV is enabled. Valid values:

  • 0: the audio mixing mode.
  • 1: the AFV mode.
MixList List RV01

The location ID of the audio layer in the production studio. The audio layers specified by this parameter are in the same order as those specified by the AudioLayers parameter.

RequestId String 98745637-3490-47d2-ac50-883387567098

The ID of the request.

Examples

Sample requests

https://live.aliyuncs.com?Action=DescribeCasterSceneAudio
&CasterId=97df6b7f-3490-47d2-ac50-88338765****
&SceneId=97df6b7f-3490-47d2-ac50-88339087****
&<Common request parameters>

Sample success responses

XML format

<DescribeCasterSceneAudioResponse>
	  <RequestId>97df6b7f-3490-47d2-ac50-8833e1b64597</RequestId>
	  <MixList>RV01</MixList>
      <FollowEnable>1</FollowEnable>
      <CasterId>97df6b7f-3490-47d2-ac50-88338765****</CasterId>
	  <AudioLayers>
		    <ValidChannel>all</ValidChannel>
            <VolumeRate>1</VolumeRate>
            <FixedDelayDuration>2000</FixedDelayDuration>
	  </AudioLayers>
</DescribeCasterSceneAudioResponse>

JSON format

{
    "RequestId": "97df6b7f-3490-47d2-ac50-883387654365",
    "FollowEnable": 1,
    "CasterId":"97df6b7f-3490-47d2-ac50-88338765****",
    "MixList": [
            "RV01"
        ],
    
    "VideoFormat": [
        {                
            "VolumnRate": 1,
            "FixedDelayDuration": 2000,
            "ValidChannel": "all"    
        }
    ]
}

Error codes

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