Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZegoRealTimeSequentialDataManager

Hierarchy

Index

Methods

Abstract getIndex

  • getIndex(): number
  • 获取实时有序数据管理器索引。

    Returns number

    实时有序数据管理器索引。

Abstract off

  • off<RealTimeSequentialDataEventType>(event: RealTimeSequentialDataEventType, callback: undefined | ZegoRealTimeSequentialDataEventHandler[RealTimeSequentialDataEventType]): void
  • 注销监听实时有序数据事件回调

    Type parameters

    Parameters

    • event: RealTimeSequentialDataEventType

      事件类型。

    • callback: undefined | ZegoRealTimeSequentialDataEventHandler[RealTimeSequentialDataEventType]

      事件回调。

    Returns void

Abstract on

  • on<RealTimeSequentialDataEventType>(event: RealTimeSequentialDataEventType, callback: ZegoRealTimeSequentialDataEventHandler[RealTimeSequentialDataEventType]): void
  • 注册监听实时有序数据事件回调

    Type parameters

    Parameters

    • event: RealTimeSequentialDataEventType

      事件类型。

    • callback: ZegoRealTimeSequentialDataEventHandler[RealTimeSequentialDataEventType]

      事件回调。

    Returns void

Abstract sendRealTimeSequentialData

  • 在广播中的流 ID 上发送实时有序数据

    支持版本:2.14.0 及以上。 详情描述:可通过此函数在当前正在广播中的流上发送实时有序数据。 业务场景:当需要发送实时有序数据时需要调用此函数。 调用时机:调用了 [startBroadcasting] 成功开始广播后调用。 使用限制:无 注意事项:无

    Parameters

    • data: Uint8Array

      要发送的实时有序数据数据。

    • streamID: string

      通过哪个流 ID 发送实时有序数据。

    Returns Promise<ZegoRealTimeSequentialDataSentResult>

    发送实时有序数据结果通知。

Abstract startBroadcasting

  • startBroadcasting(streamID: string): Promise<void>
  • 开始广播实时有序数据流。

    支持版本:2.14.0 及以上。 详情描述:可通过此函数让用户将自己本地的实时有序数据流广播到 ZEGO RTC 服务器,同一房间的其他用户通过 "streamID" 就可以订阅该实时有序数据流进行互通。 业务场景:在发送实时有序数据前,需要先调用此函数开始广播。 调用时机:创建 [ZegoRealTimeSequentialDataManager] 实例后。 使用限制:无 注意事项:调用此函数后,本端将收到 [onPublisherStateUpdate] 回调,告知本端这条流的广播状态(推流状态),广播成功后,同一房间内的其他用户将会收到 [onRoomStreamUpdate] 回调,告知其他用户房间内新增了一条流。

    Parameters

    • streamID: string

      流 ID,长度不超过 256 的字符串。 注意事项:

      1. 需要在整个 AppID 内全局唯一(注意也不可以与 [startPublishingStream] 中传的流 ID 重复),若出现在同一个 AppID 内,不同的用户各推了一条流且流名相同,将会导致后推流的用户推流失败。
      2. 仅支持数字,英文字符 和 '-', '_'。

    Returns Promise<void>

Abstract startSubscribing

  • startSubscribing(streamID: string): Promise<void>
  • 开始订阅实时有序数据流。

    支持版本:2.14.0 及以上。 详情描述:可通过此函数让用户可以从 ZEGO RTC 服务器订阅远端用户的实时有序数据流。 业务场景:当需要接收来自其他用户发送的实时有序数据前,需要先调用此函数开始订阅对方的流。 调用时机:创建 [ZegoRealTimeSequentialDataManager] 实例后。 使用限制:无 注意事项:调用此函数后,本端将收到 [onPlayerStateUpdate] 回调,告知本端这条流的订阅状态(拉流状态)。

    Parameters

    • streamID: string

      流 ID,长度不超过 256 字节的字符串。 注意事项: 仅支持数字,英文字符 和 '-', '_'。

    Returns Promise<void>

Abstract stopBroadcasting

  • stopBroadcasting(streamID: string): Promise<void>
  • 停止广播实时有序数据流

    支持版本:2.14.0 及以上。 详情描述:可通过此函数让用户停止广播自己本地的实时有序数据流。 业务场景:当不再需要发送实时有序数据后,需要调用此函数停止广播。 调用时机:创建 [ZegoRealTimeSequentialDataManager] 实例后。 使用限制:无 注意事项:调用此函数后,本端将收到 [onPublisherStateUpdate] 回调,告知本端这条流的广播状态(推流状态),停止广播后,同一房间内的其他用户将会收到 [onRoomStreamUpdate] 回调,告知其他用户房间内删除了一条流。

    Parameters

    • streamID: string

      需要停止广播的流 ID

    Returns Promise<void>

Abstract stopSubscribing

  • stopSubscribing(streamID: string): Promise<void>
  • 停止订阅实时有序数据流。

    支持版本:2.14.0 及以上。 详情描述:可通过此函数停止订阅实时有序数据流。 业务场景:当不再需要接收其他用户发送的实时有序数据后,需要调用此函数停止订阅对方的流。 调用时机:创建 [ZegoRealTimeSequentialDataManager] 实例后。 使用限制:无 注意事项:调用此函数后,本端将收到 [onPlayerStateUpdate] 回调,告知本端这条流的订阅状态(拉流状态)。

    Parameters

    • streamID: string

      需要停止订阅的流 ID

    Returns Promise<void>

Generated using TypeDoc