FrameWriterOptions
Defined in: relay-sdks/ts/src/frame-writer.ts:45
Options for createFrameWriter.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
F extends Frame |
Frame |
Properties
Section titled “Properties”grouping?
Section titled “grouping?”grouping?: FrameGrouping;Defined in: relay-sdks/ts/src/frame-writer.ts:47
Default 'keyframe'.
maxBacklog?
Section titled “maxBacklog?”maxBacklog?: number;Defined in: relay-sdks/ts/src/frame-writer.ts:57
How many frames may wait behind the one being written before the writer drops. A positive integer; default 8 under keyframe grouping, 25 under frame grouping.
onKeyframeNeeded?
Section titled “onKeyframeNeeded?”onKeyframeNeeded?: () => void;Defined in: relay-sdks/ts/src/frame-writer.ts:62
Called synchronously each time the writer comes to need a keyframe after its start (see
FrameWriter.keyframeNeeded), so an encoder can force one. An exception from it goes to console.error.
Returns
Section titled “Returns”void
stale?
Section titled “stale?”stale?: (frame) => boolean;Defined in: relay-sdks/ts/src/frame-writer.ts:52
Whether a frame is too late to send, against the application’s own clock. Consulted before a group opens and again before each write, since time passes inside those steps.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
frame |
F |
Returns
Section titled “Returns”boolean