Conversation
Document what each stream-type option means for Mux Player UI and playback, including live vs DVR and the ll-live aliases. Co-authored-by: Dave Kiss <davekiss@users.noreply.github.com>
davekiss
marked this pull request as ready for review
September 14, 2026 13:45
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs feedback
Problem
The HTML player API reference lists
stream-typeas"on-demand" | "live" | "ll-live" | "live:dvr" | "ll-live:dvr"with little explanation of what each option does. That page is generated frompackages/mux-player/REFERENCE.md.Change
Expand the existing
stream-typeattribute andstreamTypeproperty descriptions (no new page) with concise, per-value behavior:on-demand: VOD / Mux Asset UI (seekable timeline and duration)live: live without DVR — live controls, stays at the live edge (target-live-windowis0)ll-live: low-latency live without DVR — same player behavior aslive(low-latency HLS is inferred from the stream); preferlivelive:dvr: live with DVR — seekable live window (target-live-windowisInfinity), no auto-seek to livell-live:dvr: low-latency live with DVR — same aslive:dvr; preferlive+target-live-window="Infinity"Also notes that the value is usually inferred from
playback-idafter media loads.Behavior was checked against
mux-playerhelpers/base/template, stream-type tests, and the deprecated-stream-type guidance.No unrelated files changed.
QA
REFERENCE.mdenum matches PR:on-demand|live|ll-live|live:dvr|ll-live:dvr. Sourcepackages/mux-player/src/base.tsmaps DVR variants →targetLiveWindow = Infinityelse0, and deprecatesll-*in favor oflive/target-live-window. Explanations use existing product terms only (Mux Asset, live edge, DVR). Docs-only.