FrameReaderSequencer

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

What a FrameReader drives: @caprid/moq-media’s FrameSequencer qualifies. The reader feeds it a subscription’s events and polls it; the sequencer owns the ordering, the deadlines and the LOC format.

Type Parameters

Type Parameter
F

Properties

trackProperties

trackProperties: readonly KeyValuePair[];

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

Set from each SUBSCRIBE_OK.

Methods

groupEnded()

groupEnded(groupId): void;

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

A group’s stream ended cleanly.

Parameters

Parameter	Type
groupId	number

Returns

void

---

groupReset()

groupReset(groupId): void;

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

A group’s stream was reset.

Parameters

Parameter	Type
groupId	number

Returns

void

---

object()

object(object): void;

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

An object arrived.

Parameters

Parameter	Type
object	MoqtObject

Returns

void

---

poll()

poll(): object;

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

Take the frames ready now, and when to poll again.

Returns

catchUp?

catchUp?: boolean;

The sequencer asks for the subscription to be replaced at the live edge: see onCatchUp.

frames

frames: F[];

The frames ready now, in decode order.

waitUs

waitUs: number | undefined;

Poll again after this many microseconds, 0 at once; undefined when only new events can change it.

---

restart()

restart(): void;

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

The subscription was replaced: forget everything.

Returns

void