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.

Free disk space, in bytes, below which a running recording is aborted. 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 level the recording is aborted with an insufficientDiskSpace error. Keep it high enough to absorb whatever is still written between two checks and to leave room to finalize the recording. Set to 0 to never abort on disk space (record until the disk is full), which may result in a corrupt recording. A diskSpaceWarningLevel keeps being reported either way.

See

RecorderSettings.diskSpaceWarningLevel, the higher level that warns instead of aborting.

Free disk space, in bytes, below which the recording volume counts as running low. Defaults to 157286400 (150 MB).

Checked once during prepare(), which fails with an insufficientDiskSpace error when the volume is already below it, and then periodically while recording. Dropping below it during a recording does not interrupt anything, it raises a lowDiskSpace Signal on the signals event so your app can warn the user; the signal clears again once enough space is freed up.

Set this higher than diskSpaceAbortLevel so there is room to warn before the recording is aborted at that lower level. Set to 0 to disable both the prepare-time check and the signal.