Discover the windows and devices that are available to record.
Log what's going on to the console for easy debugging and troubleshooting.
Check and request the apps permission to access the recording devices.
Initialize the RecordKit SDK.
⚠️ Must be called before calling any other RecordKit method.
Path to the recordkit-rpc
binary, most of the time this should be set to path.join(process.resourcesPath, 'recordkit-rpc')
.
Optional
fallbackWhether 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
logSet the global log level. Defaults to debug
.
This is the same as calling setLogLevel
right after initialization.
Optional
output_Optional
settings?: { Optional
allowA list of microphones that are connected to the system.
A list of iOS devices that are connected to the system.
A list of currently running applications that can be used for screen or audio recording.
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.
Indicates if camera can be used.
Authorization status that indicates whether the user grants the app permission to capture video.
Indicates if microphone can be used.
Authorization status that indicates whether the user grants the app permission to capture audio.
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.
Boolean value that indicates whether the user granted or denied access to your app.
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.
Boolean value that indicates whether the user granted or denied access to your app.
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.
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.
Currently, system audio recording is currently implemented using ScreenCaptureKit, which means the users needs to grant screen recording access.
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.
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.
Generated using TypeDoc
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.