查询场景音频配置。
接口说明
先通过 CreateCaster 接口创建导播台,再调用本接口查询场景音频配置。
QPS 限制
本接口的单用户 QPS 限制为 15 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:DescribeCasterSceneAudio |
get |
*Caster
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| CasterId |
string |
是 |
导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。 |
97df6b7f-3490-47d2-ac50-88338765**** |
| SceneId |
string |
是 |
场景 ID。 |
97df6b7f-3490-47d2-ac50-88339087**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AudioLayers |
object |
||
| AudioLayer |
array<object> |
Audiolayer 配置列表。 |
|
|
object |
Audiolayer 配置列表。 |
||
| FixedDelayDuration |
integer |
固定延时时间,单位毫秒(ms)。 |
2000 |
| ValidChannel |
string |
声道类型。取值:
|
all |
| VolumeRate |
number |
音频音量。 |
1 |
| CasterId |
string |
导播台 ID。可作为启动导播台场景的请求参数。 |
97df6b7f-3490-47d2-ac50-88338765**** |
| FollowEnable |
integer |
是否启用音频跟随。 默认启用音频跟随。
|
1 |
| MixList |
object |
||
| LocationId |
array |
位置关联列表。 与 AudioLayers 顺序保持一致。 |
|
|
string |
位置 ID。 |
RV01 |
|
| RequestId |
string |
请求 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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidCasterId.Malformed | %s | |
| 401 | IllegalOperation | %s | |
| 500 | InternalError | %s | |
| 404 | InvalidCaster.NotFound | %s | |
| 404 | InvalidScene.NotFound | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。