Interface: RecordingOptions
@roomful/core / RecordingOptions
Interface: RecordingOptions
Section titled “Interface: RecordingOptions”Defined in: packages/core/src/types.ts:2380
Configures the recording engine, including privacy controls.
Properties
Section titled “Properties”maxFrames?
Section titled “maxFrames?”
optionalmaxFrames:number
Defined in: packages/core/src/types.ts:2395
A retention cap: keep only the most recent maxFrames frames, dropping the oldest first. Bounds
the memory a long-running capture holds. Omit for no cap (keep everything).
redact()?
Section titled “redact()?”
optionalredact: (frame) =>RecordingFrame|null
Defined in: packages/core/src/types.ts:2389
A privacy hook applied to every frame before it is stored, so sensitive data never enters the
recording. Return the frame (optionally with its signal masked in place) to keep it, or null
to drop it entirely. The frame’s signal is a fresh clone, so mutating it is safe.
Parameters
Section titled “Parameters”The candidate frame (with a cloned signal).
Returns
Section titled “Returns”RecordingFrame | null
The frame to store, or null to drop it.