StopMix

POST

https://rtc-api.zego.im/

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

注意

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

调用频率限制

同一个 AppID 下所有房间：100 次/秒

Request

Query Parameters

Action string必填

可选值: [StopMix]

接口原型参数

https://rtc-api.zego.im?Action=StopMix

AppId uint32必填

💡公共参数。AppId，ZEGO 分配的用户唯一凭证。

SignatureNonce string必填

💡公共参数。随机字符串。

Timestamp int64必填

💡公共参数。Unix 时间戳，单位为秒。最多允许 10 分钟的误差。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

application/json

Body

required

TaskId string必填

混流任务 ID，需要和开始混流传入的 TaskId 保持一致。

Sequence int32

混流任务的序列号，用于保证时序，同个任务的参数修改需要保证序列号的递增。

UserId string

用户 ID。当开启混流任务归属时停止某个 TaskId 的混流任务必须输入开始混流任务时指定的 UserId 。

Responses

操作成功

application/json

数据结构
按数据结构生成的示例

Schema

Code int32

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

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

Message string

操作结果描述。

RequestId string

请求 ID。

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

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

CURL

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。