Skip to content

ReadOptions

Property Type Default value Description Inherited from
chunkSize? number 10 MiB Bytes per ranged request. -
highWaterMark? number undefined Stream buffer limit in bytes. -
liveBuffer? number 20000 Live only: milliseconds of segments kept buffered behind the edge. -
onProgress? (event) => void undefined Called after each chunk with the bytes received so far and the total, when known. -
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. -
range? object undefined Inclusive byte range of the format. -
range.end? number undefined - -
range.start? number undefined - -
signal? AbortSignal undefined Aborting it cancels the lookup or download. LookupOptions.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. -