全部產品
Search

搜尋本產品

    ApsaraVideo Live：UpdateRtcCloudRecording

    文件中心

    ApsaraVideo Live：UpdateRtcCloudRecording

    更新時間：Jun 26, 2026

    更新 RTC 雲端錄製任務。

    介面說明

    單流錄製支援更新訂閱參數，混流錄製僅支援更新訂閱使用者流。

    QPS 限制

    本介面的單使用者 QPS 限制為 50 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理呼叫。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:UpdateRtcCloudRecording

    update

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    TaskId

    string

    是

    任務 id。由 StartRtcCloudRecording 返回，只支援更新運行中或異常中的任務。

    ******73-8501-****-8ac1-72295a******

    SubscribeParams

    object

    是

    更新後的訂閱相關參數。

    SubscribeUserIdList

    array<object>

    是

    訂閱的 UserId 資訊列表，單流錄製模式下，會對其中每個 UserId 分別進行錄製；混流錄製模式下，會將所有 UserId 的音影片混合到一組音影片中。

    說明

    • 陣列內最多支援 17 個元素。

    object

    否

    訂閱的 UserId 的資訊。

    UserId

    string

    是

    訂閱的 UserId。

    userA
    StreamType

    integer

    否

    訂閱的 UserId 的媒體類型。取值：

    • 0：原始流，即包括音訊和影片。（預設值）

    • 1：僅音訊流。

    • 2：僅影片流。

    枚舉值：

    • 0 :

      原始流，即包括音訊和影片。

    • 1 :

      僅音訊流。

    • 2 :

      僅影片流。

    0
    SourceType

    integer

    否

    該 UserId 的影片輸入流類型，僅針對訂閱影片流時（StreamType=2）有效。取值：

    • 0：攝像頭。（預設值）

    • 1：螢幕共享。

    枚舉值：

    • 0 :

      攝像頭。

    • 1 :

      螢幕共享。

    0
    MixLayoutParams

    object

    否

    更新後的佈局相關參數，單流錄製模式下不填，混流錄製模式下非純音訊轉碼時必填。

    MixBackground

    object

    否

    混流全域背景圖。

    RenderMode

    integer

    否

    畫面輸出時的顯示模式。取值：

    • 0：裁剪。（預設值）

    • 1：縮放並顯示黑底。

    枚舉值：

    • 0 :

      裁剪。

    • 1 :

      縮放並顯示黑底。

    0
    Url

    string

    否

    背景圖 URL，最大長度不超過 2048 個字元。

    https://xxxx.com/photos/my-test-picture.png

    UserPanes

    array<object>

    否

    用於指定訂閱的使用者的視窗佈局資訊，只有設置了佈局資訊的 UserId，才會被放到畫面中。混流模式且錄製非純音訊檔案時必填。

    array<object>

    否

    畫面中視窗配置。

    UserId

    string

    否

    該視窗對應的 UserId。

    • 不設置 UserId 時，會按照訂閱的使用者進入頻道的順序依次填入視窗。

    • 這裡設置的 UserId 與 SourceType 的組合必須包含在 SubscribeUserIdList 中。

    • 訂閱純音訊流是不能加入到佈局中的。

    userA
    SourceType

    integer

    否

    該 UserId 的影片輸入流類型。不填寫 UserId 時，此處設置 SourceType 無效。取值：

    • 0：攝像頭。（預設值）

    • 1：螢幕共享。

    這裡設置的 UserId 與 SourceType 的組合必須包含在 SubscribeUserIdList 中。

    枚舉值：

    • 0 :

      攝像頭。

    • 1 :

      螢幕共享。

    0
    Height

    string

    否

    窗格高度，歸一化百分比。取值範圍須在[0,1]內。(預設為 0)。

    0.5
    Width

    string

    否

    窗格寬度，歸一化百分比。取值範圍須在[0,1]內。(預設為 0)。

    0.5
    X

    string

    否

    座標 X，歸一化百分比。取值範圍須在[0,1]內。(預設為 0)。

    0
    Y

    string

    否

    座標 Y，歸一化百分比。取值範圍須在[0,1]內。(預設為 0)。

    0
    ZOrder

    integer

    否

    疊放順序，0 為最底層，1 層在 0 層之上，以此類推。(預設為 0)。

    0
    SubBackground

    object

    否

    子畫面背景圖，當使用者關閉攝像頭、或入會後未推流、或入會後中途離會時，會在佈局位置填充為對應的圖片。

    RenderMode

    integer

    否

    子畫面輸出時的顯示模式。取值：

    • 0：裁剪。（預設值）

    • 1：縮放並顯示黑底。

    枚舉值：

    • 0 :

      裁剪。

    • 1 :

      縮放並顯示黑底。

    0
    Url

    string

    否

    背景圖 URL，最大長度不超過 2048 個字元。

    https://xxxx.com/photos/my-test-pane-picture.png

    • 支援同時訂閱同一個 UserId 的攝像頭和螢幕共享。對於單流錄製模式，如果要同時訂閱同一個 UserId 的攝像頭和螢幕共享，FileNamePattern 和 SliceNamePattern 中必須包含 SourceType 變數（避免出現錄製檔案互相覆蓋的情況）。

    • 對於單流錄製模式，目前不支援只訂閱某個 UserId 的純影片流。即在單流模式下，UserInfo.StreamType 的值不能設置為 2。

    • 如果只希望錄製某個 UserId 的螢幕流，而不錄製音訊流，要麼訂閱該 UserId 的純影片流並設置 SourceType 為 1（單流錄製模式下暫時不支援），要麼訂閱該 UserId 的原始流並在推流時影片流只推螢幕流，且不推音訊流或靜音；如果希望錄製某個 UserId 的螢幕流和音訊流，要麼訂閱該 UserId 的原始流並在推流時影片流只推螢幕流，且同時推音訊流，要麼訂閱該 UserId 的純影片流並設置 SourceType 為 1（單流錄製模式下暫時不支援），同時訂閱該 UserId 的純音訊流。

    • 在單流錄製模式下，如果 RecordParams.StreamType 是純音訊流（值為 1），那麼 SubscribeParams 中不能存在訂閱純影片的情況（值為 2）；如果 RecordParams.StreamType 是純影片流（值為 2），那麼 SubscribeParams 中不能存在訂閱純音訊的情況（值為 1）。

    • 在混流錄製模式下，如果 RecordParams.StreamType 是純音訊流（值為 1），那麼 SubscribeParams 中不能所有 UserId 都只訂閱純影片（值為 2）；如果 RecordParams.StreamType 是純影片流（值為 2），那麼 SubscribeParams 中不能所有 UserId 都只訂閱純音訊（值為 1）。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 id。

    ******58-5876-****-83CA-B56278******

    TaskId

    string

    任務 id。

    ******73-8501-****-8ac1-72295a******

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "******58-5876-****-83CA-B56278******\n",
  "TaskId": "******73-8501-****-8ac1-72295a******\n"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 NotFound.Task %s, please check the TaskId.
    400 InvalidParameter.TaskId %s, please check the TaskId.
    400 InvalidParameter.SubscribeParams.SubscribeUserIdList %s, please check the subscribeUserIdList of subscribeParams.
    400 InvalidParameter.MixLayoutParams.UserPanes %s, please check the userPanes of mixLayoutParams.
    400 InvalidParameter.MixTranscodeParams %s, please check the transcodeParams.
    400 MissingParameter %s.
    403 InvalidParameter.UserId %s, please check the UserId.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。