@0biwank/screen-capture

@0biwank/screen-capture

Native screen capture addon for Node.js with HLS muxing support for macOS.

Installation

npm install @0biwank/screen-capture

Platform Support

• macOS only (darwin)

Usage

const screenCapture = require('@0biwank/screen-capture');

// List available display sources
const displays = screenCapture.listDisplaySources();
console.log('Available displays:', displays);

// List available window sources
const windows = screenCapture.listWindowSources();
console.log('Available windows:', windows);

// Select a source (display or window)
const sourceId = displays[0].id; // or windows[0].id
screenCapture.selectSource(sourceId);

// Start capturing
screenCapture.startCapture();

// Process media stream (with HLS muxing)
screenCapture.processMediaStream();

// Stop capturing
screenCapture.stopCapture();

API

listDisplaySources()

Returns an array of available display sources.

Returns: Array<{id: string, name: string}>

listWindowSources()

Returns an array of available window sources.

Returns: Array<{id: string, name: string}>

selectSource(sourceId)

Selects a source (display or window) for capture.

Parameters:

• sourceId (string): The ID of the source to capture

Returns: boolean

startCapture()

Starts the screen capture.

Returns: boolean

processMediaStream()

Processes the captured media stream with HLS muxing.

Returns: boolean

stopCapture()

Stops the screen capture.

Returns: boolean

Requirements

• Node.js >= 14.0.0
• macOS (darwin)

License

MIT