chore: document HLS-interstitial ad-break configuration and behavior - #396
Merged
Conversation
birme
commented
Sep 4, 2026
birme
left a comment
Contributor
Author
There was a problem hiding this comment.
pr-reviewer verdict: APPROVE
PROOF: npm run build && npm test → 113 specs, 0 failures, 7 pending.
Accuracy cross-checked against code (all match):
adBreak.enabled(bool, default false),adServerUri(required-when-enabled, validated absolute http/https) — server.tsAdBreakOpts/normalizeAdBreak.slate.{uri, repetitions=10, duration=4000}— server.tsSlateOpts+ defaults.- 2s timeout,
Accept: application/json,{assetUri}|{assetList}|{assets:[]}→ X-ASSET-URI/X-ASSET-LIST, EXT-X-DATERANGEcom.apple.hls.interstitialemission, PLANNED-DURATION = reps×duration/1000, slate fallback on timeout/non-2xx/malformed — session.js.
No trademarks (example uses ad-endpoint.example.com). examples/adbreak.ts compiles as part of the TS build. Style matches existing examples/docs.
Non-blocking note for a future code PR: engine/server.ts:34-35 carries a stale comment saying interstitial tags aren't emitted yet (they now are) — pre-existing on master, out of scope for this docs PR. Merging.
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
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.
Summary
Changes
docs/reference.md: new "Ad-break configuration (HLS interstitials)" section — field tables foradBreak(enabled,adServerUri,slate.{uri,repetitions,duration}) with types/defaults/validation, plus the ad-replacement flow.README.md: Features bullet, an "Ad breaks (HLS interstitials)" subsection linking to the reference, and the new example in the examples list.examples/adbreak.ts: minimal channel wired with a per-channeladBreak(enabled +adServerUri+slate) and an engine-level disabled default, matchingdefault.tsstyle. Vendor-neutral throughout (usesad-endpoint.example.com).Test plan
npm run build && npm test→ 113 specs, 0 failures, 7 pending. Newexamples/adbreak.tscompiles under the repo tsconfig (part of the TS build).Closes #371
🤖 Automated via Channel Engine Dev daily-backlog-pr skill