調用SetCasterConfig配置導播臺。
使用說明
先通過CreateCaster接口創建導播臺,再調用本接口配置導播臺。全量覆蓋配置信息,若指定參數置為空則清除導播臺該項配置。
QPS限制
本接口的單用戶QPS限制為10次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。更多信息,請參見QPS限制。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | SetCasterConfig | 系統規定參數。取值:SetCasterConfig。 |
CasterId | String | 是 | a2b8e671-2fe5-4642-a2ec-bf93880e**** | 導播臺ID。
說明 直播控制臺云導播臺頁面導播臺列表中的導播臺名稱即導播臺ID。 |
CasterName | String | 否 | liveCaster**** | 導播臺名稱。 |
DomainName | String | 否 | example.com | 主播流域名。 請您在導播臺啟動前完成域名配置。 若該參數為空,默認清除導播臺域名配置。 |
TranscodeConfig | String | 否 | {"casterTemplate": "lp_ld"} | 轉碼配置。 JSON格式字符串,結構體內部字段請按首字母大寫,駝峰格式輸入。 若該參數設置為空,默認清除轉碼配置, 當轉碼模板為空的時候,導播臺啟動時會報錯。 |
RecordConfig | String | 否 | { "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 } | 錄制配置信息。格式為JSON。配置元素信息如下:
說明 參數設置為空時表示不啟用錄制功能。 若該參數置為空,默認清除錄制配置。 |
Delay | Float | 否 | 0 | 延時播放。時間單位:秒。
|
UrgentMaterialId | String | 否 | a2b8e671 | 備播視頻,媒資庫素材ID。若該參數置為空,默認清除備播配置。 |
UrgentLiveStreamUrl | String | 否 | rtmp://demo.aliyundoc.com | 備播直播流URL。 |
SideOutputUrl | String | 否 | rtmp://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**** | 用戶自定義導播臺旁路輸出地址對應的推流地址。 若該參數為空,則默認使用阿里云自動生成的輸出地址對應的推流地址。 說明 目前sideoutputUrl只支持rtmp協議推流。 |
SideOutputUrlList | String | 否 | rtmp://domain/app/stream?*** | 多路轉推流地址列表,可以是阿里云或第三方廠商的CDN推流地址,一個導播臺最多支持添加20個RTMP轉推地址。 |
CallbackUrl | String | 否 | http://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**** | 用戶回調地址。若需要接收回調通知,請輸入可用的接收地址,接受HTTP協議。 若該參數置為空,默認取消導播臺回調通知。 |
ProgramEffect | Integer | 否 | 1 | 輪播生效標志。
|
ProgramName | String | 否 | program_name | 輪播臺名稱,若使用輪播功能時可配置。 |
ChannelEnable | Integer | 否 | 1 | 是否啟用Channel。
說明 默認不啟用,且啟用后不可取消;不啟用時Resource直接被布局引用,首次開啟Channel需要在導播臺停止的狀態下進行,之前已存在的布局將被廢棄,Resource需要首先設置到Channel中,新增的布局直接引用Channel,通過Channel可調整視頻源播放進度和播放狀態,該模式下視頻源、PVW、PGM三區域若引用同一Resource,則對應畫面將保持同步。 |
SyncGroupsConfig | String | 否 | "[{\"mode\":0,\"resourceIds\":[\"5a6c1c33-8424-46f6-813c-c152220a****\",\"4e6521dc-a40a-4077-b6bf-1fb12a76****\"],\"hostResourceId\":\"3aa2b39a-fd0e-4b8c-be73-b7af31c4****\"}]" | 多視角同步配置,讓多個視頻源同步。 多視角同步分為兩個模式:
主播模式:hostResourceId:主播模式下的主播視頻源 會議模式:沒有hostRsoureId 字段,只提供需要提供的resourceIds 中的資源ids |
UrgentImageId | String | 否 | a089175eb5f4427684fc0715159a**** | 備播媒資庫圖片素材ID。 |
UrgentImageUrl | String | 否 | http://learn.aliyundoc.com/AppName/image.jpg | 備播圖片素材URL。 |
AutoSwitchUrgentOn | Boolean | 否 | true | 開啟斷流自動切換備播。
|
AutoSwitchUrgentConfig | String | 否 | {"eofThres":3} | 自動切備播配置。
|
返回數據
名稱 |
類型 |
示例值 |
描述 |
CasterId | String | b4810848-bcf9-4aef-bd4a-e6bba2d9**** | 導播臺ID。可作為查詢導播臺流地址、啟動導播臺、添加導播臺視頻資源、添加導播臺布局、查詢導播臺布局列表、添加導播臺組件和添加導播臺節目單的請求參數。 |
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 | 請求ID。 |
示例
請求示例
http(s)://live.aliyuncs.com/?Action=SetCasterConfig
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&<公共請求參數>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<SetCasterConfigResponse>
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
<casterId>b4810848-bcf9-4aef-bd4a-e6bba2d9****</casterId>
</SetCasterConfigResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"SetCasterConfigResponse" : {
"RequestId" : "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"casterId" : "b4810848-bcf9-4aef-bd4a-e6bba2d9****"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。