Skip to content

Add MoQ streaming tutorial to docs#252

Open
Karolk99 wants to merge 6 commits intomainfrom
fce-3167/add-moq-to-doc
Open

Add MoQ streaming tutorial to docs#252
Karolk99 wants to merge 6 commits intomainfrom
fce-3167/add-moq-to-doc

Conversation

@Karolk99
Copy link
Copy Markdown
Contributor

@Karolk99 Karolk99 commented May 4, 2026

Description

This PR adds a "MoQ Streaming" tutorial that shows how you can use the MoQ protocol with Fishjam.
It shows how to:

  • Create publisher/subscriber token with RoomManager and Production
  • Publish stream using Luke's web SDK
  • Subscribe (or entire namespace) to a stream using Luke's web SDK

There are missing links because we don't have a blog post or concept section that this tutorial could reference.

Let me also know whether you think we should add a concept section about the MoQ protocol to our docs or stick to the blog post alone.

Edit
I added an "MoQ Streaming with Fishjam" explanation section.

@linear
Copy link
Copy Markdown

linear Bot commented May 4, 2026

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Fishjam documentation tutorial for MoQ streaming, introducing a docs path parallel to the existing livestreaming guides and showing how to move from sandbox prototyping to production token management.

Changes:

  • Adds a new MoQ Streaming tutorial page under docs/tutorials.
  • Documents sandbox-based publisher/subscriber token flows and client-side publish/subscribe examples with the MoQ web packages.
  • Adds production examples for generating MoQ tokens with the TypeScript and Python server SDKs, including namespace subscription discovery.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/tutorials/moq.mdx Outdated
Comment thread docs/tutorials/moq.mdx
Comment thread docs/tutorials/moq.mdx
Comment thread docs/tutorials/moq.mdx
Comment thread docs/tutorials/moq.mdx Outdated
This section explains how to publish and subscribe to live streams using [Media over QUIC (MoQ)](https://datatracker.ietf.org/wg/moq/about/) with Fishjam.
MoQ uses QUIC as its transport layer (with a WebSocket fallback), delivering ultra-low latency at scale — making it ideal for interactive broadcasts, live events, and large-audience streams.

Before diving into the tutorial, we recommend getting familiar with the [MoQ protocol concepts](https://datatracker.ietf.org/wg/moq/about/).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: This could be an admonition like :::info and I would phrase it more like:

If you're new to MoQ, then we recommend getting familiar with its [basic concepts](link to blog)

Apart from that, we should add a short TL;DR section defining publishers, subscribers, relays and namespaces. The admonition could mention this section as a more surface-level walkthrough

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a separate page, "MoQ streaming with Fishjam," that is a walkthrough that explains concepts like publisher, subscribers, and path in detail.

Comment thread docs/tutorials/moq.mdx Outdated
Comment thread docs/tutorials/moq.mdx Outdated
Comment thread docs/tutorials/moq.mdx Outdated
Comment thread docs/tutorials/moq.mdx
Comment thread docs/tutorials/moq.mdx
element: canvas,
broadcast,
paused: false,
});
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: We could demonstrate usage of the moq player component here below or maybe a react component that wraps this logic

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you like to see both? I mean, rewrite already existing code snippets into components and additionally write an example with the players, or change snippets to ready-to-use players?

Comment thread docs/tutorials/moq.mdx Outdated
Comment thread docs/tutorials/moq.mdx Outdated
Comment thread docs/tutorials/moq.mdx
Comment thread docs/tutorials/moq.mdx Outdated
@Karolk99 Karolk99 force-pushed the fce-3167/add-moq-to-doc branch from 13ef71c to d9f4e5d Compare May 6, 2026 15:46
@Karolk99 Karolk99 requested a review from AHGIJMKLKKZNPJKQR May 6, 2026 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants