Type alias SystemAudioSchema

SystemAudioSchema: {
    type: "systemAudio";
    mode: "exclude";
    backend?: SystemAudioBackend;
    excludeOptions?: "currentProcess"[];
    excludedProcessIDs?: number[];
    output?: "singleFile";
    filename?: string;
} | {
    type: "systemAudio";
    mode: "exclude";
    backend?: SystemAudioBackend;
    excludeOptions?: "currentProcess"[];
    excludedProcessIDs?: number[];
    output: "segmented";
    filenamePrefix?: string;
    segmentCallback?: ((url) => void);
} | {
    type: "systemAudio";
    mode: "exclude";
    backend?: SystemAudioBackend;
    excludeOptions?: "currentProcess"[];
    excludedProcessIDs?: number[];
    output: "stream";
    streamCallback?: ((audioBuffer) => void);
} | {
    type: "systemAudio";
    mode: "include";
    backend?: SystemAudioBackend;
    includedApplicationIDs?: number[];
    output?: "singleFile";
    filename?: string;
} | {
    type: "systemAudio";
    mode: "include";
    backend?: SystemAudioBackend;
    includedApplicationIDs?: number[];
    output: "segmented";
    filenamePrefix?: string;
    segmentCallback?: ((url) => void);
} | {
    type: "systemAudio";
    mode: "include";
    backend?: SystemAudioBackend;
    includedApplicationIDs?: number[];
    output: "stream";
    streamCallback?: ((audioBuffer) => void);
}

Creates a recorder item for recording system audio. By default current process audio is excluded. Output is stored in a RecordKit bundle.

When using mode: 'exclude', all system audio is recorded except for excluded applications. When using mode: 'include', only audio from specified applications is recorded.

Type declaration

  • type: "systemAudio"
  • mode: "exclude"
  • Optional backend?: SystemAudioBackend
  • Optional excludeOptions?: "currentProcess"[]
  • Optional excludedProcessIDs?: number[]
  • Optional output?: "singleFile"
  • Optional filename?: string

Type declaration

  • type: "systemAudio"
  • mode: "exclude"
  • Optional backend?: SystemAudioBackend
  • Optional excludeOptions?: "currentProcess"[]
  • Optional excludedProcessIDs?: number[]
  • output: "segmented"
  • Optional filenamePrefix?: string
  • Optional segmentCallback?: ((url) => void)
      • (url): void

      • Parameters

        • url: string

        Returns void

Type declaration

  • type: "systemAudio"
  • mode: "exclude"
  • Optional backend?: SystemAudioBackend
  • Optional excludeOptions?: "currentProcess"[]
  • Optional excludedProcessIDs?: number[]
  • output: "stream"
  • Optional streamCallback?: ((audioBuffer) => void)

    Called with real-time audio buffer data compatible with Web Audio API. Requires _beta_coreAudio backend and macOS 14.2+

Type declaration

  • type: "systemAudio"
  • mode: "include"
  • Optional backend?: SystemAudioBackend
  • Optional includedApplicationIDs?: number[]
  • Optional output?: "singleFile"
  • Optional filename?: string

Type declaration

  • type: "systemAudio"
  • mode: "include"
  • Optional backend?: SystemAudioBackend
  • Optional includedApplicationIDs?: number[]
  • output: "segmented"
  • Optional filenamePrefix?: string
  • Optional segmentCallback?: ((url) => void)
      • (url): void

      • Parameters

        • url: string

        Returns void

Type declaration

  • type: "systemAudio"
  • mode: "include"
  • Optional backend?: SystemAudioBackend
  • Optional includedApplicationIDs?: number[]
  • output: "stream"
  • Optional streamCallback?: ((audioBuffer) => void)

    Called with real-time audio buffer data compatible with Web Audio API. Requires _beta_coreAudio backend and macOS 14.2+

Settings

Member Visibility

Theme

Generated using TypeDoc