全部產品
Search

搜尋本產品

    ApsaraVideo Live：SetCasterConfig - 設定導播台配置

    文件中心

    ApsaraVideo Live：SetCasterConfig - 設定導播台配置

    更新時間：Aug 15, 2025

    調用本介面對導播台進行詳細配置，包括導播台的名稱、轉碼配置、錄製配置等參數資訊。

    介面說明

    先通過 CreateCaster 介面建立導播台，再調用本介面對導播台進行詳細配置。此介面將會全面替換現有的配置資訊，如果您將某個參數設定為空白，則會清除該參數在導播台中的現有配置。

    QPS 限制

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

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:SetCasterConfig

    update

    *Caster

    acs:live:*:{#accountId}:caster/{#CasterId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地區 ID。

    cn-shanghai
    CasterId

    string

    是

    導播台 ID。

    • 如果您通過 CreateCaster 介面建立導播台，請查看 CreateCaster 介面調用返回的參數 CasterId 值。

    • 如果您通過直播控制台建立導播台，請通過直播控制台 > 導播台 > 雲導播台頁面查看。

    說明

    直播控制台雲導播台頁面導播台列表中的導播台名稱即導播台 ID。

    a2b8e671-2fe5-4642-a2ec-bf93880e****
    CasterName

    string

    否

    導播台名稱。

    liveCaster****
    DomainName

    string

    否

    主播流網域名稱。

    請您在導播台啟動前完成網域名稱配置。 若該參數為空白，預設清除導播台網域名稱配置。

    example.com
    TranscodeConfig

    string

    否

    轉碼配置。

    JSON 格式字串，結構體內部欄位請按首字母大寫，駝峰格式輸入。 若該參數設定為空白，預設清除轉碼配置， 當轉碼模板為空白的時候，導播台啟動時會報錯。

    {"casterTemplate": "lp_ld"}
    RecordConfig

    string

    否

    錄製配置資訊。格式為 JSON。配置元素資訊如下：

    • endpoint：阿里雲服務的 API 服務端地址。

    • ossBucket：ossBucket 名稱。

    • videoFormat：支援匯出的視頻檔案格式，例如：[{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"record/{AppName}/{StreamName}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}]。

    • interval：時間間隔，單位為毫秒（ms）。

    說明

    參數設定為空白時表示不啟用錄製功能。 若該參數置為空白，預設清除錄製配置。

    { "endpoint": "http://oss-cn-********.aliyuncs.com/api", "ossBucket****": "liveBucket****", "VideoFormat":[{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"record/{AppName}/{StreamName}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}] "interval": 5 }
    Delay

    number

    否

    延時播放。時間單位：秒。

    • 0（預設值）：禁用延時。

    • 大於 0：啟用延時。

    • 空：預設清除延播配置。

    說明

    最大可支援設定 300 秒。

    0
    UrgentMaterialId

    string

    否

    備播視頻，媒資庫素材 ID。若該參數置為空白，預設清除備播配置。

    a2b8e671
    UrgentLiveStreamUrl

    string

    否

    備播直播流 URL。

    rtmp://demo.aliyundoc.com
    SideOutputUrl

    string

    否

    使用者自訂導播台旁路輸出地址對應的推流地址。 若該參數為空白，則預設使用阿里雲自動產生的輸出地址對應的推流地址。

    說明

    目前 sideoutputUrl 只支援 rtmp 協議推流。

    rtmp://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
    SideOutputUrlList

    string

    否

    多路轉推流地址清單，可以是阿里雲或第三方廠商的 CDN 推流地址，一個導播台最多支援添加 20 個 RTMP 轉推地址。

    說明

    多個地址用["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]數組格式。

    rtmp://domain/app/stream?***
    CallbackUrl

    string

    否

    使用者回調地址。若需要接收回調通知，請輸入可用的接收地址，接受 HTTP 協議。 若該參數置為空白，預設取消導播台回調通知。

    說明

    導播台回調詳細資料，請參見雲導播回調資訊說明。

    http://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
    ProgramEffect

    integer

    否

    輪播生效標誌。

    • 0：不生效。

    • 1：生效。

    1
    ProgramName

    string

    否

    輪播台名稱，若使用輪播功能時可配置。

    program_name
    ChannelEnable

    integer

    否

    是否啟用 Channel。

    • 0（預設）：不啟用。

    • 1：啟用。

    說明

    預設不啟用，且啟用後不可取消；不啟用時 Resource 直接被布局引用，首次開啟 Channel 需要在導播台停止的狀態下進行，之前已存在的布局將被廢棄，Resource 需要首先設定到 Channel 中，新增的布局直接引用 Channel，通過 Channel 可調整視頻源播放進度和播放狀態，該模式下視頻源、PVW、PGM 三地區若引用同一 Resource，則對應畫面將保持同步。

    1
    SyncGroupsConfig

    string

    否

    多視角同步配置，讓多個視頻源同步。 多視角同步分為兩個模式：

    • mode: 0（主播模式，多個視頻源根據指定的模式同步。）

    • mode: 1（多方通話，沒有主播視頻的概念，所有視頻源相互同步。）

    主播模式：hostResourceId：主播模式下的主播視頻源

    多方通話：沒有 hostRsoureId 欄位，只提供需要提供的 resourceIds 中的資源 ids

    "[{\"mode\":0,\"resourceIds\":[\"5a6c1c33-8424-46f6-813c-c152220a****\",\"4e6521dc-a40a-4077-b6bf-1fb12a76****\"],\"hostResourceId\":\"3aa2b39a-fd0e-4b8c-be73-b7af31c4****\"}]"
    UrgentImageId

    string

    否

    備播媒資庫圖片素材 ID。

    a089175eb5f4427684fc0715159a****
    UrgentImageUrl

    string

    否

    備播圖片素材 URL。

    http://learn.aliyundoc.com/AppName/image.jpg
    AutoSwitchUrgentOn

    boolean

    否

    開啟斷流自動切換備播。

    • true：開啟。

    • false：關閉。

    true
    AutoSwitchUrgentConfig

    string

    否

    自動切備播配置。 eofThres：表示斷流時間後自動切備播，單位為秒。

    {"eofThres":3}

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    CasterId

    string

    導播台 ID。可作為查詢導播台流地址、啟動導播台、添加導播台視頻資源、添加導播檯布局、查詢導播檯布局列表、添加導播台組件和添加導播台節目單的請求參數。

    b4810848-bcf9-4aef-bd4a-e6bba2d9****
    RequestId

    string

    請求 ID。

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    樣本

    正常返回樣本

    JSON格式

    {
  "CasterId": "b4810848-bcf9-4aef-bd4a-e6bba2d9****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidUserId.Malformed %s
    400 InvalidCasterId.Malformed %s
    400 InvalidParameter.Malformed %s
    400 IncorrectCasterStatus.Inuse %s
    400 InvalidCaster.ChannelDisableUnsupported %s
    400 IncorrectCasterStatus.EnableChannel %s
    400 MissingParameter %s
    500 InternalError %s
    403 PermissionDenied %s
    404 InvalidCaster.NotFound %s
    404 InvalidDomainName.NotFound %s

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

    變更歷史

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