createFrameReader

function createFrameReader<F>(sequencer, options): FrameReader;

Defined in: relay-sdks/ts/src/frame-reader.ts:83

Read a track as frames: feed the sequencer every event, poll it after each, and again when a wait it reports ends (at most 50 ms on, since another track may move a shared clock). See spec/behavior.md, “Media subscribing”.

const clock = createPlayoutClock();
const video = createFrameReader(createFrameSequencer({ clock }), { onFrame: decode });
subscriber.subscribe({ namespace, track: 'video' }, { ...video, onError });

Type Parameters

Type Parameter
F

Parameters

Parameter	Type
sequencer	FrameReaderSequencer<F>
options	FrameReaderOptions<F>

Returns

FrameReader