@realsee/live@0.7.6 は Realsee のブラウザー用共同閲覧 SDK です。WebSocket チャネルを包み、ルーム状態、UI キーフレーム、独自ブロードキャスト、任意の音声 RTC を共有します。
コアパッケージは createLive、createLiveReact、Live、RTC ヘルパー、型定義を公開します：
import { createLive, LiveState } from '@realsee/live'
interface MyKeyframes {
FiveState: unknown
selectedTag: { id: string } | null
}
const live = createLive<MyKeyframes>({
url: 'wss://ws-access.realsee.com/.../room',
getTicket: async () => {
const response = await fetch('/api/live/ticket')
return response.json().then((payload) => payload.ticket)
},
})
live.on('stateChange', (state) => {
if (state === LiveState.OPEN) {
live.sendKeyframe('selectedTag', null)
}
})
await live.connect()バージョンの補足
この文書は中国国内向けソースを基に、以下の海外公開パッケージで確認しています：
| パッケージ | 確認した版 | 補足 |
|---|---|---|
@realsee/live@0.7.6 | 0.7.6 | npm アーカイブの README と dist/*.d.ts |
react@18 | ^18 | peer dependency。createLiveReact は React 18 の型を使用 |
trtc-js-sdk | >=4.15.3 | 組み込みブラウザー RTC の peer dependency |
amazon-chime-sdk-js | >=3.0.0 | Chime RTC の peer dependency |
@realsee/jsbridge-x | >=0.2.6 | App・WebView RTC の peer dependency |
yjs | 13.6.20 | キーフレーム同期の実行時依存関係 |
国内文書には古いイベント名と CLOSING 状態があります。海外 0.7.6 の公開型は stateChange、keyframes、NOTINITIALIZED、CONNECTING、OPEN、CLOSED を持ち、この文書はパッケージの型に従います。
実行時の構成
Live は 4 つの要素で構成します：
- バックエンドが Team 所有アプリと文書化された OpenAPI でルーム、WebSocket URL、ticket、任意の音声 sign を作成します。共通の
/open権限を使いますが、役割と参加者権限も必要です。 - ブラウザーで
createLive<MyKeyframes>またはcreateLiveReact<MyKeyframes>により生成します。 live.connect()で WebSocket に接続します。LiveState.OPEN後にキーフレーム、ルーム更新、ブロードキャスト、任意の RTC を操作します。
Live 単体でツアーは描画しません。空間を同期表示する場合は Five SDK と組み合わせます。
次のステップ
- Live クイックスタート：インストール、接続、React フック。
- 同期：Five 状態、ユーザー状態、ルーム状態、独自ブロードキャスト。
- RTC と環境：音声とプラットフォーム要件。