建立合流任務。
介面說明
雲端合流屬於收費功能,當前為公測階段,您可以免費使用,公測結束後將正常收費,具體時間另行通知。
調用本介面建立合流任務,目前本介面支援的布局類型為預設布局和自訂布局。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:CreateMixStream |
create |
*Domain
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-shanghai |
| DomainName |
string |
是 |
主播流網域名稱。 重要
目前僅支援華東 2(cn-shanghai)和華北 2(cn-beijing)兩個地區的網域名稱。 |
example.com |
| LayoutId |
string |
是 |
布局 ID。取值:
說明
更多資訊請參見合流預設布局參考 |
MixStreamLayout-1-1 |
| InputStreamList |
string |
是 |
合流輸入列表。JSON 數組。 參考下方的 InputStreamConfig。 |
[{"LayoutChildId":1,"ResourceType":"live","ResourceValue":"rtmp://example.net/live/f2139ec2b8d6a191068cd****ea9064d?auth_key=1600947017-0-0-0b5645fe35d21a65ab92b394bd4d****","LayoutConfig":{"FillMode":"fit","PositionRefer":"topLeft","FillPositionNormalized":[0,0],"FillSizeNormalized":[1,1]}}] |
| OutputConfig |
string |
是 |
合流輸出配置。格式為 JSON 字串。 參考下方的 OutputConfig。 |
{"AppName":"liveApp****","StreamName":"9a78fb3f5c508be0122746f677a3****","MixStreamTemplate":"lp_hd_v","ExpireDuration":"86400"} |
| CallbackConfig |
string |
否 |
回調地址。JSON 數組。 當事件產生時,直播服務端會向該地址發起 HTTP POST 請求,具體內容將通過 HTTP Body 送達。 |
{"CallbackUrl":"http://aliyundoc.com"} |
InputStreamConfig
名稱 | 類型 | 描述 |
ResourceType | String | 資源類型。 |
ResourceValue | String | 資源地址。 |
LayoutChildId | String | 布局方格對應 ID(也代表合流的疊加順序)。 |
LayoutConfig | LayoutConfig[] | JSON 數組,代表所在位置、填充方式等布局資訊。 |
LayoutConfig
名稱 | 類型 | 必選 | 描述 |
FillSizeNormalized | JSON 浮點數組 | 必選 | 表示該 Layer 元素需要填充的尺寸大小。 |
FillPositionNormalized | 浮點數數組 | 必選 | 表示該 Layer 元素填充區位置歸一化值。 |
PositionRefer | 字串 | 可選 | 設定元素的 position 參考座標值。 |
FillMode | 字串 | 可選 | 設定元素填充方式。 |
OutputConfig
名稱 | 類型 | 必選 | 描述 |
AppName | String | 是 | 輸出 App 名。不支援#、?等特殊字元。 |
StreamName | String | 是 | 輸出資料流名。不支援#、?等特殊字元。 |
MixStreamTemplate | String | 是 | 合流輸出規格模板 ID (在傳參時僅傳模板 ID,例如 lp_ld)。 |
ExpireDuration | Long | 可選 | 任務到期時間。單位:秒。取值範圍:1~31536000(1 年)。 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| MixStreamId |
string |
合流任務 ID。可作為查詢合流工作清單和刪除合流任務的請求參數。 |
5b2a046e-74d7-385e-253f-8a5b87e4**** |
| RequestId |
string |
請求 ID。 |
0D715397-2E66-4AE1-694h-C546628AD145 |
樣本
正常返回樣本
JSON格式
{
"MixStreamId": "5b2a046e-74d7-385e-253f-8a5b87e4****",
"RequestId": "0D715397-2E66-4AE1-694h-C546628AD145"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidUserId.Malformed | %s | |
| 400 | InvalidParameter.Malformed | %s | |
| 400 | MissingParameter | %s | |
| 401 | IllegalOperation | %s | |
| 500 | InternalError | %s | |
| 403 | MixStreamAlreadyExist | %s | |
| 403 | MixStreamNotExist | %s | |
| 403 | UserQuotaExceed | %s | |
| 404 | InvalidDomainName.NotFound | %s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。