logo
实时语音
服务端 API
当前页

停止混流


描述

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

注意
  • 在当前混流任务(以下称为“混流任务 A”)仍在进行的情况下,如果开发者启动新的混流任务(以下称为“混流任务 B”),混流任务 A 不会自动停止。只有在混流任务 A 的所有输入流都不存在后的 90 秒之后,才会自动结束。

  • 在使用 ZEGO 音视频云服务的混流功能时,开发者应注意:在启动混流任务 B 时,应停止混流任务 A,以免导致主播已开启混流任务 B 与其他主播混流,但观众依然在拉取混流任务 A 的输出流。

接口原型

  • 请求方法:POST
说明

使用 POST 请求方法传递参数时:

  • Body 中的参数直接传 JsonObject 格式即可,无需序列化为 String 格式。
  • Headers 中,设置 “Content-type” 为 “application/json”。
  • 请求地址:https://rtc-api.zego.im/?Action=StopMix
  • 传输协议:HTTPS
  • 调用频率限制:100 次/秒

请求参数

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

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

请求示例

  • 请求 URL

    https://rtc-api.zego.im/?Action=StopMix
    &<公共请求参数>
  • 请求消息体

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

响应参数

参数类型描述
CodeNumber返回码。
MessageString操作结果描述。
RequestIdString请求 ID。

响应示例

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

返回码

以下仅列出了接口业务逻辑相关的部分返回码,完整返回码请参考 全局返回码

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

Previous

开始混流

Next

查询混流任务信息