DeleteStream
GET
https://rtc-api.zego.im/
调用本接口删除某个房间的指定流,与 踢出房间用户 不同的是,这路流对应的用户是仍在房间内的。可通过本接口强制“下麦”某个用户,或者在“一起看”场景里删掉增加的 CDN 直播流。
本接口仅用于抛出房间内流删除的相关通知,不会执行实际的停止推流操作。开发者需要从自己的客户端,调用 stopPublishingStream 接口停止推流,才会停止向流媒体传输音视频数据;相应的拉流端,需要调用客户端 stopPlayingStream 接口停止拉流,才会停止从流媒体接收音视频数据。
客户端接收房间内流减少的通知使用 ZEGO Express SDK 回调接口:
| ZegoExpress SDK | LiveRoom SDK | |
|---|---|---|
| iOS/macOS | onRoomStreamUpdate | onStreamUpdated |
| Android | onRoomStreamUpdate | onStreamUpdated |
| Windows | onRoomStreamUpdate | OnStreamUpdated |
| Web | roomStreamUpdate | onStreamUpdated |
调用频率限制
同一个 AppID 下所有房间:10 次/秒(测试环境:1 次/秒)
注意
调用本服务端接口时:
- 不建议使用与房间内实际用户相同的 UserId,避免与客户端 SDK 的流删除行为产生冲突。可以使用特定的名称标识为服务端行为,例如:userId = “Server-Administrator”。
- 如果使用了与房间内实际用户相同的 UserId(不建议)时,相应操作人 UserId 的客户端不会收到本服务端接口触发的流删除回调,房间内的其他用户会收到流删除回调。
Request
Query Parameters
Action string必填
可选值: [DeleteStream]
接口原型参数
https://rtc-api.zego.im?Action=DeleteStream
AppId uint32必填
💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。
Signature string必填
💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
RoomId string必填
房间 ID。
UserId string必填
用户 ID。
UserName string
用户名。
StreamId string必填
流 ID。
Responses
- 200
操作成功
- application/json

