Class RecordKit

Entry point for the RecordKit SDK, an instance is available as recordkit that can be imported from the module. Do not instantiate this class directly.

Methods

initialize createRecorder

Discovery

Discover the windows and devices that are available to record.

getDisplays getWindows getCameras getMicrophones getAppleDevices

Logging

Log what's going on to the console for easy debugging and troubleshooting.

setLogLevel setCategoryLogLevel

Permissions

Check and request the apps permission to access the recording devices.

getCameraAuthorizationStatus getMicrophoneAuthorizationStatus getScreenRecordingAccess requestCameraAccess requestMicrophoneAccess requestScreenRecordingAccess

Methods

initialize

  • initialize(args): Promise<void>

  • Initialize the RecordKit SDK.

    ⚠️ Must be called before calling any other RecordKit method.

    Parameters

    • args: {
          rpcBinaryPath: string;
          fallbackToNodeModules?: boolean;
          logLevel?: LogLevel;
      }
      • rpcBinaryPath: string

        Path to the recordkit-rpc binary, most of the time this should be set to path.join(process.resourcesPath, 'recordkit-rpc').

      • Optional fallbackToNodeModules?: boolean

        Whether to fallback to the RPC binary from node_modules if the given path does not exist. When enabled an extra check to see if the given path exists is performed. Most of the time this should be set to !app.isPackaged.

      • Optional logLevel?: LogLevel

        Set the global log level. Defaults to debug.

        This is the same as calling setLogLevel right after initialization.

    Returns Promise<void>

createRecorder

  • createRecorder(schema): Promise<Recorder>

  • Parameters

    • schema: {
          output_directory?: string;
          items: RecorderSchemaItem[];
          settings?: {
              allowFrameReordering?: boolean;
          };
      }
      • Optional output_directory?: string
      • items: RecorderSchemaItem[]
      • Optional settings?: {
            allowFrameReordering?: boolean;
        }
        • Optional allowFrameReordering?: boolean

    Returns Promise<Recorder>

Discovery

getDisplays

getWindows

getCameras

getMicrophones

getAppleDevices

Logging

setLogLevel

  • setLogLevel(logLevel): Promise<void>

  • Set the global log level. Defaults to debug.

    Messages with a lower level than this will be ignored and not passed to any log handlers.

    Parameters

    Returns Promise<void>

setCategoryLogLevel

  • setCategoryLogLevel(params): Promise<void>

  • Overrides the global log level for a specific category. Defaults to the global log level.

    Messages in the given category with a lower level than this will be ignored and not passed to any log handlers.

    Parameters

    • params: {
          category: string;
          logLevel?: LogLevel;
      }
      • category: string
      • Optional logLevel?: LogLevel

    Returns Promise<void>

Permissions

getCameraAuthorizationStatus

getMicrophoneAuthorizationStatus

getScreenRecordingAccess

  • getScreenRecordingAccess(): Promise<boolean>

  • Returns Promise<boolean>

requestCameraAccess

  • requestCameraAccess(): Promise<boolean>

  • Returns Promise<boolean>

requestMicrophoneAccess

  • requestMicrophoneAccess(): Promise<boolean>

  • Returns Promise<boolean>

requestScreenRecordingAccess

  • requestScreenRecordingAccess(): Promise<void>

  • Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

initializecreateRecordergetDisplaysgetWindowsgetCamerasgetMicrophonesgetAppleDevicessetLogLevelsetCategoryLogLevelgetCameraAuthorizationStatusgetMicrophoneAuthorizationStatusgetScreenRecordingAccessrequestCameraAccessrequestMicrophoneAccessrequestScreenRecordingAccess

Generated using TypeDoc