fishjam について
fishjamは、Software Mansionのホスト型WebRTCプラットフォームを使う開発者向けのスキルです。プラットフォームの概念からサーバー・クライアントSDKまで案内し、Web、モバイル、バックエンド、REST、ストリーム合成の参照先やトークンの安全上の注意を示します。
主な機能
- 01プラットフォーム概念とRESTの案内
- 02Node.js・PythonサーバーSDKの案内
- 03React・React Nativeクライアントの案内
- 04Vanilla TypeScriptクライアントの案内
- 05ストリーム合成の案内
- 06トークンとSandboxの安全規則
活用シーン
- 01新しいアプリで使うFishjam SDKの選定
- 02ブラウザーまたはモバイルクライアントの構築
- 03サーバーSDKを使ったバックエンドの実装
- 04合成ストリームの作成やRESTの直接呼び出し
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ software-mansion-labs/ skills --skill fishjamインストール後、Claude Code で/fishjamを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/composition/inputs-and-outputs.mdrest-endpoints.mdroom-composition.mdscenes.mdtemplates.mdreferences/js-server-sdk/agent.mdclient.mdcomposition.mdexpress-fastify.mdgemini-integration.mdlivestream-and-moq.mdselective-subscriptions.mdwebhooks.mdws-notifier.mdreferences/platform/auth-model.mdglossary.mdlifecycle-flow.mdllms-and-docs.mdnotifications-taxonomy.mdnotifier-vs-webhook.mdrest-endpoints.mdroom-types.mdsandbox-vs-production.mdreferences/python-server-sdk/agent.mdclient.mdcomposition.mdfastapi.mdgemini-integration.mdlivestream-and-moq.mdnotifier.md詳細
Fishjam
Software Mansion が提供するホスト型 WebRTC プラットフォームです。プラットフォームの基本情報、4 つの SDK、コンポジションについて説明します。
まず、ドメインモデル(ルーム、ピア、トラック、トークン、通知)について記載された references/platform/SKILL.md を読んでください。次に、構築するものに合った SDK サブスキルを読んでください。すべてのサブスキルは references/ にあります。
どのサブスキルが必要ですか?
| 作成するもの… | サブスキル |
|---|---|
| Fishjam に関するもの全般 — 用語集、ルームの種類、認証、通知、REST の確認はこちらから | references/platform/SKILL.md |
| Node.js / Express / Fastify / Hono のバックエンド | references/js-server-sdk/SKILL.md |
| Python / FastAPI / Flask のバックエンド | references/python-server-sdk/SKILL.md |
| ブラウザーで動作する React アプリ | references/react-client/SKILL.md |
| iOS または Android 向けの React Native / Expo アプリ | references/react-native-client/SKILL.md |
| Vanilla TS / Svelte / Vue / Web Worker(React 以外) | references/react-client/SKILL.md → ts-client-escape.md(@fishjam-cloud/ts-client に移行) |
| コンポジションされたストリーム:ブロードキャストとしての通話、再配信、オーバーレイ、React テンプレート | references/composition/SKILL.md |
| REST を直接呼び出すだけ(SDK なし) | references/platform/rest-endpoints.md |
本番環境の Fishjam アプリには、必ず バックエンド(サーバー SDK)+クライアント(クライアント SDK) が必要です。プロトタイプでは Sandbox API を使ってバックエンドを省略できます。詳しくは references/platform/sandbox-vs-production.md を参照してください。
重要なルール
- 管理トークンをバックエンドの外に出してはいけません。漏えいした場合は、Dashboard から再生成してください。
- ピアトークンの有効期間は、作成から 24 時間 です。トークンは最初の WS ハンドシェイク中に消費されます。確立済みのセッションは、そのまま動作し続けます。ピアがまだ接続していない場合、または 24 時間経過後に 再接続 する必要がある場合は、
refreshPeerToken/refresh_peer_tokenを呼び出して新しいトークンを発行してください。 - Sandbox API の URL は開発専用です。URL を持っている人は誰でもあなたのアカウントにルームを作成できます。本番環境のクライアントビルドには決して含めないでください。
コメント
Markdown 対応