PlanetKitScreenCaptureDisplay

public class PlanetKitScreenCaptureDisplay : NSObject

A class representing a screen capture display in the PlanetKit framework.

  • The unique identifier of the display.

    Declaration

    Swift

    @objc
public var displayID: CGDirectDisplayID { get }

  • The image of the display.

    Declaration

    Swift

    @objc
public var image: CGImage? { get }

  • The unit number of the display.

    Declaration

    Swift

    @objc
public var unitNumber: UInt32 { get }

  • The model number of the display.

    Declaration

    Swift

    @objc
public var modelNumber: UInt32 { get }

  • The serial number of the display.

    Declaration

    Swift

    @objc
public var serialNumber: UInt32 { get }

  • The vendor number of the display.

    Declaration

    Swift

    @objc
public var vendorNumber: UInt32 { get }

  • A Boolean value indicating whether the display is asleep.

    Declaration

    Swift

    @objc
public var isAsleep: Bool { get }

  • A Boolean value indicating whether the display is always in a mirror set.

    Declaration

    Swift

    @objc
public var isAlwaysInMirrorSet: Bool { get }

  • A Boolean value indicating whether the display is in a hardware mirror set.

    Declaration

    Swift

    @objc
public var isInHWMirrorSet: Bool { get }

  • A Boolean value indicating whether the display is in a mirror set.

    Declaration

    Swift

    @objc
public var isInMirrorSet: Bool { get }

  • The mirror display of the current display.

    Declaration

    Swift

    @objc
public var mirrorDisplay: PlanetKitScreenCaptureDisplay? { get }

  • The primary display.

    Declaration

    Swift

    @objc
public var primaryDisplay: PlanetKitScreenCaptureDisplay { get }

  • A Boolean value indicating whether the display is built-in.

    Declaration

    Swift

    @objc
public var isBuiltin: Bool { get }

  • A Boolean value indicating whether the display is the main display.

    Declaration

    Swift

    @objc
public var isMain: Bool { get }

  • A Boolean value indicating whether the display is online.

    Declaration

    Swift

    @objc
public var isOnline: Bool { get }

  • A Boolean value indicating whether the display is active.

    Declaration

    Swift

    @objc
public var isActive: Bool { get }

  • A Boolean value indicating whether the display supports stereo.

    Declaration

    Swift

    @objc
public var isStereo: Bool { get }

  • The rotation angle of the display in degrees.

    Declaration

    Swift

    @objc
public var rotation: Double { get }

  • The size of the display in points.

    Declaration

    Swift

    @objc
public var screenSize: CGSize { get }

  • The bounds of the display in points.

    Declaration

    Swift

    @objc
public var bounds: CGRect { get }

  • The color space of the display.

    Declaration

    Swift

    @objc
public var colorSpace: CGColorSpace { get }

  • The captured bounds of the last window image captured using capture(). The default value is .zero.

    Declaration

    Swift

    @objc
public internal(set) var capturedBounds: CGRect { get }

  • A string representation of the display.

    Declaration

    Swift

    public override var description: String { get }

Capturable

  • Captures the screen and returns the result.

    Declaration

    Swift

    @objc
public func capture() -> PlanetKitScreenCapturableResult

    Return Value

    The result of the screen capture.

  • Stops the screen capture.

    Declaration

    Swift

    @objc
public func stopCapture()