Interface RecorderSettings

Settings that apply to the whole recording session.

interface RecorderSettings {
    allowFrameReordering?: boolean;
    updatesUserPreferred?: boolean;
    audioSegmentDuration?: number;
    videoSegmentDuration?: number;
    keyframeIntervalDuration?: number;
}

Properties

allowFrameReordering? updatesUserPreferred? audioSegmentDuration? videoSegmentDuration? keyframeIntervalDuration?

Properties

Optional allowFrameReordering

allowFrameReordering?: boolean

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.

Optional updatesUserPreferred

updatesUserPreferred?: boolean

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).

Optional audioSegmentDuration

audioSegmentDuration?: number

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

Optional videoSegmentDuration

videoSegmentDuration?: number

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

Optional keyframeIntervalDuration

keyframeIntervalDuration?: number

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.

Settings

Member Visibility

Theme

On This Page

allowFrameReorderingupdatesUserPreferredaudioSegmentDurationvideoSegmentDurationkeyframeIntervalDuration

Generated using TypeDoc