Skip to content package
aperture v6.1.2 Record the screen on macOS
node >=10 6 deps cjs types open source
overview readme
license MIT
deps 6
unpacked 4.0 MB
files 6
node >=10 $ npm install aperture@6.1.2n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
install size Estimated unpacked size across 33 packages.
4.8 MB
Includes dependencies.
dependencies 6 direct · 3 outdated
versions Latest published Mar 27, 2024
contents aperture-node
Record the screen on macOS from Node.js
Install
Requires macOS 10.13 or later.
Usage
import {setTimeout} from 'node:timers/promises' ;
import {recorder} from 'aperture'
Dec 15, 2021
maintainers Registry package owners.
;
const options = {
fps: 30 ,
cropArea: {
x: 100 ,
y: 100 ,
width: 500 ,
height: 500 ,
},
};
await recorder. startRecording (options);
await setTimeout ( 3000 );
console. log ( await recorder. stopRecording ());
//=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/cdf4f7df426c97880f8c10a1600879f7.mp4'
copy
See example.js if you want to quickly try it out. (The example requires Node.js 18+)
API
screens() -> Promise<Object[]> Get a list of screens. The first screen is the primary screen.
[
{
id: 69732482 ,
name: 'Color LCD' ,
},
]; copy
audioDevices() -> Promise<Object[]> Get a list of audio devices.
[
{
id: 'AppleHDAEngineInput:1B,0,1,0:1' ,
name: 'Built-in Microphone' ,
},
]; copy
videoCodecs -> Map Get a list of available video codecs. The key is the videoCodec option name and the value is the codec name. It only returns hevc if your computer supports HEVC hardware encoding.
Map {
'h264' => 'H264' ,
'hevc' => 'HEVC' ,
'proRes422' => 'Apple ProRes 422' ,
'proRes4444' => 'Apple ProRes 4444'
} copy
recorder Returns a Promise that fullfills when the recording starts or rejects if the recording didn't start after 5 seconds.
recorder.isFileReady Promise that fullfills with the path to the screen recording file when it's ready. This will never reject.
Only available while a recording is happening, undefined otherwise.
Usually, this resolves around 1 second before the recording starts, but that's not guaranteed.
recorder.pause() Pauses the recording. To resume, call recorder.resume().
Returns a Promise that fullfills when the recording has been paused.
recorder.resume() Resumes the recording if it's been paused.
Returns a Promise that fullfills when the recording has been resumed.
recorder.isPaused() Returns a Promise that resolves with a boolean indicating whether or not the recording is currently paused.
recorder.stopRecording() Returns a Promise for the path to the screen recording file.
Options
fps Number of frames per seconds.
cropArea Type: object
Default: undefined
Record only an area of the screen. Accepts an object with x, y, width, height properties.
showCursor Type: boolean
Default: true
Show the cursor in the screen recording.
highlightClicks Type: boolean
Default: false
Highlight cursor clicks in the screen recording.
Enabling this will also enable the showCursor option.
screenId Type: number
Default: aperture.screens()[0] (Primary screen)
audioDeviceId Type: string
Default: undefined
Audio device to include in the screen recording. Should be one of the id's from aperture.audioDevices().
videoCodec Type: string
Default: 'h264'
Values: 'hevc' | 'h264' | 'proRes422' | 'proRes4444'
A computer with Intel 6th generation processor or newer is strongly recommended for the hevc codec, as otherwise it will use software encoding, which only produces 3 FPS fullscreen recording.
Why Aperture was built to fulfill the needs of Kap , providing a JavaScript interface to the best available method for recording the screen. That's why it's currently a wrapper for a Swift script that records the screen using the AVFoundation framework .
But you can use ffmpeg -f avfoundation... Yes, we can, but the performance is terrible:
Recording the entire screen with ffmpeg -f avfoundation -i 1 -y test.mp4:
Recording the entire screen with Aperture:
Aperture - The Swift framework used in this package