FrameReaderOptions
Defined in: relay-sdks/ts/src/frame-reader.ts:31
Options for createFrameReader.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
F |
Methods
Section titled “Methods”onCatchUp()?
Section titled “onCatchUp()?”onCatchUp?(): void;Defined in: relay-sdks/ts/src/frame-reader.ts:43
The sequencer signalled a catch-up (@caprid/moq-media’s catchUpAfterUs): frames keep arriving too late to use.
Replace the subscription at the live edge, which drops what the relay still holds queued for it: a supervised
subscriber’s catchUp(key) does, and its onRestarted restarts this reader. Called synchronously, after the
frames of the same poll; an exception from it goes to console.error.
Returns
Section titled “Returns”void
onFrame()
Section titled “onFrame()”onFrame(frame): void;Defined in: relay-sdks/ts/src/frame-reader.ts:36
Called synchronously with each frame, in decode order. An exception from it goes to console.error and the reader
carries on.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
frame |
F |
Returns
Section titled “Returns”void