# 布局混流

# 1 开启混流

接口地址	方法	说明
BaseUrl/api/v1/channel/startMix/{appId}/{channelName}	POST	开启混流

PathVariable：

参数	长度	描述
appId	32位字符串	控制台中项目的APP ID（应用标识ID）
channelName	32位字符串	channelName

RequestBody： Content-Type="application/json;charset=utf8"

参数	描述
view	可选，视图名称,默认是common
layoutType	可选，布局类型(auto,fixed),默认是auto
layoutId	可选，布局ID,默认是stacked (stacked 堆叠布局,allEqualQuarters 4分屏,allEqualNinths 9分屏,allEqualSixteenths 16分屏)

响应状态码：

参数	描述
200	成功
400	失败，参数错误或请求地址不存在
401	未授权，未经授权的（App ID/Customer Certificate 匹配错误）。
500	系统内部错误

响应数据：

实例：
[POST] https://192.168.2.251/client/api/v1/channel/startMix/5f9105ce7255ff666a9109d7/5f5700276736dc5f76ba5120
请求JSON数据：
{
    "view":"mixWithOutScreen",// 混流标签名称(必填)
    "layoutType":"auto",
    "layoutId":"stacked",
    "mixDrawNameStatus": "enable" || "disable",  // 混流小窗是否显示昵称，默认："enable"
    "mixBackgroundType": "color"  || "file",     // 混流背景类型，默认："color"
    "mixBackgroundFileUrl": "bg1_1920x1080.yuv" || "https://xx.yuv", //YUV文件地址，默认："bg1_1920x1080.yuv"
    "bgColor" : {
        "r" : 0,
        "g" : 0,
        "b" : 0
    },
}
响应：
{
    "msg": "ok",
    "code": 200
}

# 2 停止混流

接口地址	方法	说明
BaseUrl/api/v1/channel/stopMix/{appId}/{channelName}	POST	停止混流

PathVariable：

参数	长度	描述
appId	32位字符串	控制台中项目的APP ID（应用标识ID）
channelName	32位字符串	channelName

RequestBody： Content-Type="application/json;charset=utf8"

参数	描述
view	视图名称

响应状态码：

参数	描述
200	成功
400	失败，参数错误或请求地址不存在
401	未授权，未经授权的（App ID/Customer Certificate 匹配错误）。
500	系统内部错误

响应数据：

实例：
[POST] https://192.168.2.251/client/api/v1/channel/stopMix/5f9105ce7255ff666a9109d7/5f5700276736dc5f76ba5120
请求JSON数据：
{
    "view":"common",
}
响应：
{
    "msg": "ok",
    "code": 200
}

# 3 更新布局

接口地址	方法	说明
BaseUrl/api/v1/channel/changeMixLayout/{appId}/{channelName}/{streamId}/{layoutId}	POST	更新布局

PathVariable：

参数	长度	描述
appId	32位字符串	控制台中项目的APP ID（应用标识ID）
channelName	32位字符串	channelName
streamId		流ID
layoutId		布局ID,(stacked 堆叠布局,allEqualQuarters 4分屏,allEqualNinths 9分屏,allEqualSixteenths 16分屏)

响应状态码：

参数	描述
200	成功
400	失败，参数错误或请求地址不存在
401	未授权，未经授权的（App ID/Customer Certificate 匹配错误）。
500	系统内部错误

响应数据：

实例：
[POST] http://localhost:9208/api/v1/channel/changeMixLayout/5f9105ce7255ff666a9109d7/5fb218e0dbf6fd19c417aae9/5fb218e0dbf6fd19c417aae9-common/allEqualSixteenths
请求JSON数据：
{}
响应：
{
    "msg": "操作成功",
    "code": 200
}

# 4 向混流中添加指定流

接口地址	方法	说明
BaseUrl/api/v1/channel/addStreamInMix/{appId}/{channelName}/{streamId}	POST	向混流中添加指定流

PathVariable：

参数	长度	描述
appId	32位字符串	控制台中项目的APP ID（应用标识ID）
channelName	32位字符串	channelName
streamId		流ID

RequestBody： Content-Type="application/json;charset=utf8"

参数	描述
view	视图名称

响应状态码：

参数	描述
200	成功
400	失败，参数错误或请求地址不存在
401	未授权，未经授权的（App ID/Customer Certificate 匹配错误）。
500	系统内部错误

响应数据：

实例：
[POST] https://192.168.2.251/client/api/v1/channel/addStreamInMix/5f9105ce7255ff666a9109d7/5f5700276736dc5f76ba5120/330325372378468300
请求JSON数据：
{
    "view":"common",
}
响应：
{
    "msg": "操作成功",
    "code": 200,
}

# 5 从混流中移除指定流

接口地址	方法	说明
BaseUrl/api/v1/channel/removeStreamInMix/{appId}/{channelName}/{streamId}	POST	从混流中移除指定流

PathVariable：

参数	长度	描述
appId	32位字符串	控制台中项目的APP ID（应用标识ID）
channelName	32位字符串	channelName
streamId		流ID

RequestBody： Content-Type="application/json;charset=utf8"

参数	描述
view	视图名称

响应状态码：

参数	描述
200	成功
400	失败，参数错误或请求地址不存在
401	未授权，未经授权的（App ID/Customer Certificate 匹配错误）。
500	系统内部错误

响应数据：

实例：
[POST] https://192.168.2.251/client/api/v1/channel/removeStreamInMix/5f9105ce7255ff666a9109d7/5f5700276736dc5f76ba5120/330325372378468300
请求JSON数据：
{
    "view":"common",
}
响应：
{
    "msg": "操作成功",
    "code": 200
}

← 频道录播直播 →