文档中心
实时音视频
服务端 API
混流转码接口
停止混流

停止混流

更新时间：2024-06-13 16:53

1 描述

调用本接口停止混流。相关回调请参考混流结束回调。

在当前混流任务（以下称为“混流任务 A”）仍在进行的情况下，如果开发者启动新的混流任务（以下称为“混流任务 B”），混流任务 A 不会自动停止。只有在混流任务 A 的所有输入流都不存在后的 90 秒之后，才会自动结束。
在使用 ZEGO 音视频云服务的混流功能时，开发者应注意：在启动混流任务 B 时，应停止混流任务 A，以免导致主播已开启混流任务 B 与其他主播混流，但观众依然在拉取混流任务 A 的输出流。

2 接口原型

请求方法：POST
请求地址：https://rtc-api.zego.im/?Action=StopMix
传输协议：HTTPS
调用频率限制：100 次/秒

使用 POST 请求方法传递参数时：Headers 中，设置 “Content-type” 为 “application/json”。

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式中的 “2.1 公共请求参数”。

名称	类型	是否必选	描述
TaskId	String	是	混流任务 ID，需要和开始混流传入的 TaskId 保持一致。
Sequence	Int	否	混流任务的序列号，用于保证时序，同个任务的参数修改需要保证序列号的递增。
UserId	String	否	用户 ID。当开启混流任务归属时停止某个 TaskId 的混流任务必须输入开始混流任务时指定的 UserId 。

4 请求示例

请求 url

https://rtc-api.zego.im/?Action=StopMix
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0
&IsTest=false

请求消息体

{
  "TaskId": "2213699902971205739", 
  "Sequence": 1, 
  "UserId": "456"
}

5 响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。

6 响应示例

{
    "Code":0,
    "Message":"success",
    "RequestId":"6351841974556802202"
}

7 返回码

以下仅列出了常见的接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
110200001	失败。	请重试。
110200002	输入参数错误。	请参考 Message 信息处理。
110200003	鉴权失败。	请确认鉴权信息是否正确或过期，详情请参考调用方式中的 “3 签名机制”。
110200004	解析输入参数失败。	请检查混流参数是否正确。