DescribeCasterSceneAudio - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Before you call this operation, you must create a production studio by calling the CreateCaster operation.

QPS limit

The queries per second (QPS) limit for a single user is 15 calls per second. API calls that exceed this limit are throttled, which may affect your business. Plan your calls accordingly.

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

get

*Caster

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
CasterId	string	Yes	The ID of the production studio. If you create a production studio by calling the CreateCaster operation, obtain the value of CasterId from the response. If you create a production studio in the ApsaraVideo Live console, view the ID on the Production Studio > Cloud Production Studio page. Note The name of a production studio in the list on the Cloud Production Studio page is the ID of the production studio.	97df6b7f-3490-47d2-ac50-88338765****
SceneId	string	Yes	The ID of the scenario.	97df6b7f-3490-47d2-ac50-88339087****

Response parameters

Parameter	Type	Description	Example
	object
AudioLayers	object
AudioLayer	array<object>	The list of audio layer configurations.
	object	The list of audio layer configurations.
FixedDelayDuration	integer	The fixed latency. Unit: milliseconds (ms).	2000
ValidChannel	string	The sound channel type. Valid values: left: left sound channel. right: right sound channel. all (default): stereo.	all
VolumeRate	number	The audio volume.	1
CasterId	string	The ID of the production studio. This ID can be used as a request parameter to start the production studio scenario.	97df6b7f-3490-47d2-ac50-88338765****
FollowEnable	integer	Specifies whether to enable audio follow. By default, audio follow is enabled. 0: mix mode. 1: audio-follows-video mode.	1
MixList	object
LocationId	array	The list of associated locations. The order of locations is the same as the order of audio layers.
	string	The location ID.	RV01
RequestId	string	The request ID.	98745637-3490-47d2-ac50-883387567098

Examples

Success response

JSON format

{
  "AudioLayers": {
    "AudioLayer": [
      {
        "FixedDelayDuration": 2000,
        "ValidChannel": "all",
        "VolumeRate": 1
      }
    ]
  },
  "CasterId": "97df6b7f-3490-47d2-ac50-88338765****",
  "FollowEnable": 1,
  "MixList": {
    "LocationId": [
      "RV01"
    ]
  },
  "RequestId": "98745637-3490-47d2-ac50-883387567098"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidCasterId.Malformed	%s
401	IllegalOperation	%s
500	InternalError	%s
404	InvalidCaster.NotFound	%s
404	InvalidScene.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.