RealtimeKitClient

RealtimeKitClient クラスは、Web 向けコアライブラリのメインクラスです。 RealtimeKitClient クラスのオブジェクトは、 await RealtimeKitClient.init({ ... }) で作成できます。通常、RealtimeKitClient のオブジェクトは meeting と名付けます。

• RealtimeKitClient
  • instance
    • .participants
    • .self
    • .meta
    • .ai
    • .plugins
    • .chat
    • .polls
    • .connectedMeetings
    • .internals
    • .join()
    • .leave()
  • static
    • .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__ オブジェクトは、features や logger などの内部ツールとユーティリティを公開します。クライアントはこれを使って、独自の機能ベース UI を構築できます。 Logger（__internals__.logger）を使うと、問題があればサーバーへログを送り、事前に知らせることができます。

種類: RealtimeKitClient のインスタンスプロパティ

join() メソッドでミーティングに参加できます。ルームへの参加が成功すると、self 上で roomJoined イベントが発行されます。

種類: RealtimeKitClient のインスタンスメソッド

leave() メソッドでミーティングから退出できます。

種類: RealtimeKitClient のインスタンスメソッド

種類: RealtimeKitClient の静的メソッド

init メソッドで RealtimeKitClient クラスをインスタンス化できます。戻り値は RealtimeKitClient のインスタンスで、ミーティングに対する操作に使えます。

種類: RealtimeKitClient の静的メソッド