调用DescribeCasterSceneAudio查询场景音频配置。

使用说明

先通过CreateCaster接口创建导播台,再调用本接口查询场景音频配置。

QPS限制

本接口的单用户QPS限制为15次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCasterSceneAudio

系统规定参数。取值:DescribeCasterSceneAudio

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

导播台ID。

  • 如果您通过CreateCaster接口创建导播台,请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
SceneId String 97df6b7f-3490-47d2-ac50-88339087****

场景ID。

返回数据

名称 类型 示例值 描述
RequestId String 98745637-3490-47d2-ac50-883387567098

请求ID。

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

导播台ID。可作为启动导播台场景的请求参数。

FollowEnable Integer 1

是否启用音频跟随。 默认启用音频跟随。

  • 0:混音模式。
  • 1:音频跟随视频模式。
MixList Array of String RV01

位置关联列表。 与AudioLayers顺序保持一致。

AudioLayers Array of AudioLayer

Audiolayer配置列表。

AudioLayer
VolumeRate Float 1

音频音量。

FixedDelayDuration Integer 2000

固定延时时间,单位毫秒(ms)。

ValidChannel String all

声道类型。取值:

  • left:左声道。
  • right:右声道。
  • all(默认值):双声道。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeCasterSceneAudio
&CasterId=97df6b7f-3490-47d2-ac50-88338765****
&SceneId=97df6b7f-3490-47d2-ac50-88339087****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<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格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DescribeCasterSceneAudioResponse" : {
    "RequestId" : "97df6b7f-3490-47d2-ac50-8833e1b64597",
    "MixList" : "RV01",
    "FollowEnable" : 1,
    "CasterId" : "97df6b7f-3490-47d2-ac50-88338765****",
    "AudioLayers" : {
      "ValidChannel" : "all",
      "VolumeRate" : 1,
      "FixedDelayDuration" : 2000
    }
  }
}

错误码

访问错误中心查看更多错误码。