Fishjam React Client logo

Fishjam React Client

Organization
software-mansion-labs
fishjam-react-client

Browser-only React SDK for Fishjam — joining rooms, capturing camera/microphone/screen, displaying peers, and acting as a livestream streamer or viewer in a React web app. Use whenever the user is writing a React app in a browser that calls Fishjam APIs, sets up FishjamProvider, or uses any Fishjam React hook. Trigger on: '@fishjam-cloud/react-client', 'FishjamProvider', 'useConnection', 'useCamera', 'useMicrophone', 'useScreenShare', 'usePeers', 'useDataChannel', 'useVAD', 'useLivestreamStreamer', 'useLivestreamViewer', 'useCustomSource', 'useInitializeDevices', 'useUpdatePeerMetadata', 'useSandbox', 'PeerWithTracks', 'joinRoom', 'peerToken', 'fishjamId', 'fishjam react', '@fishjam-cloud/ts-client', 'FishjamClient ts-client'. Covers the provider, the full hook catalog, simulcast configuration, custom sources, data channels, VAD, livestream WHEP playback, device persistence, and reconnection. Briefly notes when to drop down to @fishjam-cloud/ts-client for non-React or worker contexts.

Overview

Publishersoftware-mansion-labs
Repositoryskills
Skill namefishjam-react-client
Stars
296
Forks
21
Bundled files
9
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 9 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by software-mansion-labs on GitHub. Read the source before you install it.

Installation

Install the Fishjam React Client AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/software-mansion-labs/skills/tree/main/skills/fishjam/references/react-client
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/software-mansion-labs/skills.git /tmp/skills
mkdir -p .claude/skills
cp -r /tmp/skills/skills/fishjam/references/react-client .claude/skills/fishjam-react-client
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Fishjam React Client in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Fishjam React Client on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Fishjam React Client is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Fishjam React Client

@fishjam-cloud/react-client — Fishjam's React SDK for browser apps. Wrap your app in FishjamProvider, then use hooks to drive devices, connection, and peers.

Read ../platform/SKILL.md first. It defines what rooms, peers, tokens, and the sandbox-vs-prod model are. This skill assumes those.

For React Native, use ../react-native-client/SKILL.md instead — it re-exports this hook surface and adds mobile-only concerns.

Minimal setup

bash
npm install @fishjam-cloud/react-client
# or yarn add @fishjam-cloud/react-client
tsx
import { FishjamProvider, useConnection, useSandbox } from '@fishjam-cloud/react-client';

function App() {
  return (
    <FishjamProvider fishjamId={import.meta.env.VITE_FISHJAM_ID}>
      <Room />
    </FishjamProvider>
  );
}

function Room() {
  // DEV — sandbox flow (no backend needed):
  const { getSandboxPeerToken } = useSandbox({ sandboxApiUrl: import.meta.env.VITE_SANDBOX_API_URL });
  const { joinRoom } = useConnection();

  const handleJoin = async () => {
    const peerToken = await getSandboxPeerToken('test-room', 'alice');
    await joinRoom({ peerToken });
  };

  return <button onClick={handleJoin}>Join</button>;
}

For production, replace useSandbox with a call to your own backend that returns a peer token (see ../platform/sandbox-vs-production.md):

tsx
const peerToken = await fetchPeerTokenFromYourBackend(roomName);
await joinRoom({ peerToken });

Hook catalog (decision tree)

What you needHookReference
Open / close the connectionuseConnectionconnection.md
Sandbox tokens for prototypinguseSandboxconnection.md
CamerauseCameradevices.md
MicrophoneuseMicrophonedevices.md
Screen shareuseScreenSharedevices.md
Initialize devices on app loaduseInitializeDevicesdevices.md
Render peers + their tracksusePeers (returns PeerWithTracks)peers-and-tracks.md
Livestream as broadcasteruseLivestreamStreamerlivestream.md
Livestream as vieweruseLivestreamViewerlivestream.md
Push a MediaStreamTrack you generated yourselfuseCustomSourcecustom-sources.md
Peer-to-peer messages (text chat, signals)useDataChanneldata-and-events.md
Detect when a remote peer is speakinguseVADdata-and-events.md
Update your peer's metadata mid-sessionuseUpdatePeerMetadatadata-and-events.md
Get WebRTC RTCStatsReport for debugginguseStatistics (from @fishjam-cloud/react-client/debug)provider.md
Configure simulcast / bandwidth(props on FishjamProvider)simulcast-and-bandwidth.md
Use Fishjam from non-React code (workers, Svelte, vanilla TS)@fishjam-cloud/ts-clientts-client-escape.md

Key rules

  • One FishjamProvider per app. Don't nest. It owns the FishjamClient, all device managers, and reconnection state.
  • useSandbox is dev-only. Gate it with if (import.meta.env.DEV) (or equivalent) so a sandbox URL can never ship in a production bundle.
  • Browser requires user gesture for useScreenShare — call inside an onClick, not on mount.
  • Devices stay mounted across connection state. Initializing with useInitializeDevices once is enough — they remain available after you leaveRoom.
  • Livestream rooms have a one-track-per-direction constraint. One video + one audio on the streamer; viewers don't publish.
  • For non-React contexts (Svelte, Vue, workers, vanilla TS), use @fishjam-cloud/ts-client directly. The React SDK is a thin layer over it. See ts-client-escape.md.
  • The provider re-exports Variant from ts-client for simulcast quality (Variant.VARIANT_LOW | Variant.VARIANT_MEDIUM | Variant.VARIANT_HIGH).

References

FileWhen to read
provider.mdAll FishjamProvider props — fishjamId, reconnect, constraints, persistLastDevice, bandwidthLimits, videoConfig, audioConfig, debug, fishjamClient.
connection.mduseConnection (joinRoom, leaveRoom, peerStatus, reconnectionStatus) and useSandbox.
devices.mduseCamera, useMicrophone, useScreenShare, useInitializeDevices. Device enumeration, switching, persistence.
peers-and-tracks.mdusePeers — localPeer, remotePeers, the PeerWithTracks shape.
livestream.mduseLivestreamStreamer, useLivestreamViewer, public vs private flows.
custom-sources.mduseCustomSource, TrackMiddleware, TracksMiddleware.
data-and-events.mduseDataChannel, useVAD, useUpdatePeerMetadata.
simulcast-and-bandwidth.mdVariant, BandwidthLimits, SimulcastConfig via videoConfig / audioConfig.
ts-client-escape.mdWhen and how to drop to @fishjam-cloud/ts-client.

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Fishjam React Client AI skill do?

Browser-only React SDK for Fishjam — joining rooms, capturing camera/microphone/screen, displaying peers, and acting as a livestream streamer or viewer in a React web app. Use whenever the user is writing a React app in a browser that calls Fishjam APIs, sets up FishjamProvider, or uses any Fishjam React hook. Trigger on: '@fishjam-cloud/react-client', 'FishjamProvider', 'useConnection', 'useCamera', 'useMicrophone', 'useScreenShare', 'usePeers', 'useDataChannel', 'useVAD', 'useLivestreamStreamer', 'useLivestreamViewer', 'useCustomSource', 'useInitializeDevices', 'useUpdatePeerMetadata', 'u...

Why use Fishjam React Client on TypingMind?

Because you install it once and use it with any model. Fishjam React Client is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Fishjam React Client in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/software-mansion-labs/skills/tree/main/skills/fishjam/references/react-client. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Fishjam React Client?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Fishjam React Client?

As many as you like. As long as a model supports skills, you can use Fishjam React Client with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Fishjam React Client AI skill free?

Yes. It is published on GitHub by software-mansion-labs under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇