Skip to content

docs(spf): document moq publisher requirements - #51

Merged
mmcc merged 2 commits into
mmcc/moqfrom
docs/moq-publisher-guide
Sep 18, 2026
Merged

mmcc merged 2 commits into
mmcc/moqfrom
docs/moq-publisher-guide

Conversation

@mmcc

@mmcc mmcc commented Sep 18, 2026 •

Copy link
Copy Markdown
Owner

Summary

Publishers currently have to infer v10's MoQ stream requirements from implementation comments, tests, and protocol drafts. Add a practical publisher guide with a complete camera-resolution ladder, separate screen-share track, and audio catalog, linked from the SPF README and MoQ spec index.

Explain alternate versus render groups, LOC payloads, decoder initialization, timestamps, keyframe alignment, late joins, and live catalog updates. Document the current player limitations and the loopback catalog's missing altGroup, so readers can distinguish a valid stream from functionality not yet exposed by the controls.

Targets mmcc/moq; this PR changes documentation only.

Testing

  • 256 existing tests passed across catalog parsing, source URLs, LOC, codec mapping, catalog resolution, track selection, and subscription handoff.
  • Executed the guide's JSON and selection examples against the source implementation using a temporary validation script: source resolution, camera/screen grouping, decoder configurations, remove/add updates, and selection all passed.
  • Checked all 12 relative links introduced by the guide and README entries, plus git diff --check.
  • Repository pre-commit and commit-message hooks passed. Markdown is excluded from the repository formatter.
  • No live publisher/browser interoperability test was run for this documentation change.

Summary by cubic

Adds a publisher guide for the experimental MoQ player so publishers no longer have to infer v10's stream requirements from implementation comments, tests, and protocol drafts. The guide covers catalog structure, encoding rules, and update flows, and is linked from the SPF README and MoQ spec index. It also documents current player limitations and the loopback catalog's missing altGroup so readers can tell a valid stream from functionality not yet exposed.

Written for commit 25dc309. Summary will update on new commits.

Review in cubic

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 18, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-18T00:42:49.815743Z 731124b PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

Copy link
Copy Markdown

📦 Bundle Size Report

🎨 @videojs/html — no changes
Presets (7)
Entry Initial Lazy
/video (default) 61.27 kB 56.87 kB
/video (default + hls) 200.18 kB 56.87 kB
/video (minimal) 60.94 kB 56.87 kB
/video (minimal + hls) 199.90 kB 56.87 kB
/audio (default) 51.07 kB 56.87 kB
/audio (minimal) 47.13 kB 56.87 kB
/background 11.47 kB 56.87 kB
Media (20)
Entry Initial
/media/mux-video 142.33 kB
/media/mux-audio 142.05 kB
/media/background-video 1.16 kB
/media/cloudflare-video 6.25 kB
/media/dash-video 211.72 kB
/media/google-cast 6.52 kB
/media/hls-audio 22.21 kB
/media/hls-background-video 16.85 kB
/media/hls-video 28.13 kB
/media/hlsjs-video 141.03 kB
/media/mux-background-video 16.86 kB
/media/mux-data 26.70 kB
/media/native-hls-video 7.51 kB
/media/shaka-video 199.21 kB
/media/simple-moq-video 28.76 kB
/media/spotify-audio 6.24 kB
/media/tiktok-video 6.29 kB
/media/twitch-video 6.19 kB
/media/vimeo-video 13.03 kB
/media/youtube-video 6.79 kB
Players (5)
Entry Initial Lazy
/video/player 9.65 kB 56.87 kB
/audio/player 6.09 kB 56.87 kB
/background/player 4.45 kB 56.87 kB
/live-video/player 9.03 kB 56.87 kB
/live-audio/player 6.12 kB 56.87 kB
Skins (37)
Entry Type Initial Lazy
/video/minimal-skin.css css 6.50 kB —
/video/skin.css css 6.30 kB —
/video/minimal-skin js 59.45 kB 56.87 kB
/video/minimal-skin.tailwind js 59.71 kB 56.87 kB
/video/minimal-skin2 js 7.07 kB —
/video/skin js 59.64 kB 56.87 kB
/video/skin.tailwind js 60.01 kB 56.87 kB
/video/skin2 js 6.91 kB —
/audio/minimal-skin.css css 4.87 kB —
/audio/skin.css css 4.79 kB —
/audio/minimal-skin js 45.62 kB 56.87 kB
/audio/minimal-skin.tailwind js 45.91 kB 56.87 kB
/audio/minimal-skin2 js 5.27 kB —
/audio/skin js 49.48 kB 56.87 kB
/audio/skin.tailwind js 49.77 kB 56.87 kB
/audio/skin2 js 5.23 kB —
/background/skin.css css 145 B —
/background/skin js 9.72 kB 56.87 kB
/background/skin2 js 190 B —
/live-video/minimal-skin.css css 6.50 kB —
/live-video/skin.css css 6.30 kB —
/live-video/minimal-skin js 53.49 kB 56.87 kB
/live-video/minimal-skin.tailwind js 53.52 kB 56.87 kB
/live-video/minimal-skin2 js 7.07 kB —
/live-video/skin js 56.08 kB 56.87 kB
/live-video/skin.tailwind js 56.22 kB 56.87 kB
/live-video/skin2 js 6.91 kB —
/live-audio/minimal-skin.css css 4.87 kB —
/live-audio/skin.css css 4.79 kB —
/live-audio/minimal-skin js 38.92 kB 56.87 kB
/live-audio/minimal-skin.tailwind js 38.02 kB 56.87 kB
/live-audio/minimal-skin2 js 5.27 kB —
/live-audio/skin js 42.52 kB 56.87 kB
/live-audio/skin.tailwind js 41.69 kB 56.87 kB
/live-audio/skin2 js 5.23 kB —
/global.css css 190 B —
/shared.css css 118 B —
UI Components (49)
Entry Initial Lazy
/ui/airplay-button 11.15 kB 56.87 kB
/ui/alert-dialog 9.14 kB 56.87 kB
/ui/audio-track-radio-group 11.29 kB 56.87 kB
/ui/buffering-indicator 8.56 kB 56.87 kB
/ui/captions-button 11.40 kB 56.87 kB
/ui/captions-radio-group 11.36 kB 56.87 kB
/ui/cast-button 11.11 kB 56.87 kB
/ui/container 9.41 kB 56.87 kB
/ui/controls 8.77 kB 56.87 kB
/ui/controls-backdrop 1.69 kB 56.87 kB
/ui/controls-content 1.67 kB 56.87 kB
/ui/dialog 9.06 kB 56.87 kB
/ui/dialog-backdrop 1.70 kB 56.87 kB
/ui/dialog-close 2.01 kB 56.87 kB
/ui/dialog-description 1.69 kB 56.87 kB
/ui/dialog-popup 1.87 kB 56.87 kB
/ui/dialog-title 1.70 kB 56.87 kB
/ui/error-dialog 12.63 kB 56.87 kB
/ui/fullscreen-button 11.10 kB 56.87 kB
/ui/gesture 9.37 kB 56.87 kB
/ui/hotkey 9.80 kB 56.87 kB
/ui/menu 19.98 kB 56.87 kB
/ui/mute-button 11.14 kB 56.87 kB
/ui/pip-button 11.08 kB 56.87 kB
/ui/play-button 11.09 kB 56.87 kB
/ui/playback-rate-button 11.20 kB 56.87 kB
/ui/playback-rate-radio-group 11.27 kB 56.87 kB
/ui/popover 8.53 kB 56.87 kB
/ui/poster 8.63 kB 56.87 kB
/ui/quality-radio-group 11.87 kB 56.87 kB
/ui/seek-button 11.14 kB 56.87 kB
/ui/seek-indicator 12.47 kB 56.87 kB
/ui/seek-indicator-value 1.10 kB —
/ui/slider 12.01 kB 56.87 kB
/ui/status-announcer 10.56 kB 56.87 kB
/ui/status-indicator 12.82 kB 56.87 kB
/ui/status-indicator-value 1.10 kB —
/ui/thumbnail 9.73 kB 56.87 kB
/ui/time 10.81 kB 56.87 kB
/ui/time-slider 14.93 kB 56.87 kB
/ui/time-slider-chapter-title 8.74 kB 56.87 kB
/ui/time-slider-chapters 9.69 kB 56.87 kB
/ui/title 8.13 kB 56.87 kB
/ui/tooltip 9.92 kB 56.87 kB
/ui/volume-indicator 12.85 kB 56.87 kB
/ui/volume-indicator-fill 1.11 kB —
/ui/volume-indicator-value 1.10 kB —
/ui/volume-popover 14.67 kB 56.87 kB
/ui/volume-slider 12.66 kB 56.87 kB
⚛️ @videojs/react — no changes
Presets (7)
Entry Initial Lazy
/video (default) 47.76 kB 56.87 kB
/video (default + hls) 185.56 kB 56.87 kB
/video (minimal) 47.80 kB 56.87 kB
/video (minimal + hls) 185.51 kB 56.87 kB
/audio (default) 37.12 kB 56.87 kB
/audio (minimal) 37.18 kB 56.87 kB
/background 581 B 56.87 kB
Media (23)
Entry Initial
/media/mux-video/hls-js 140.62 kB
/media/mux-video/spf 27.54 kB
/media/mux-audio/hls-js 140.46 kB
/media/mux-audio/spf 21.44 kB
/media/background-video 402 B
/media/cloudflare-video 4.35 kB
/media/dash-video 210.29 kB
/media/google-cast 5.34 kB
/media/hls-audio 20.48 kB
/media/hls-background-video 16.40 kB
/media/hls-video 26.56 kB
/media/hlsjs-video 139.58 kB
/media/mux-audio 140.44 kB
/media/mux-background-video 16.47 kB
/media/mux-data 25.49 kB
/media/mux-video 140.54 kB
/media/native-hls-video 5.76 kB
/media/shaka-video 197.52 kB
/media/spotify-audio 4.22 kB
/media/tiktok-video 4.18 kB
/media/twitch-video 4.30 kB
/media/vimeo-video 11.21 kB
/media/youtube-video 4.86 kB
Players (5)
Entry Initial Lazy
/video/player 7.51 kB 56.87 kB
/audio/player 3.95 kB 56.87 kB
/background/player 2.27 kB 56.87 kB
/live-video/player 6.91 kB 56.87 kB
/live-audio/player 3.95 kB 56.87 kB
Skins (26)
Entry Type Initial Lazy
/video/minimal-skin.css css 6.40 kB —
/video/skin.css css 6.20 kB —
/video/minimal-skin js 47.67 kB 56.87 kB
/video/minimal-skin.tailwind js 54.62 kB 56.87 kB
/video/skin js 47.67 kB 56.87 kB
/video/skin.tailwind js 54.40 kB 56.87 kB
/audio/minimal-skin.css css 4.73 kB —
/audio/skin.css css 4.65 kB —
/audio/minimal-skin js 37.11 kB 56.87 kB
/audio/minimal-skin.tailwind js 42.21 kB 56.87 kB
/audio/skin js 36.99 kB 56.87 kB
/audio/skin.tailwind js 42.17 kB 56.87 kB
/background/skin.css css 90 B —
/background/skin js 277 B —
/live-video/minimal-skin.css css 6.40 kB —
/live-video/skin.css css 6.20 kB —
/live-video/minimal-skin js 39.77 kB 56.87 kB
/live-video/minimal-skin.tailwind js 46.43 kB 56.87 kB
/live-video/skin js 39.79 kB 56.87 kB
/live-video/skin.tailwind js 46.43 kB 56.87 kB
/live-audio/minimal-skin.css css 4.73 kB —
/live-audio/skin.css css 4.65 kB —
/live-audio/minimal-skin js 28.82 kB 56.87 kB
/live-audio/minimal-skin.tailwind js 32.77 kB 56.87 kB
/live-audio/skin js 28.88 kB 56.87 kB
/live-audio/skin.tailwind js 32.93 kB 56.87 kB
UI Components (39)
Entry Initial Lazy
/ui/airplay-button 10.28 kB 56.87 kB
/ui/alert-dialog 4.41 kB 56.87 kB
/ui/audio-track 7.89 kB 56.87 kB
/ui/audio-track-radio-group 9.05 kB 56.87 kB
/ui/buffering-indicator 7.72 kB 56.87 kB
/ui/captions-button 10.25 kB 56.87 kB
/ui/captions-radio-group 9.17 kB 56.87 kB
/ui/cast-button 10.26 kB 56.87 kB
/ui/controls 7.51 kB 56.87 kB
/ui/dialog 4.44 kB 56.87 kB
/ui/error-dialog 11.44 kB 56.87 kB
/ui/fullscreen-button 10.24 kB 56.87 kB
/ui/gesture 7.80 kB 56.87 kB
/ui/hotkey 8.21 kB 56.87 kB
/ui/live-button 8.69 kB 56.87 kB
/ui/menu 18.91 kB 56.87 kB
/ui/mute-button 10.26 kB 56.87 kB
/ui/pip-button 10.23 kB 56.87 kB
/ui/play-button 10.21 kB 56.87 kB
/ui/playback-rate 7.94 kB 56.87 kB
/ui/playback-rate-button 10.22 kB 56.87 kB
/ui/playback-rate-radio-group 9.09 kB 56.87 kB
/ui/popover 8.12 kB 56.87 kB
/ui/poster 7.49 kB 56.87 kB
/ui/quality 8.38 kB 56.87 kB
/ui/quality-radio-group 9.54 kB 56.87 kB
/ui/seek-button 10.25 kB 56.87 kB
/ui/seek-indicator 11.75 kB 56.87 kB
/ui/slider 12.60 kB 56.87 kB
/ui/status-announcer 10.01 kB 56.87 kB
/ui/status-indicator 12.07 kB 56.87 kB
/ui/thumbnail 8.64 kB 56.87 kB
/ui/time 9.69 kB 56.87 kB
/ui/time-slider 14.07 kB 56.87 kB
/ui/title 7.19 kB 56.87 kB
/ui/tooltip 8.90 kB 56.87 kB
/ui/volume-indicator 12.15 kB 56.87 kB
/ui/volume-popover 14.13 kB 56.87 kB
/ui/volume-slider 12.03 kB 56.87 kB
🧩 @videojs/core — no changes
Entries (76)
Entry Initial Lazy
. 13.02 kB —
/dom 21.92 kB 56.87 kB
/vjsc 1.74 kB —
/i18n 3.23 kB 56.87 kB
/i18n/locales/all 34.97 kB —
/i18n/locales/ar 1.22 kB —
/i18n/locales/az 1.09 kB —
/i18n/locales/bg 1.29 kB —
/i18n/locales/bn 1.23 kB —
/i18n/locales/bs 1.00 kB —
/i18n/locales/ca 1.07 kB —
/i18n/locales/cs 1.07 kB —
/i18n/locales/cy 1.02 kB —
/i18n/locales/da 1006 B —
/i18n/locales/de 1.09 kB —
/i18n/locales/el 1.49 kB —
/i18n/locales/en 785 B —
/i18n/locales/es 1018 B —
/i18n/locales/et 1.05 kB —
/i18n/locales/eu 1.03 kB —
/i18n/locales/fa 1.22 kB —
/i18n/locales/fi 1.04 kB —
/i18n/locales/fr 1.07 kB —
/i18n/locales/gd 1.10 kB —
/i18n/locales/gl 1022 B —
/i18n/locales/he 1.14 kB —
/i18n/locales/hi 1.30 kB —
/i18n/locales/hr 1.02 kB —
/i18n/locales/hu 1.10 kB —
/i18n/locales/id 919 B —
/i18n/locales/it 1.01 kB —
/i18n/locales/ja 1.18 kB —
/i18n/locales/ko 1.14 kB —
/i18n/locales/lt 1.02 kB —
/i18n/locales/lv 1.09 kB —
/i18n/locales/mr 1.30 kB —
/i18n/locales/nb 987 B —
/i18n/locales/ne 1.29 kB —
/i18n/locales/nl 1.00 kB —
/i18n/locales/nn 987 B —
/i18n/locales/oc 1.08 kB —
/i18n/locales/pl 1.14 kB —
/i18n/locales/pt 1.03 kB —
/i18n/locales/pt-BR 1.03 kB —
/i18n/locales/pt-PT 1.01 kB —
/i18n/locales/ro 1.07 kB —
/i18n/locales/ru 1.40 kB —
/i18n/locales/sk 1.10 kB —
/i18n/locales/sl 1.04 kB —
/i18n/locales/sr 1.07 kB —
/i18n/locales/sv 1.01 kB —
/i18n/locales/te 1.32 kB —
/i18n/locales/th 1.29 kB —
/i18n/locales/tr 1.08 kB —
/i18n/locales/uk 1.41 kB —
/i18n/locales/vi 1.11 kB —
/i18n/locales/zh 1.02 kB —
/i18n/locales/zh-CN 1.02 kB —
/i18n/locales/zh-TW 1.02 kB —
/i18n/text/airplay 101 B —
/i18n/text/buttons 137 B —
/i18n/text/captions 93 B —
/i18n/text/cast 114 B —
/i18n/text/common 90 B —
/i18n/text/container 75 B —
/i18n/text/errors 285 B —
/i18n/text/fullscreen 98 B —
/i18n/text/live 126 B —
/i18n/text/menu 249 B —
/i18n/text/pip 101 B —
/i18n/text/playback 80 B —
/i18n/text/seek 105 B —
/i18n/text/slider 65 B —
/i18n/text/status 222 B —
/i18n/text/time 280 B —
/i18n/text/volume 133 B —
🏷️ @videojs/element — no changes
Entries (2)
Entry Initial
. 1.05 kB
/context 943 B
📦 @videojs/store — no changes
Entries (3)
Entry Initial
. 1.72 kB
/html 703 B
/react 365 B
🔧 @videojs/utils — no changes
Entries (13)
Entry Initial
/array 271 B
/dom 5.02 kB
/events 320 B
/function 386 B
/i18n 249 B
/jwt 176 B
/object 535 B
/predicate 297 B
/percent 281 B
/string 239 B
/style 212 B
/time 976 B
/number 199 B

📦 @videojs/media

Path Base initial PR initial Initial diff Lazy diff
/dom/dash 209.83 kB 3.28 kB -206.54 kB (-98.4%) —
Entries (21)
Entry Initial
. 1.07 kB
/dom 121 B
/dom/dash 3.28 kB
/dom/audio-host 1.10 kB
/dom/cloudflare 3.69 kB
/dom/custom-media-element 2.09 kB
/dom/dash 209.83 kB
/dom/google-cast 4.06 kB
/dom/hls-js 139.17 kB
/dom/media-host 1.20 kB
/dom/media-played-ranges 576 B
/dom/mux 162.77 kB
/dom/native-hls 5.25 kB
/dom/shaka 197.02 kB
/dom/spotify 3.58 kB
/dom/tiktok 3.57 kB
/dom/twitch 3.62 kB
/dom/video-host 1.39 kB
/dom/vimeo 10.62 kB
/dom/youtube 4.25 kB
/media-tracks 2.05 kB
📦 @videojs/spf — no changes
Entries (11)
Entry Initial
. 4.55 kB
/dom 6.61 kB
/hls 22.23 kB
/media-tracks 605 B
/moq 27.33 kB
/hls-background-video 15.87 kB
/hls-audio 20.01 kB
/hls-video 26.05 kB
/mux-audio 20.97 kB
/mux-background-video 15.90 kB
/mux-video 26.96 kB

ℹ️ How to interpret

Each entry is independently bundled, minified, and brotli-compressed. Initial size includes its static import graph; lazy dynamic chunks are reported separately.

Entries are not additive because their dependency graphs overlap. Preset rows represent realistic combined bundles.

Changes of 300 B or less across initial, lazy, and total size are collapsed, not discarded.

Run pnpm size locally to check current initial sizes.

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

All reported issues were addressed across 3 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread packages/spf/docs/moq-publishing.md Resolved
Comment thread packages/spf/docs/moq-publishing.md Resolved
@mmcc
mmcc merged commit 2fefce4 into mmcc/moq Sep 18, 2026
24 of 25 checks passed
@mmcc
mmcc deleted the docs/moq-publisher-guide branch September 18, 2026 00:57
mmcc added a commit that referenced this pull request Sep 18, 2026
Brings the publisher stack onto mmcc/moq at 2fefce4 (PRs #47, #50,
#51): subscriber location framing for moq-relay 0.14.17, isolated
subscription recovery attempts with preserved retry backoff, and the
moq publishing guide under packages/spf/docs.

No publisher-side ports were needed. The LARGEST_OBJECT bare-Location
codec change from PR #47 was already on this branch via PR #48, so
control-messages.ts and its tests merge to the existing content.
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.

1 participant