全部產品
Search
文件中心

:CreateMixStream - 建立合流任務

更新時間:Aug 15, 2025

建立合流任務。

介面說明

重要

雲端合流屬於收費功能,當前為公測階段,您可以免費使用,公測結束後將正常收費,具體時間另行通知。

調用本介面建立合流任務,目前本介面支援的布局類型為預設布局和自訂布局。

QPS 限制

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

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:CreateMixStream

create

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

地區 ID。

cn-shanghai

DomainName

string

主播流網域名稱。

重要

目前僅支援華東 2(cn-shanghai)和華北 2(cn-beijing)兩個地區的網域名稱。

example.com

LayoutId

string

布局 ID。取值:

  • MixStreamLayout-1-1

  • MixStreamLayout-2-1

  • MixStreamLayout-2-2

  • MixStreamLayout-2-3

  • MixStreamLayout-3-1

  • MixStreamLayout-3-2

  • MixStreamLayout-4-1

  • USERDEFINED(非上述預設布局,固定取值 USERDEFINED

說明

更多資訊請參見合流預設布局參考

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

資源類型。
live:直播流地址。
url:檔案流地址。




ResourceValue

String

資源地址。
如果 ResourceType 為 live,則為直播流地址。直播流地址支援 RTMP、FLV 和 HLS 協議,不支援 ARTC 協議。
如果 ResourceType 為 url,則為檔案流地址。




LayoutChildId

String

布局方格對應 ID(也代表合流的疊加順序)。

LayoutConfig

LayoutConfig[]

JSON 數組,代表所在位置、填充方式等布局資訊。
如果使用預設布局,則此參數可以不填。
如果設定了該值,則忽略 LayoutChildId 對應的預設布局資訊。




LayoutConfig

名稱

類型

必選

描述

FillSizeNormalized

JSON 浮點數組

必選

表示該 Layer 元素需要填充的尺寸大小。
[w,h]:w、h 取值範圍[0-1]。其中寬高都是進行了歸一化計算。
例如:[0.2,0.3]代表水平佔比 20%,垂直佔比 30%。




FillPositionNormalized

浮點數數組

必選

表示該 Layer 元素填充區位置歸一化值。
[x,y]:x、y 的取值範圍[0-1]。
例如:[0.1,0.1]代表左上方水平位移 10%, 垂直位移 10%。




PositionRefer

字串

可選

設定元素的 position 參考座標值。
建議設定 topLeft,代表左上方。

FillMode

字串

可選

設定元素填充方式。
none:不填充。
fit:縮放填充保證最長的邊達到邊界,而最短的邊可能需要加黑邊。
fill:先按照寬和高的最大比例值進行等比縮放,然後進行 crop,保證全部填充。
建議設定為 fit。










OutputConfig

名稱

類型

必選

描述

AppName

String

輸出 App 名。不支援#、?等特殊字元。

StreamName

String

輸出資料流名。不支援#、?等特殊字元。

MixStreamTemplate

String

合流輸出規格模板 ID (在傳參時僅傳模板 ID,例如 lp_ld)。
支援:
lp_ld(解析度:640x360),
lp_sd(解析度:854x480),
lp_hd(解析度:1280x720),
lp_ud(解析度:1920x1080),
lp_ld_v(解析度:640x360),
lp_sd_v(解析度:854x480),
lp_hd_v(解析度:1280x720),
lp_ud_v(解析度:1920x1080) ,
lp_ld_v_optm(解析度:640x360),
lp_sd_v_optm(解析度:854x480),
lp_hd_v_optm(解析度:1280x720),
lp_ud_v_optm(解析度:1920x1080)。
_v 表示豎屏模板,_optm 表示低延遲模板,括弧裡表示模板的解析度。








































ExpireDuration

Long

可選

任務到期時間。單位:秒。取值範圍:1~31536000(1 年)。
如果不設定預設 7 天到期清理任務。

返回參數

名稱

類型

描述

樣本值

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

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

變更歷史

更多資訊,參考變更詳情