logo
实时音视频
服务端 API
场景服务接口
当前页

AddStream

GET

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

调用本接口可向指定房间增加一路流。多用于“一起看”场景,比如将 CDN 的直播流添加到指定房间,从而让房间内的用户获取流 ID,实现服务端控制指定房间的直播内容。

注意
  • 往指定房间增加流时需要保证该房间是存在的,本接口无法创建房间。若您希望增加流时,自动创建对应房间,请联系 ZEGO 技术支持开启相关功能。
  • 本接口一般与 删除房间流 配合使用,比如业务上需要停止向某个房间广播流。

本接口仅用于抛出房间内流增加的相关通知,不会执行实际的推流操作。开发者需要从自己的客户端,调用 startPublishingStream 接口进行推流(或其它的推流方式),该条被增加的流才能被 startPlayingStream 接口拉流到。

客户端接收房间内流增加的通知使用 ZEGO Express SDK 回调接口:

ZegoExpress SDKLiveRoom SDK
iOS/macOSonRoomStreamUpdateonStreamUpdated
AndroidonRoomStreamUpdateonStreamUpdated
WindowsonRoomStreamUpdateOnStreamUpdated
WebroomStreamUpdateonStreamUpdated
调用频率限制
同一个 AppID 下所有房间:10 次/秒(测试环境:1 次/秒)
注意
  • 不建议使用与房间内实际用户相同的 UserId,避免与客户端 SDK 的流新增行为产生冲突。可以使用特定的名称标识为服务端行为,例如:userId = “Server-Administrator”。
  • 如果使用了与房间内实际用户相同的 UserId(不建议)时,需要注意以下事项:
    • 相应操作人 UserId 的客户端不会收到本服务端接口触发的流增加回调。
    • 如果实际房间内用户 UserId 没有推流,会触发相应 StreamId 的流删除逻辑。
    • 如果实际房间内用户 UserId 退出房间,会触发相应 StreamId 的流删除逻辑。

Request

Query Parameters

    Action stringrequired

    Possible values: [AddStream]

    接口原型参数

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

    AppId uint32required

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

    SignatureNonce stringrequired

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

    Timestamp int64required

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

    Signature stringrequired

    💡公共参数。签名,用于验证请求的合法性。

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

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

    IsTest string

    Possible values: [true, false]

    Default value: false

    💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。

    RoomId stringrequired

    房间 ID。

    UserId stringrequired

    用户 ID。

    UserName string

    用户名。

    StreamId stringrequired

    Possible values: <= 256 characters

    流 ID,不超过 256 字节。

    StreamTitle string

    Possible values: <= 127 characters

    流标题,不超过 127 字节。 使用时,需对其内容执行 URL 编码(UrlEncode)处理。

    ExtraInfo string

    Possible values: <= 1024 characters

    流附加信息,不超过 1024 字节。

    CensorFlag int32

    Possible values: [0, 1]

    Default value: 0

    是否允许送审标识。审核房间流列表时,当前流是否允许审核:0 表示允许,1 表示不允许。

    📌 重要说明

    • 当设置为不允许送审时,审核服务商将不会拉取此条流送审。

    • 在使用流注入方式实现跨房间 PK 的业务场景时,建议将此字段设置为"不允许",以避免同一条流在多个房间内被重复送审。

Responses

操作成功
Schema
    Code int32

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

    返回码说明处理建议
    123设置流信息失败。请重试,或联系 ZEGO 技术支持处理。
    1012多个用户操作同一个流。请检查逻辑。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。


Request
Collapse all
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
query
query
query
query
query
RESPONSEClear

Click the "Send" button above and see the response here!

Previous

获取房间用户列表

Next

删除房间流

当前页

返回到顶部