ForbidRTCStream
https://rtc-api.zego.im/
调用本接口禁止 RTC 推流,可以禁止指定流 ID 推送到 RTC 服务。禁止推流操作会向正在推流的客户端和正在拉流的客户端发送推流被禁止的通知。
推流客户端接收推流被服务端禁止的通知使用 ZEGO Express SDK 回调接口:
平台 | ZegoExpress SDK | LiveRoom SDK | ||
---|---|---|---|---|
接口 | 错误码 | 接口 | 错误码 | |
iOS/macOS | onPublisherStateUpdate | 1003025 | onPublishStateUpdate | 12301011 |
Android | onPublisherStateUpdate | 1003025 | onPublishStateUpdate | 12301011 |
Windows | onPublisherStateUpdate | 1003025 | OnPublishStateUpdate | 12301011 |
拉流客户端接收所拉流被服务端禁止的通知使用 ZEGO Express SDK 回调接口:
平台 | ZegoExpress SDK | LiveRoom SDK | ||
---|---|---|---|---|
接口 | 错误码 | 接口 | 错误码 | |
iOS/macOS | onPlayerStateUpdate | 1004025 | onPlayStateUpdate | 12301011 |
Android | onPlayerStateUpdate | 1004025 | onPlayStateUpdate | 12301011 |
Windows | onPlayerStateUpdate | 1004025 | OnPlayStateUpdate | 12301011 |
测试环境下(详见 IsTest 公共参数说明),流 ID 需要加上 “zegotest-AppId-” 前缀。例如,流 ID 为 “test”,在 AppId 为 “123456789” 的测试环境下,流 ID 应为 “zegotest-123456789-test”。
Request
Query Parameters
Possible values: [ForbidRTCStream
]
接口原型参数
https://rtc-api.zego.im?Action=ForbidRTCStream
💡公共参数。AppId,ZEGO 分配的用户唯一凭证。
💡公共参数。随机字符串。
💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。
💡公共参数。签名,用于验证请求的合法性。
Possible values: [2.0
]
Default value: 2.0
💡公共参数。签名版本号。
Possible values: [true
, false
]
Default value: false
💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。
流 ID。
请求序列号。
注意
对于同一个流 StreamId,连续 10 秒内,必须保证发出的该 StreamId 的请求序列号是严格递增的;避免服务端收到请求的时序不一致而导致操作错乱。
如果没有并发场景,推荐使用时间戳(毫秒级别)。
Responses
- 200
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL