RealtimeKitClient

RealtimeKitClient 类是 Web 核心库的主类。 可以使用 await RealtimeKitClient.init({ ... }) 创建 RealtimeKitClient 类的对象。通常，RealtimeKitClient 的对象被命名为 meeting。

• RealtimeKitClient
  • 实例
    • .participants
    • .self
    • .meta
    • .ai
    • .plugins
    • .chat
    • .polls
    • .connectedMeetings
    • .internals
    • .join()
    • .leave()
  • 静态
    • .initMedia([options], [skipAwaits], [cachedUserDetails])
    • .init(options)

participants 对象包含 4 个参与者映射表：waitlisted、joined、active、pinned。映射表通过 peerId 进行索引，值为对应的参与者对象。

类型: RealtimeKitClient 的实例属性

self 对象可用于控制本地参与者的音频和视频设置以及其他配置。这公开了启用和禁用媒体轨道、共享用户屏幕等方法。

类型: RealtimeKitClient 的实例属性

room 对象存储有关当前会议的信息，例如聊天消息、投票、会议室名称等。

类型: RealtimeKitClient 的实例属性

ai 对象用于与 AI 功能进行交互。 您可以使用此对象获取实时会议转录，并使用其他会议 AI 功能（例如摘要和议程）。

类型: RealtimeKitClient 的实例属性

plugins 对象存储关于当前会议中可用插件的信息。它公开了激活和停用它们的方法。

类型: RealtimeKitClient 的实例属性

chat 对象存储在会议中发送的聊天消息。这包括文本消息、图像和文件。

类型: RealtimeKitClient 的实例属性

polls 对象存储在会议中发起的投票。它公开了创建投票和对投票进行表决的方法。

类型: RealtimeKitClient 的实例属性

connectedMeetings 对象存储关联会议的状态。 它公开了用于关联会议的创建/读取/更新/删除方法。

类型: RealtimeKitClient 的实例属性

__internals__ 对象公开了内部工具和实用程序（例如 feature 和 logger），以便客户端可以利用它们来构建自己的基于功能的 UI。 Logger (__internals__.logger) 可用于向服务器发送日志，以便主动报告可能存在的问题。

类型: RealtimeKitClient 的实例属性

join() 方法可用于加入会议。 成功加入会议室后，会在 self 上触发 roomJoined 事件。

类型: RealtimeKitClient 的实例方法

leave() 方法可用于离开会议。

类型: RealtimeKitClient 的实例方法

类型: RealtimeKitClient 的静态方法

init 方法可用于实例化 RealtimeKitClient 类。 这会返回一个 RealtimeKitClient 实例，可用于对会议执行操作。

类型: RealtimeKitClient 的静态方法