mcpField
F
fishjam

fishjam

github.com/software-mansion-labs开发296767 次安装2 周前更新
代码仓库

关于 fishjam

fishjam 是面向开发者的技能,涵盖 Software Mansion 托管的 WebRTC 平台,从平台概念到服务端和客户端 SDK。它按任务引导至 Web、移动端、后端、REST 和流组合参考,并说明令牌与 Sandbox 的安全注意事项。

主要功能

  1. 01平台概念与 REST 指南
  2. 02Node.js 和 Python 服务端 SDK 指南
  3. 03React 和 React Native 客户端指南
  4. 04原生 TypeScript 客户端指南
  5. 05流组合指南
  6. 06令牌与 Sandbox 安全规则

适用场景

  1. 01为新应用选择 Fishjam SDK
  2. 02构建浏览器或移动端客户端
  3. 03使用服务端 SDK 实现后端
  4. 04创建组合流或直接调用 REST

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/software-mansion-labs/skills --skill fishjam

安装后在 Claude Code 中输入/fishjam确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/composition/
inputs-and-outputs.md
rest-endpoints.md
room-composition.md
scenes.md
templates.md
references/js-server-sdk/
agent.md
client.md
composition.md
express-fastify.md
gemini-integration.md
livestream-and-moq.md
selective-subscriptions.md
webhooks.md
ws-notifier.md
references/platform/
auth-model.md
glossary.md
lifecycle-flow.md
llms-and-docs.md
notifications-taxonomy.md
notifier-vs-webhook.md
rest-endpoints.md
room-types.md
sandbox-vs-production.md
references/python-server-sdk/
agent.md
client.md
composition.md
fastapi.md
gemini-integration.md
livestream-and-moq.md
notifier.md

详细介绍

Fishjam

Software Mansion 的托管 WebRTC 平台。涵盖平台基础知识、四个 SDK 和组合流。

首先阅读 references/platform/SKILL.md,了解领域模型(房间、Peer、轨道、令牌、通知)。然后阅读与你要构建的内容匹配的 SDK 子技能。所有子技能都位于 references/ 中。

我需要哪个子技能?

你要编写……子技能
任何 Fishjam 相关内容——从这里开始了解术语表、房间类型、身份验证、通知、RESTreferences/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 中重新生成。
  • Peer 令牌自创建起 24 小时内有效。令牌会在初始 WS 握手期间被使用;已建立的会话会独立运行。如果 Peer 尚未连接,或 24 小时后需要_重新连接_,请调用 refreshPeerToken / refresh_peer_token 生成新令牌。
  • Sandbox API URL 仅用于开发。任何持有该 URL 的人都可以在你的账户上创建房间——切勿将其用于生产客户端构建。

评论

支持 Markdown