FrameReader

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

A subscription’s or a want’s handlers that read its track as frames in decode order. Pass it, or spread it with handlers of your own, to subscribe or want. Each group is one subgroup, as the frame writer sends it, so a subgroup’s end is its group’s. A want read through a reader keeps drainMs at 0, the default: a drained old subscription’s groups would arrive after the Move, indistinguishable from the new one’s.

Methods

close()

close(): void;

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

Stop delivering and cancel the pending poll. Later events are ignored.

Returns

void

---

onObject()

onObject(object): void;

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

Feeds the object to the sequencer and delivers what is ready.

Parameters

Parameter	Type
object	MoqtObject

Returns

void

---

onRestarted()

onRestarted(): void;

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

A want’s Restart: the sequencer starts over and marks the next frame.

Returns

void

---

onSubgroupEnd()

onSubgroupEnd(info): void;

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

Ends the object’s group.

Parameters

Parameter	Type
info	{ groupId: number; }
info.groupId	number

Returns

void

---

onSubgroupReset()

onSubgroupReset(info): void;

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

Resets the object’s group: its remaining objects will not come.

Parameters

Parameter	Type
info	{ groupId: number; }
info.groupId	number

Returns

void

---

onSubscribed()

onSubscribed(info): void;

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

Takes the track properties, which may declare the Timescale.

Parameters

Parameter	Type
info	SubscribeOk

Returns

void

---

onSwitched()

onSwitched(info): void;

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

A want’s Move: the same, with the new subscription’s track properties.

Parameters

Parameter	Type
info	WantSwitchedInfo

Returns

void