Type alias DisplaySchema

DisplaySchema: {
    type: "display";
    display: Display | number;
    colorSpace?: ColorSpace;
    videoCodec?: VideoCodec;
    shows_cursor?: boolean;
    mouse_events?: boolean;
    keyboard_events?: boolean;
    include_audio?: boolean;
    output?: "singleFile";
    filename?: string;
} | {
    type: "display";
    display: Display | number;
    colorSpace?: ColorSpace;
    videoCodec?: VideoCodec;
    shows_cursor?: boolean;
    mouse_events?: boolean;
    keyboard_events?: boolean;
    include_audio?: boolean;
    output: "segmented";
    filenamePrefix?: string;
    segmentCallback?: ((url) => void);
}

Creates a recorder item for recording a single display. Output is stored in a RecordKit bundle.

Type declaration

  • type: "display"
  • display: Display | number
  • Optional colorSpace?: ColorSpace

    Color space for the recording. Defaults to 'sRGB'. Note: 'displayP3' requires 'hevc' video codec.

  • Optional videoCodec?: VideoCodec

    Video codec for the recording. Defaults to 'h264'.

  • Optional shows_cursor?: boolean
  • Optional mouse_events?: boolean
  • Optional keyboard_events?: boolean
  • Optional include_audio?: boolean
  • Optional output?: "singleFile"
  • Optional filename?: string

Type declaration

  • type: "display"
  • display: Display | number
  • Optional colorSpace?: ColorSpace

    Color space for the recording. Defaults to 'sRGB'. Note: 'displayP3' requires 'hevc' video codec.

  • Optional videoCodec?: VideoCodec

    Video codec for the recording. Defaults to 'h264'.

  • Optional shows_cursor?: boolean
  • Optional mouse_events?: boolean
  • Optional keyboard_events?: boolean
  • Optional include_audio?: boolean
  • output: "segmented"
  • Optional filenamePrefix?: string
  • Optional segmentCallback?: ((url) => void)
      • (url): void

      • Parameters

        • url: string

        Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc