Skip to content

Update ABR docs#856

Merged
tvanlaerhoven merged 1 commit into
developfrom
maintenance/update-abr-docs
Jun 26, 2026
Merged

Update ABR docs#856
tvanlaerhoven merged 1 commit into
developfrom
maintenance/update-abr-docs

Conversation

@ceyhun-o

Copy link
Copy Markdown
Contributor

This PR updates the ABR docs and some API descriptions:

  • targetBuffer is now correctly documented to be supported on all platforms.
  • Adds preferredPeakBitRate to the ABR doc.
  • Adds extra remarks for some ABR APIs.

@ceyhun-o ceyhun-o added the documentation Improvements or additions to documentation label Jun 24, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor

Thanks for the docs update, @ceyhun-o!

A table aligned, a footnote placed,
Old version notes now duly erased,
From Web and Android's domain,
iOS joins the ABR lane —
With THEOlive and Millicast embraced.

Code analysis:

The changes look clean. A few observations:

  • Removing @platform web,android from strategy and replacing it with detailed @remarks is the right call — it correctly conveys that iOS support exists but is scoped to THEOlive/Millicast streams. The doc table's asterisk footnote matches.
  • Removing the outdated v4.3.0 version-specific remarks from targetBuffer is good cleanup.
  • The new Millicast connection-establishment caveat on both strategy and preferredPeakBitRate is helpful for developers.
  • targetBuffer platform support updated from "Android & Web" → "Android/Web/iOS" in the doc table, consistent with the removal of the platform restriction.
  • preferredPeakBitRate added to the doc table — was previously only in the TypeScript API docs.

One minor nit: there's a trailing space on line 122 of ABRConfiguration.ts (blank line between @platform ios and @remarks). Non-blocking.

CI: The iOS e2e failure ("dispatches a seeked event after seeking") is a preexisting flaky test — the same CI job also fails on recent develop PRs with different e2e tests (e.g. PR #850, #851).

CHANGELOG: Not needed — this is a docs-only PR.

Verdict: Ready to merge.

@tvanlaerhoven tvanlaerhoven merged commit c3a7498 into develop Jun 26, 2026
6 of 7 checks passed
@tvanlaerhoven tvanlaerhoven deleted the maintenance/update-abr-docs branch June 26, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants