@nonstrict/recordkit 0.51.1 → 0.53.0

package/bin/README.md

@@ -1 +1 @@
-# recordkit-rpc 0.51.1
+# recordkit-rpc 0.53.0

package/out/RecordKit.d.ts

@@ -63,53 +63,149 @@ export declare class RecordKit extends EventEmitter {
         logLevel?: LogLevel;
     }): Promise<void>;
     /**
+     * A list of Mac displays that can be used for screen recording.
+     *
      * @group Discovery
      */
     getDisplays(): Promise<Display[]>;
     /**
+     * A list of macOS windows that can be used for screen recording.
+     *
      * @group Discovery
      */
     getWindows(): Promise<Window[]>;
     /**
+     * A list of cameras that are connected to the system.
+     *
+     * @param params.includeDeskView - Whether to include Desk View cameras in the results
      * @group Discovery
      */
-    getCameras(): Promise<Camera[]>;
+    getCameras(params?: {
+        includeDeskView?: boolean;
+    }): Promise<Camera[]>;
     /**
+     * A list of microphones that are connected to the system.
+     *
      * @group Discovery
      */
     getMicrophones(): Promise<Microphone[]>;
     /**
+     * A list of iOS devices that are connected to the system.
+     *
      * @group Discovery
      */
     getAppleDevices(): Promise<AppleDevice[]>;
     /**
+     * A list of currently running applications that can be used for screen or audio recording.
+     *
      * @group Discovery
      */
     getRunningApplications(): Promise<RunningApplication[]>;
     /**
+     * Indicates if camera can be used.
+     *
+     * Authorization status that indicates whether the user grants the app permission to capture video.
+     *
      * @group Permissions
      */
     getCameraAuthorizationStatus(): Promise<AuthorizationStatus>;
     /**
+     * Indicates if microphone can be used.
+     *
+     * Authorization status that indicates whether the user grants the app permission to capture audio.
+     *
      * @group Permissions
      */
     getMicrophoneAuthorizationStatus(): Promise<AuthorizationStatus>;
     /**
+     * Indicates if screen can be recorded.
+     *
      * @group Permissions
      */
     getScreenRecordingAccess(): Promise<boolean>;
     /**
+     * Indicates if system audio can be recorded.
+     *
+     * @group Permissions
+     */
+    getSystemAudioRecordingAccess(): Promise<boolean>;
+    /**
+     * Indicates if keystroke events of other apps can be recorded via Input Monitoring.
+     *
+     * @group Permissions
+     */
+    getInputMonitoringAccess(): Promise<boolean>;
+    /**
+     * Indicates if other apps can be controlled via Accessibility.
+     *
+     * @group Permissions
+     */
+    getAccessibilityControlAccess(): Promise<boolean>;
+    /**
+     * Requests the user's permission to allow the app to capture the camera.
+     *
+     * Prompts the users if this is the first time requesting access, otherwise immediately returns.
+     *
+     * @returns Boolean value that indicates whether the user granted or denied access to your app.
      * @group Permissions
      */
     requestCameraAccess(): Promise<boolean>;
     /**
+     * Requests the user's permission to allow the app to capture the microphone.
+     *
+     * Prompts the users if this is the first time requesting access, otherwise immediately returns.
+     *
+     * @returns Boolean value that indicates whether the user granted or denied access to your app.
      * @group Permissions
      */
     requestMicrophoneAccess(): Promise<boolean>;
     /**
+     * Requests the user's permission to allow the app to capture the screen.
+     *
+     * If this is the first time requesting access, this shows dialog that lets th users open System Settings.
+     * In System Settings, the user can allow the app permission to do screen recording.
+     *
+     * Afterwards, the users needs to restart this app, for the permission to become active in the app.
+     *
      * @group Permissions
      */
     requestScreenRecordingAccess(): Promise<void>;
+    /**
+     * Requests the user's permission to allow the app to capture system audio.
+     *
+     * If this is the first time requesting access, this shows dialog that lets th users open System Settings.
+     * In System Settings, the user can allow the app permission to do screen recording.
+     *
+     * Afterwards, the users needs to restart this app, for the permission to become active in the app.
+     *
+     * @remarks Currently, system audio recording is currently implemented using ScreenCaptureKit,
+     * which means the users needs to grant screen recording access.
+     *
+     * @group Permissions
+     */
+    requestSystemAudioRecordingAccess(): Promise<void>;
+    /**
+     * Requests the users's permission to monitor keystrokes of other apps via Input Monitoring.
+     *
+     * If this is the first time requesting access, this shows dialog that lets th users open System Settings.
+     * In System Settings, the user can allow the app permission to monitor other apps.
+     *
+     * Afterwards, the users needs to restart this app, for the permission to become active in the app.
+     *
+     * @group Permissions
+     */
+    requestInputMonitoringAccess(): Promise<void>;
+    /**
+     * Requests the users's permission to control other apps via Accessibility permissions.
+     *
+     * If this is the first time requesting access, this shows dialog that lets th users open System Settings.
+     * In System Settings, the user can allow the app permission to control apps.
+     *
+     * Afterwards, the users needs to restart this app, for the permission to become active in the app.
+     *
+     * @group Permissions
+     */
+    requestAccessibilityControlAccess(): Promise<void>;
     createRecorder(schema: {
         output_directory?: string;
         items: RecorderSchemaItem[];
@@ -133,31 +229,70 @@ export declare let recordkit: RecordKit;
  */
 export type AuthorizationStatus = 'notDetermined' | 'restricted' | 'denied' | 'authorized';
 /**
+ * An external iOS device that can be used for screen recording.
+ *
  * @group Discovery
  */
 export interface AppleDevice {
+    /** An identifier that uniquely identifies the device. */
     id: string;
+    /** A localized device name for display in the user interface. */
     name: string;
+    /** The model of this device. */
     model_id?: string;
+    /**
+     * The current availability state of this device.
+     *
+     * - `available`: Device can be recorded
+     * - `notPaired`: Device cannot be recorded because it is connected but not paired (recovery: "Tap 'Trust' on iPhone")
+     * - `notConnected`: Device cannot be recorded because it is currently not connected (recovery: "Connect via cable")
+     * - `pairedNeedsConnect`: Device cannot be recorded because it is paired but currently not connected (recovery: "(Re-)connect via cable")
+     * - `pairedNeedsReconnect`: Device cannot be recorded because it needs to be reconnected (recovery: "Unplug cable, and reconnect again")
+     */
     availability: 'available' | 'notPaired' | 'notConnected' | 'pairedNeedsConnect' | 'pairedNeedsReconnect';
 }
 /**
+ * A running macOS application of which windows or audio can be recorded.
+ *
  * @group Discovery
  */
 export interface RunningApplication {
+    /** Identifier for this application (process id). */
     id: number;
+    /** Display name of the application. */
     name?: string;
+    /** Bundle identifier of the application (e.g., "com.apple.Safari"). */
     bundle_identifier?: string;
+    /**
+     * The current availability state of this application.
+     *
+     * - `available`: Application can be recorded
+     * - `notRunning`: Application cannot be recorded because it is not (or no longer) running
+     */
     availability: 'available' | 'notRunning';
 }
 /**
+ * A camera whose video can be recorded.
+ *
  * @group Discovery
  */
 export interface Camera {
+    /** An identifier that uniquely identifies the camera. */
     id: string;
+    /** A localized camera name for display in the user interface. */
     name: string;
+    /** The model ID of this camera. */
     model_id: string;
+    /** The manufacturer of this camera. */
     manufacturer: string;
+    /**
+     * The current availability state of this camera.
+     *
+     * - `available`: Camera can be recorded
+     * - `lidClosed`: Camera cannot be recorded because the MacBook lid is closed (recovery: "Open MacBook lid")
+     * - `unknownSuspended`: Camera cannot be recorded because it is suspended for some unknown reason (recovery: "Unsuspend camera")
+     * - `notConnected`: Camera cannot be recorded because it is currently not connected (recovery: "Connect camera")
+     */
     availability: 'available' | 'lidClosed' | 'unknownSuspended' | 'notConnected';
     /**
      * This URL can be used in a `img` tag to display a live preview of the camera feed in your user interface.
@@ -168,33 +303,71 @@ export interface Camera {
     preview_url?: string;
 }
 /**
+ * A microphone whose audio can be recorded.
+ *
  * @group Discovery
  */
 export interface Microphone {
+    /** An identifier that uniquely identifies the microphone. */
     id: string;
+    /** A localized microphone name for display in the user interface. */
     name: string;
+    /** The model ID of this microphone. */
     model_id: string;
+    /** The manufacturer of this microphone. */
     manufacturer: string;
+    /**
+     * The current availability state of this microphone.
+     *
+     * - `available`: Microphone can be recorded
+     * - `lidClosed`: Microphone cannot be recorded because the MacBook lid is closed (recovery: "Open MacBook lid")
+     * - `unknownSuspended`: Microphone cannot be recorded because it is suspended for some unknown reason (recovery: "Unsuspend microphone")
+     * - `notConnected`: Microphone cannot be recorded because it is currently not connected (recovery: "Connect microphone")
+     */
     availability: 'available' | 'lidClosed' | 'unknownSuspended' | 'notConnected';
 }
 /**
+ * A Mac display that can be used for screen recording.
+ *
  * @group Discovery
  */
 export interface Display {
+    /** An identifier that uniquely identifies this Mac display (CGDirectDisplayID). */
     id: number;
+    /** Name of this display. */
     localizedName?: string;
+    /** Frame of the display, relative to the main display. Uses top-left coordinate space. */
     frame: Bounds;
+    /** Indicates if this is the main display. */
     isMain: boolean;
+    /**
+     * The current availability state of this display.
+     *
+     * - `available`: A display can be recorded
+     * - `lidClosed`: A display cannot be recorded, because the MacBook lid is closed (recovery: "Open MacBook lid")
+     * - `notConnected`: A display cannot be screen recorded, because it is currently not connected (recovery: "Connect display")
+     */
+    availability: 'available' | 'lidClosed' | 'notConnected';
 }
 /**
+ * A macOS window that can be used for screen recording.
+ *
  * @group Discovery
  */
 export interface Window {
+    /** An identifier that uniquely identifies this macOS window (CGWindowID). */
     id: number;
+    /** Title of the window. */
     title?: string;
+    /** Frame of the window, relative to the main display. Uses top-left coordinate space. */
     frame: Bounds;
+    /**
+     * The level of the window relative to other windows.
+     */
     level: number;
+    /** Process ID of the application that owns this window. */
     application_process_id?: number;
+    /** Name of the application that owns this window. */
     application_name?: string;
 }
 /**

package/out/RecordKit.js

@@ -70,77 +70,183 @@ export class RecordKit extends EventEmitter {
         await this.ipcRecordKit.nsrpc.perform({ type: 'Logger', action: 'setLogLevel', params });
     }
     /**
+     * A list of Mac displays that can be used for screen recording.
+     *
      * @group Discovery
      */
     async getDisplays() {
         return await this.ipcRecordKit.nsrpc.perform({ type: 'Recorder', action: 'getDisplays' });
     }
     /**
+     * A list of macOS windows that can be used for screen recording.
+     *
      * @group Discovery
      */
     async getWindows() {
         return await this.ipcRecordKit.nsrpc.perform({ type: 'Recorder', action: 'getWindows' });
     }
     /**
+     * A list of cameras that are connected to the system.
+     *
+     * @param params.includeDeskView - Whether to include Desk View cameras in the results
      * @group Discovery
      */
-    async getCameras() {
-        return await this.ipcRecordKit.nsrpc.perform({ type: 'Recorder', action: 'getCameras' });
+    async getCameras(params) {
+        return await this.ipcRecordKit.nsrpc.perform({ type: 'Recorder', action: 'getCameras', params: { includeDeskView: params?.includeDeskView ?? false } });
     }
     /**
+     * A list of microphones that are connected to the system.
+     *
      * @group Discovery
      */
     async getMicrophones() {
         return await this.ipcRecordKit.nsrpc.perform({ type: 'Recorder', action: 'getMicrophones' });
     }
     /**
+     * A list of iOS devices that are connected to the system.
+     *
      * @group Discovery
      */
     async getAppleDevices() {
         return await this.ipcRecordKit.nsrpc.perform({ type: 'Recorder', action: 'getAppleDevices' });
     }
     /**
+     * A list of currently running applications that can be used for screen or audio recording.
+     *
      * @group Discovery
      */
     async getRunningApplications() {
         return await this.ipcRecordKit.nsrpc.perform({ type: 'Recorder', action: 'getRunningApplications' });
     }
     /**
+     * Indicates if camera can be used.
+     *
+     * Authorization status that indicates whether the user grants the app permission to capture video.
+     *
      * @group Permissions
      */
     async getCameraAuthorizationStatus() {
         return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'getCameraAuthorizationStatus' });
     }
     /**
+     * Indicates if microphone can be used.
+     *
+     * Authorization status that indicates whether the user grants the app permission to capture audio.
+     *
      * @group Permissions
      */
     async getMicrophoneAuthorizationStatus() {
         return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'getMicrophoneAuthorizationStatus' });
     }
     /**
+     * Indicates if screen can be recorded.
+     *
      * @group Permissions
      */
     async getScreenRecordingAccess() {
         return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'getScreenRecordingAccess' });
     }
     /**
+     * Indicates if system audio can be recorded.
+     *
+     * @group Permissions
+     */
+    async getSystemAudioRecordingAccess() {
+        return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'getSystemAudioRecordingAccess' });
+    }
+    /**
+     * Indicates if keystroke events of other apps can be recorded via Input Monitoring.
+     *
+     * @group Permissions
+     */
+    async getInputMonitoringAccess() {
+        return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'getInputMonitoringAccess' });
+    }
+    /**
+     * Indicates if other apps can be controlled via Accessibility.
+     *
+     * @group Permissions
+     */
+    async getAccessibilityControlAccess() {
+        return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'getAccessibilityControlAccess' });
+    }
+    /**
+     * Requests the user's permission to allow the app to capture the camera.
+     *
+     * Prompts the users if this is the first time requesting access, otherwise immediately returns.
+     *
+     * @returns Boolean value that indicates whether the user granted or denied access to your app.
      * @group Permissions
      */
     async requestCameraAccess() {
         return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'requestCameraAccess' });
     }
     /**
+     * Requests the user's permission to allow the app to capture the microphone.
+     *
+     * Prompts the users if this is the first time requesting access, otherwise immediately returns.
+     *
+     * @returns Boolean value that indicates whether the user granted or denied access to your app.
      * @group Permissions
      */
     async requestMicrophoneAccess() {
         return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'requestMicrophoneAccess' });
     }
     /**
+     * Requests the user's permission to allow the app to capture the screen.
+     *
+     * If this is the first time requesting access, this shows dialog that lets th users open System Settings.
+     * In System Settings, the user can allow the app permission to do screen recording.
+     *
+     * Afterwards, the users needs to restart this app, for the permission to become active in the app.
+     *
      * @group Permissions
      */
     async requestScreenRecordingAccess() {
         return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'requestScreenRecordingAccess' });
     }
+    /**
+     * Requests the user's permission to allow the app to capture system audio.
+     *
+     * If this is the first time requesting access, this shows dialog that lets th users open System Settings.
+     * In System Settings, the user can allow the app permission to do screen recording.
+     *
+     * Afterwards, the users needs to restart this app, for the permission to become active in the app.
+     *
+     * @remarks Currently, system audio recording is currently implemented using ScreenCaptureKit,
+     * which means the users needs to grant screen recording access.
+     *
+     * @group Permissions
+     */
+    async requestSystemAudioRecordingAccess() {
+        return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'requestSystemAudioRecordingAccess' });
+    }
+    /**
+     * Requests the users's permission to monitor keystrokes of other apps via Input Monitoring.
+     *
+     * If this is the first time requesting access, this shows dialog that lets th users open System Settings.
+     * In System Settings, the user can allow the app permission to monitor other apps.
+     *
+     * Afterwards, the users needs to restart this app, for the permission to become active in the app.
+     *
+     * @group Permissions
+     */
+    async requestInputMonitoringAccess() {
+        return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'requestInputMonitoringAccess' });
+    }
+    /**
+     * Requests the users's permission to control other apps via Accessibility permissions.
+     *
+     * If this is the first time requesting access, this shows dialog that lets th users open System Settings.
+     * In System Settings, the user can allow the app permission to control apps.
+     *
+     * Afterwards, the users needs to restart this app, for the permission to become active in the app.
+     *
+     * @group Permissions
+     */
+    async requestAccessibilityControlAccess() {
+        return await this.ipcRecordKit.nsrpc.perform({ type: 'AuthorizationStatus', action: 'requestAccessibilityControlAccess' });
+    }
     async createRecorder(schema) {
         return Recorder.newInstance(this.ipcRecordKit.nsrpc, schema);
     }

package/out/RecordKit.js.map

@@ -1 +1 @@
-{"version":3,"file":"RecordKit.js","sourceRoot":"","sources":["../src/RecordKit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAsB,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,SAAU,SAAQ,YAAY;IACjC,YAAY,GAAG,IAAI,YAAY,EAAE,CAAA;IAEzC,cAAc;IACd;QACE,KAAK,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,IAiBhB;QACC,IAAI,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;QACtC,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,EAAE,CAAC;YACvC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC/B,aAAa,GAAG,aAAa,CAAC,OAAO,CAAC,4DAA4D,EAAE,uCAAuC,CAAC,CAAA;gBAC5I,OAAO,CAAC,KAAK,CAAC,uEAAuE,aAAa,EAAE,CAAC,CAAA;YACvG,CAAC;QACH,CAAC;QAED,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,aAAa,EAAE,IAAI,CAAC,cAAc,CAAC,CAAA;QAEtE,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC;YACjE,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE;gBAClB,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAA;gBAClD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;YAC1B,CAAC;YACD,MAAM,EAAE,sBAAsB;YAC9B,SAAS,EAAE,IAAI;SAChB,CAAC,CAAA;QACF,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAA;QAElH,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACvC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,QAAkB;QAClC,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAA;IACxG,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB,CAAC,MAAiD;QACzE,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAA;IAC1F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW;QACf,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,CAAc,CAAA;IACxG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU;QACd,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,CAAa,CAAA;IACtG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU;QACd,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,CAAa,CAAA;IACtG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc;QAClB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAiB,CAAA;IAC9G,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe;QACnB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAkB,CAAA;IAChH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,sBAAsB;QAC1B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,wBAAwB,EAAE,CAAyB,CAAA;IAC9H,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,4BAA4B;QAChC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,8BAA8B,EAAE,CAAwB,CAAA;IAC9I,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gCAAgC;QACpC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,kCAAkC,EAAE,CAAwB,CAAA;IAClJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB;QAC5B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,0BAA0B,EAAE,CAAY,CAAA;IAC9H,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB;QACvB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,qBAAqB,EAAE,CAAY,CAAA;IACzH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,uBAAuB;QAC3B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,yBAAyB,EAAE,CAAY,CAAA;IAC7H,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,4BAA4B;QAChC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,8BAA8B,EAAE,CAAS,CAAA;IAC/H,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,MAMC;QACD,OAAO,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;CACF;AAED,cAAc;AACd,MAAM,CAAC,IAAI,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC"}
+{"version":3,"file":"RecordKit.js","sourceRoot":"","sources":["../src/RecordKit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAsB,MAAM,eAAe,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,SAAU,SAAQ,YAAY;IACjC,YAAY,GAAG,IAAI,YAAY,EAAE,CAAA;IAEzC,cAAc;IACd;QACE,KAAK,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,IAiBhB;QACC,IAAI,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;QACtC,IAAI,IAAI,CAAC,qBAAqB,IAAI,IAAI,EAAE,CAAC;YACvC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC/B,aAAa,GAAG,aAAa,CAAC,OAAO,CAAC,4DAA4D,EAAE,uCAAuC,CAAC,CAAA;gBAC5I,OAAO,CAAC,KAAK,CAAC,uEAAuE,aAAa,EAAE,CAAC,CAAA;YACvG,CAAC;QACH,CAAC;QAED,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,aAAa,EAAE,IAAI,CAAC,cAAc,CAAC,CAAA;QAEtE,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,eAAe,CAAC;YACjE,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE;gBAClB,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAA;gBAClD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;YAC1B,CAAC;YACD,MAAM,EAAE,sBAAsB;YAC9B,SAAS,EAAE,IAAI;SAChB,CAAC,CAAA;QACF,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAA;QAElH,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACvC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,QAAkB;QAClC,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAA;IACxG,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB,CAAC,MAAiD;QACzE,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAA;IAC1F,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QACf,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,CAAc,CAAA;IACxG,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU;QACd,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,CAAa,CAAA;IACtG,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,MAAsC;QACrD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE,eAAe,IAAI,KAAK,EAAE,EAAE,CAAa,CAAA;IACrK,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc;QAClB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAiB,CAAA;IAC9G,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe;QACnB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAkB,CAAA;IAChH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,sBAAsB;QAC1B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,wBAAwB,EAAE,CAAyB,CAAA;IAC9H,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,4BAA4B;QAChC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,8BAA8B,EAAE,CAAwB,CAAA;IAC9I,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gCAAgC;QACpC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,kCAAkC,EAAE,CAAwB,CAAA;IAClJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,wBAAwB;QAC5B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,0BAA0B,EAAE,CAAY,CAAA;IAC9H,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,6BAA6B;QACjC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,+BAA+B,EAAE,CAAY,CAAA;IACnI,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,wBAAwB;QAC5B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,0BAA0B,EAAE,CAAY,CAAA;IAC9H,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,6BAA6B;QACjC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,+BAA+B,EAAE,CAAY,CAAA;IACnI,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,mBAAmB;QACvB,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,qBAAqB,EAAE,CAAY,CAAA;IACzH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,uBAAuB;QAC3B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,yBAAyB,EAAE,CAAY,CAAA;IAC7H,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,4BAA4B;QAChC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,8BAA8B,EAAE,CAAS,CAAA;IAC/H,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,iCAAiC;QACrC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,mCAAmC,EAAE,CAAS,CAAA;IACpI,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,4BAA4B;QAChC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,8BAA8B,EAAE,CAAS,CAAA;IAC/H,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,iCAAiC;QACrC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,mCAAmC,EAAE,CAAS,CAAA;IACpI,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,MAMC;QACD,OAAO,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;CACF;AAED,cAAc;AACd,MAAM,CAAC,IAAI,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC"}

package/out/Recorder.d.ts

@@ -27,8 +27,10 @@ export declare class Recorder extends EventEmitter {
 /**
  * @group Recording
  */
-export type RecorderSchemaItem = WebcamSchema | DisplaySchema | WindowBasedCropSchema | AppleDeviceStaticOrientationSchema | SystemAudioSchema | ApplicationAudioSchema;
+export type RecorderSchemaItem = WebcamSchema | DisplaySchema | WindowBasedCropSchema | AppleDeviceStaticOrientationSchema | SystemAudioSchema | ApplicationAudioSchema | MicrophoneSchema;
 /**
+ * Creates a recorder item for a webcam movie file, using the provided microphone and camera. Output is stored in a RecordKit bundle.
+ *
  * @group Recording Schemas
  */
 export interface WebcamSchema {
@@ -38,6 +40,8 @@ export interface WebcamSchema {
     microphone: Microphone | string;
 }
 /**
+ * Creates a recorder item for recording a single display. Output is stored in a RecordKit bundle.
+ *
  * @group Recording Schemas
  */
 export type DisplaySchema = {
@@ -61,6 +65,8 @@ export type DisplaySchema = {
     segmentCallback?: (url: string) => void;
 };
 /**
+ * Creates a recorder item for recording the initial crop of a window on a display. Output is stored in a RecordKit bundle.
+ *
  * @group Recording Schemas
  */
 export type WindowBasedCropSchema = {
@@ -82,6 +88,8 @@ export type WindowBasedCropSchema = {
     segmentCallback?: (url: string) => void;
 };
 /**
+ * Creates a recorder item for an Apple device screen recording, using the provided deviceID. Output is stored in a RecordKit bundle.
+ *
  * @group Recording Schemas
  */
 export interface AppleDeviceStaticOrientationSchema {
@@ -94,16 +102,30 @@ export interface AppleDeviceStaticOrientationSchema {
  */
 export type SystemAudioMode = 'exclude' | 'include';
 /**
+ * Enumeration specifying the backend to use for system audio recording.
+ *
+ * - `screenCaptureKit`: Use ScreenCaptureKit for system audio recording.
+ * - `_beta_coreAudio`: This a beta feature, it is not fully implemented yet. Do not use in production. Currently only records single files in .caf format.
+ *
  * @group Recording Schemas
  */
 export type SystemAudioBackend = 'screenCaptureKit' | '_beta_coreAudio';
 /**
  * @group Recording Schemas
  */
-export type AudioOutputOptionsType = 'singleFile' | 'segmented';
+export type AudioOutputOptionsType = 'singleFile' | 'segmented' | 'stream';
 /**
  * @group Recording Schemas
  */
+export type MicrophoneOutputOptionsType = 'singleFile' | 'segmented' | 'stream';
+/**
+ * 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.
+ *
+ * @group Recording Schemas
+ */
 export type SystemAudioSchema = {
     type: 'systemAudio';
     mode: 'exclude';
@@ -121,6 +143,15 @@ export type SystemAudioSchema = {
     output: 'segmented';
     filenamePrefix?: string;
     segmentCallback?: (url: string) => void;
+} | {
+    type: 'systemAudio';
+    mode: 'exclude';
+    backend?: SystemAudioBackend;
+    excludeOptions?: ('currentProcess')[];
+    excludedProcessIDs?: number[];
+    output: 'stream';
+    /** Called with real-time audio buffer data compatible with Web Audio API. Requires _beta_coreAudio backend and macOS 14.2+ */
+    streamCallback?: (audioBuffer: AudioStreamBuffer) => void;
 } | {
     type: 'systemAudio';
     mode: 'include';
@@ -136,8 +167,18 @@ export type SystemAudioSchema = {
     output: 'segmented';
     filenamePrefix?: string;
     segmentCallback?: (url: string) => void;
+} | {
+    type: 'systemAudio';
+    mode: 'include';
+    backend?: SystemAudioBackend;
+    includedApplicationIDs?: number[];
+    output: 'stream';
+    /** Called with real-time audio buffer data compatible with Web Audio API. Requires _beta_coreAudio backend and macOS 14.2+ */
+    streamCallback?: (audioBuffer: AudioStreamBuffer) => void;
 };
 /**
+ * Creates a recorder item for recording the audio of a single application. Output is stored in a RecordKit bundle.
+ *
  * @group Recording Schemas
  */
 export type ApplicationAudioSchema = {
@@ -153,7 +194,56 @@ export type ApplicationAudioSchema = {
     output: 'segmented';
     filenamePrefix?: string;
     segmentCallback?: (url: string) => void;
+} | {
+    type: 'applicationAudio';
+    applicationID: number;
+    backend?: SystemAudioBackend;
+    output: 'stream';
+    /** Called with real-time audio buffer data compatible with Web Audio API. Requires _beta_coreAudio backend and macOS 14.2+ */
+    streamCallback?: (audioBuffer: AudioStreamBuffer) => void;
+};
+/**
+ * Creates a recorder item for an audio file, using the provided microphone. Output is stored in a RecordKit bundle.
+ *
+ * @group Recording Schemas
+ */
+export type MicrophoneSchema = {
+    type: 'microphone';
+    microphone: Microphone | string;
+    leftChannelOnly?: boolean;
+    audioDelay?: number;
+    output?: 'singleFile';
+    filename?: string;
+} | {
+    type: 'microphone';
+    microphone: Microphone | string;
+    leftChannelOnly?: boolean;
+    audioDelay?: number;
+    output: 'segmented';
+    filenamePrefix?: string;
+    segmentCallback?: (url: string) => void;
+} | {
+    type: 'microphone';
+    microphone: Microphone | string;
+    output: 'stream';
+    /** Called with real-time audio buffer data compatible with Web Audio API */
+    streamCallback?: (audioBuffer: AudioStreamBuffer) => void;
 };
+/**
+ * Audio buffer compatible with Web Audio API
+ *
+ * @group Recording
+ */
+export interface AudioStreamBuffer {
+    /** Sample rate in Hz (e.g., 44100, 48000) */
+    sampleRate: number;
+    /** Number of audio channels */
+    numberOfChannels: number;
+    /** Number of frames per channel */
+    numberOfFrames: number;
+    /** Non-interleaved Float32 audio data - one array per channel */
+    channelData: Float32Array[];
+}
 /**
  * @group Recording
  */