增加情境音頻配置,將原情境音頻添加到新情境。
介面說明
先通過 CreateCaster 介面建立導播台,再調用本介面更新情境音頻配置。本介面目前支援的音頻模式為混音模式和音頻跟隨視頻模式。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:UpdateCasterSceneAudio |
update |
*Caster
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| AudioLayer |
array<object> |
否 |
音頻配置。 |
|
|
object |
否 |
音頻配置。 |
||
| Filter |
string |
否 |
3A 美音演算法開關。該參數由以下欄位組成:
說明
為保證更好的降噪效果,建議將 ansMode 取值為 1:音樂降噪。
|
{ "enableAgc":0, "enableAns":1 } |
| FixedDelayDuration |
integer |
否 |
該欄位對視頻進行固定延遲設定,可用於字幕同步。 單位:毫秒。取值範圍為0~5000。預設值為 0。 |
0 |
| ValidChannel |
string |
否 |
確定哪些聲道可以作為音量輸入。取值:
|
all |
| VolumeRate |
number |
否 |
調節音頻流的音量大小倍數。取值範圍為0~10.0,預設值為1.0 。
|
1 |
| MixList |
array |
否 |
位置關聯列表,與 audiolayers 順序保持一致。 |
RV01 |
|
string |
否 |
資源位置 LocationId 關聯列表。 與 AudioLayers 順序保持一致,若啟用 Channel 時,引用 Channel 的 LocationId,否則引用視頻源的 LocationId。 |
RV01 |
|
| CasterId |
string |
是 |
導播台 ID。
說明
直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。 |
LIVEPRODUCER_POST-cn-0pp1czt**** |
| SceneId |
string |
是 |
情境 ID。如果您通過 DescribeCasterScenes 介面查詢導播台情境列表,請查看 DescribeCasterScenes 介面調用返回的參數 ComponentId 值。 |
a2b8e671-2fe5-4642-a2ec-bf93880e1**** |
| FollowEnable |
integer |
否 |
是否啟用音頻跟隨。 預設啟用音頻跟隨,為空白則保持最近一次配置不變。取值:
|
1 |
請求參數中的 N 表示第幾個的意思。例如:
AudioLayer.N.VolumeRate 表示傳入第幾個元素的音量倍數。
AudioLayer.1.VolumeRate 表示傳入第 1 個元素的音量倍數。
AudioLayer.2.VolumeRate 表示傳入第 2 個元素的音量倍數。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidCasterId.Malformed | %s, please check and try again later. | 參數CasterId無效,請檢查後重試。 |
| 400 | InvalidUserId.Malformed | %s, please check userId. | 傳入的userId無效,請檢查。 |
| 400 | InvalidParameter.Malformed | There are invalid parameters: %s. | 存在無效參數:%s。 |
| 400 | InvalidAudioLayersAndMixListSize.Mismatch | %s, please check and try again later. | AudioLayers的大小與MixList的大小不匹配,請檢查後重試。 |
| 400 | IncorrectSceneStatus | %s, please check and try again later. | Scene狀態不支援,請檢查後重試。 |
| 400 | IncorrectSceneStatus.ConfigError | %s, please check and try again later. | Scene配置錯誤,請檢查後重試。 |
| 400 | InvalidMixList.ExceedNorm | %s, please check and try again later. | MixList大小超過規格,請檢查後重試。 |
| 401 | IllegalOperation | %s, please check and try again later. | 不允許的操作,請檢查後重試。 |
| 412 | ResourceInChannel.PreConditionFailed | %s, please try again later. | 資源預校正失敗,請稍後重試。 |
| 412 | ResourceInChannel.Invalid | %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不存在,請檢查後重試。 |
| 404 | ResourceInChannel.NotFound | %s, please check and try again later. | 資源不存在,請檢查後重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。