readme.md

node-mac-virtual-display: Native Library for Virtual Display on macOS

A native library for macOS to create virtual displays for your applications using Node.js. This library uses CoreGraphics and CoreDisplay APIs to provide an interface for creating and managing virtual displays on macOS. This library is used in Tab Display, a service that allows iPads and Android tablets to be used as portable monitors.

Features

• Create and Destroy single virtual displays on macOS.
• Configurable display resolution and refresh rate.
• Create a virtual display by cloning the main display.
• Added option to select between Mirror and Extend display modes
• Support for multiple virtual displays.

Requirements

• macOS 10.14 or later
• Node.js 12 or later

Installation

Use npm to install the library:

yarn add node-mac-virtual-display

Usage

To create/destroy a virtual display:

const VirtualDisplay = require('node-mac-virtual-display')
const vdisplay = new VirtualDisplay()
// Clone primary display
vdisplay.cloneVirtualDisplay({
  displayName: "Clone Display",
  mirror: true
})
// OR
// To create a virtual display:
vdisplay.createVirtualDisplay({
  width: 1920,
  height: 1080,
  frameRate: 60,
  hiDPI: true,
  displayName: "Virtual Display",
  mirror: false
})

//To destroy a virtual display:
vdisplay.destroyVirtualDisplay()

Contribute

Coffee fuels coding ☕️