查詢情境音頻配置。
介面說明
先通過 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, please check and try again later. | 參數CasterId無效,請檢查後重試。 |
| 401 | IllegalOperation | %s, please check and try again later. | 不允許的操作,請檢查後重試。 |
| 500 | InternalError | %s, please try again later. | 內部錯誤,請稍後重試。 |
| 404 | InvalidCaster.NotFound | %s, please check and try again later. | 導播台不存在,請檢查後重試。 |
| 404 | InvalidScene.NotFound | %s, please check and try again later. | Scene不存在,請檢查後重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。