chunkSize? |
number |
10 MiB |
Bytes per ranged request. |
ReadOptions.chunkSize |
filter? |
Filter |
undefined |
FormatCriteria, (format) => boolean, or a list of those. A list picks with the first entry that yields a format under quality. |
ChooseFormatOptions.filter |
format? |
VideoFormat |
undefined |
Wins over quality and filter. |
ChooseFormatOptions.format |
highWaterMark? |
number |
undefined |
Stream buffer limit in bytes. |
ReadOptions.highWaterMark |
liveBuffer? |
number |
20000 |
Live only: milliseconds of segments kept buffered behind the edge. |
ReadOptions.liveBuffer |
onProgress? |
(event) => void |
undefined |
Called after each chunk with the bytes received so far and the total, when known. |
ReadOptions.onProgress |
onRetry? |
(event) => void |
undefined |
Called before each re-resolution after a 403, a failed or stalled request or body, an expired URL or a failed SABR session. |
ReadOptions.onRetry |
quality? |
Quality |
Quality.Highest |
A Quality value, an itag, or itags tried in order. |
ChooseFormatOptions.quality |
range? |
object |
undefined |
Inclusive byte range of the format. |
ReadOptions.range |
range.end? |
number |
undefined |
- |
- |
range.start? |
number |
undefined |
- |
- |
signal? |
AbortSignal |
undefined |
Aborting it cancels the lookup or download. |
ReadOptions.signal |
startTimeMs? |
number |
undefined |
Milliseconds to start at, for a format without a url and without range. The stream sends the initialization segment, then media from the segment containing this time, and reports no total. |
ReadOptions.startTimeMs |
