Interface Display

A Mac display that can be used for screen recording.

interface Display {
    id: number;
    localizedName?: string;
    symbolName: string;
    frame: Bounds;
    visibleFrame?: Bounds;
    isMain: boolean;
    availability: "available" | "notConnected" | "lidClosed";
}

Properties

id localizedName? symbolName frame visibleFrame? isMain availability

Properties

id

id: number

An identifier that uniquely identifies this Mac display (CGDirectDisplayID).

Optional localizedName

localizedName?: string

Name of this display.

symbolName

symbolName: string

SF Symbol name representing this display (e.g. laptopcomputer, display), suitable for use in the UI.

frame

frame: Bounds

Frame of the display, relative to the main display. Uses top-left coordinate space.

Optional visibleFrame

visibleFrame?: Bounds

Visible frame of the display (excluding the menu bar and Dock), relative to the main display. Top-left coordinate space.

isMain

isMain: boolean

Indicates if this is the main display.

availability

availability: "available" | "notConnected" | "lidClosed"

The current availability state of this display.

  • available: A display can be recorded
  • lidClosed: A display cannot be recorded, because the MacBook lid is closed (recovery: "Open MacBook lid")
  • notConnected: A display cannot be screen recorded, because it is currently not connected (recovery: "Connect display")

Settings

Member Visibility

Theme

On This Page

idlocalizedNamesymbolNameframevisibleFrameisMainavailability

Generated using TypeDoc