全部产品
Search
文档中心

视频直播:DescribeCasterSceneAudio - 查询场景音频配置信息

更新时间:Nov 14, 2024

查询场景音频配置。

接口说明

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

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeCasterSceneAudioget
*Caster
acs:live:*:{#accountId}:caster/{#CasterId}

请求参数

名称类型必填描述示例值
CasterIdstring

导播台 ID。

  • 如果您通过 CreateCaster 接口创建导播台,请查看 CreateCaster 接口调用返回的参数 CasterId 值。

  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。

说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
97df6b7f-3490-47d2-ac50-88338765****
SceneIdstring

场景 ID。

97df6b7f-3490-47d2-ac50-88339087****

返回参数

名称类型描述示例值
object
AudioLayersarray<object>

Audiolayer 配置列表。

AudioLayerobject

Audiolayer 配置列表。

FixedDelayDurationinteger

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

2000
ValidChannelstring

声道类型。取值:

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

音频音量。

1
CasterIdstring

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

97df6b7f-3490-47d2-ac50-88338765****
FollowEnableinteger

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

  • 0:混音模式。
  • 1:音频跟随视频模式。
1
MixListarray
LocationIdstring

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

RV01
RequestIdstring

请求 ID。

98745637-3490-47d2-ac50-883387567098

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

HTTP status code错误码错误信息
400InvalidCasterId.Malformed%s
401IllegalOperation%s
404InvalidCaster.NotFound%s
404InvalidScene.NotFound%s
500InternalError%s

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

变更历史

变更时间变更内容概要操作
暂无变更历史