Skip to content

Commit 9234e44

Browse files
authored
fix(Docs): Remove info about small/large gaps from manual (#7762)
`smallGapsLimit` and `largeGaps` have been removed.
1 parent 4302896 commit 9234e44

File tree

1 file changed

+0
-34
lines changed

1 file changed

+0
-34
lines changed

docs/design/gap-jumping.md

-34
Original file line numberDiff line numberDiff line change
@@ -64,40 +64,6 @@ segments like before. It will buffer segments independently of whether there
6464
are gaps in the media. Then if Playhead detects a gap in the media, it will
6565
jump it there.
6666

67-
There are two kinds of gaps: small gaps that may not be noticeable (and may be
68-
jumped automatically), and large gaps caused by missing segments in live
69-
streams. Small gaps (less than 0.5 seconds) should be jumped automatically on
70-
all browsers to provide seamless playback. Larger gaps should be identified and
71-
sent to the app to make a decision. If the app wants to (through a
72-
configuration parameter), we will jump those gaps also. Additionally, we should
73-
gracefully handle attempted seeks into gaps (for both buffered and unbuffered
74-
seeks).
75-
76-
### Configuration
77-
78-
- `.streaming.smallGapLimit` (default 0.5) the threshold (in seconds) for a gap
79-
to be considered small and jumped automatically.
80-
- `.streaming.jumpLargeGaps` (default false) if true, automatically jump large
81-
gaps. (see event below)
82-
83-
### Small vs Large Gaps
84-
85-
To support gap jumping across browsers, we will jump small gaps on all browsers
86-
without user interaction. These gaps should be small so they do not interrupt
87-
playback visually. Larger gaps can be optionally jumped, but we will tell the
88-
app about it first.
89-
90-
There will be a new event `largegap`. When the playhead enters a large gap, the
91-
video will be paused, but we won’t enter a buffering state. We will then fire
92-
the event to the app, giving it the current time and the start and end time of
93-
the gap.
94-
95-
If `jumpLargeGaps` is set, we will use the default action of the event to get
96-
feedback from the event listeners. The “default” action here is to jump the
97-
gap. If the event handlers call `preventDefault()`, we will not jump this gap.
98-
If `jumpLargeGaps` is not set, we will still fire the event, but never jump the
99-
gap ourselves.
100-
10167
### Manifest Parser
10268

10369
The manifest parser should remove all gaps from the index. The segment index

0 commit comments

Comments
 (0)