Fishjam Docs

website·Indexed 39 days ago

https://fishjam.swmansion.com

A low-latency video conferencing and live streaming API by Software Mansion for WebRTC application development. Documentation covers core capabilities, pricing tiers such as the Mini Jar plan, and implementation guides for agents, backend setups, compositions, rooms, peers, and real-time server notifications.

Tokens
1.3K
Snippets
0
Records
23
Agent score
18%

What's inside Fishjam

  1. Overview of Fishjam WebRTC API capabilities

    Fishjam is a managed media server infrastructure (SFU) that enables the development of real-time video, audio, and data streaming applications without requiring WebRTC expertise. It provides sub-second latency (typically under 300ms) and supports the following use cases:

    • Video Conferencing: Multi-participant rooms with audio, video, screen sharing, and data channels.
    • Livestreaming: One-to-many low-latency streaming for events, shopping, or sports.
    • Audio-only Applications: Voice conferencing, podcasts, and voice chat.
    • AI Agent Support: Export session audio in PCM16 format for integration with AI services like OpenAI Whisper or Gemini Live.
    • Real-time Video Composition: Integration with Smelter to combine streams with overlays and layouts using React-based declarative APIs and WebAssembly.
    • Custom Data Delivery: Support for WebRTC data channels.
  2. Mix live media streams using Fishjam Compositions

    Compositions are a Fishjam feature that allows you to mix multiple live media streams into a single composed output in real time. You can write React composition templates, bundle them using the Fishjam CLI, and deploy them as outputs.
  3. Use the Fishjam Sandbox API for development

    The Sandbox API is a development tool that provides a pre-built simple backend, allowing developers to test Fishjam functionality without having to implement their own server immediately.
  4. Implement Media over QUIC (MoQ) in Fishjam

    Fishjam supports Media over QUIC (MoQ) using a relay model and a publish/subscribe architecture. It utilizes paths and token-based access control to manage media delivery.
  5. Implement Media over QUIC (MoQ) broadcasting

    Fishjam supports publishing and subscribing to live broadcasts using Media over QUIC (MoQ). This is available for both Web and React Native platforms, allowing developers to move from sandbox prototyping to production deployment.
  6. Choose a Fishjam pricing plan

    Fishjam offers three pricing tiers based on project scale and requirements:

    1. Mini Jar (Free): No credit card required. Limited to 4 peers per session and a 30-minute session limit. Ideal for prototyping and testing.
    2. Regular Jar ($50/month): Includes $50 monthly credit with pay-as-you-go rates per participant-minute:
      • Video conferencing: $0.001
      • Audio conferencing: $0.00025
      • Video livestreaming: $0.0008
      • Audio livestreaming: $0.0002
      • Note: AI agents are billed as participants.
    3. Jumbo Jar (Custom): Enterprise tier featuring custom usage plans, priority support via a dedicated Slack channel, volume discounts, and on-demand feature development.
  7. Stream react-native-vision-camera feeds to Fishjam

    You can publish a react-native-vision-camera feed to a Fishjam room as a custom video source, with the option to run frame-processor plugins on the frames before they are published.
  8. Create audio-only conferences and livestreams

    Fishjam allows the creation of audio-only rooms and livestreams for voice-only use cases, which are available at a discounted cost compared to full video rooms.
  9. Update composition state at runtime with events

    You can send custom events to a running Fishjam composition to dynamically update the on-screen state of a template while it is active.
  10. Set up a Fishjam backend server

    To manage rooms and peers for a Fishjam application, you must set up a backend server. You can install and configure a Fishjam server SDK for Node.js or Python, or integrate directly via the bare REST API. For rapid testing without a custom backend, the Sandbox API can be used to create rooms and peers.
  11. Record a composition to MP4

    Fishjam allows you to capture a composition's output into an MP4 file that persists after the composition ends. This is achieved through the Fishjam Server API.