Interface BundleInfo

Describes a recording bundle's contents (the parsed recordkit.json). Mirrors the Swift RKBundleInfo; the per-event sidecar types live in RecordingMetadata.ts.

interface BundleInfo {
    version: 1;
    duration: number;
    files: {
        type: "mouse" | "webcam" | "appleDevice" | "systemAudio" | "screen" | "audio" | "topWindow";
        filename: string;
        related?: string[];
        recordingSize?: {
            width: number;
            height: number;
        };
        videoDimensions?: {
            width: number;
            height: number;
        };
    }[];
}

Properties

version duration files

Properties

version

version: 1

duration

duration: number

Total duration of the recording, in seconds.

files

files: {
    type: "mouse" | "webcam" | "appleDevice" | "systemAudio" | "screen" | "audio" | "topWindow";
    filename: string;
    related?: string[];
    recordingSize?: {
        width: number;
        height: number;
    };
    videoDimensions?: {
        width: number;
        height: number;
    };
}[]

Type declaration

  • type: "mouse" | "webcam" | "appleDevice" | "systemAudio" | "screen" | "audio" | "topWindow"
  • filename: string
  • Optional related?: string[]

    Filenames of related sidecar files for this asset (e.g. input-event JSON), relative to the bundle.

  • Optional recordingSize?: {
        width: number;
        height: number;
    }

    Logical size of the recorded area, in points (e.g. 2560x1440 for a Retina 5K display).

    • width: number
    • height: number
  • Optional videoDimensions?: {
        width: number;
        height: number;
    }

    Dimensions of the output video, in pixels.

    • width: number
    • height: number

Settings

Member Visibility

Theme

On This Page

versiondurationfiles

Generated using TypeDoc