Interface RecorderSettings

Specifies if RecordKit is allowed to do frame reordering in video files. Defaults to true.

When enabled, to achieve the best compression some video encoders can reorder frames and generate B-frames.

Whether a successful recording updates the user's preferred devices for the sources it used. Defaults to true.

When enabled, starting a recording sets the devices in the schema as the user's preferred devices (for the device types that support this).

Target duration, in whole seconds, of each audio segment when using segmented output. Defaults to 6. Fractional values are not supported.

Target duration, in whole seconds, of each video segment when using segmented output. Defaults to 2. Fractional values are not supported.

Maximum interval, in seconds, between keyframes in the video stream. Defaults to no forced interval.

When set, the encoder places a keyframe at least every this many seconds. The frame-count based maximum keyframe interval is computed automatically from the video frame rate. When omitted, the encoder uses its default keyframe-placement heuristic.

Minimum free disk space, in bytes, that must remain available on the recording volume. Defaults to 104857600 (100 MB).

While recording, RecordKit periodically checks the actual available capacity of the volume the recording is written to (purgeable/opportunistic space is not counted). Shortly after the available capacity drops below this watermark the recording is aborted with an insufficientDiskSpace error. Keep the watermark high enough to absorb whatever is still written between two checks and to leave room to finalize the recording. Set to 0 to disable runtime disk space monitoring (record until the disk is full); disabling it may result in corrupt recordings.

Minimum free disk space, in bytes, required before a recording can be prepared. Checked once during prepare(). Defaults to 157286400 (150 MB).

When the available capacity is below this value, prepare() fails with an insufficientDiskSpace error so a doomed recording never begins. This watermark is independent of minimumFreeDiskSpace — set it higher to require headroom up front. Set to 0 to disable the prepare-time check while keeping runtime monitoring active (start on a near-full disk, but still abort if it gets critically low).