PlanetKitScreenCaptureWindow

A window used for screen capture in the PlanetKit framework.

  • The ID of the window.

  • Sets a custom filter if you want to select and capture part or all of a window for the target application.

    Remark

    If you do not set the filter, the default filter is used for capturing depending on the Bundle ID internally. If you want to easily capture an app that consists of multiple windows, consider using hasMultipleWindows.

  • The image representation of the window.

  • The backing type of the window.

  • The level of the window.

  • The bounds of the window.

  • The sharing type of the window.

  • The alpha value of the window.

  • pid

    The process ID of the window’s owner.

  • The memory usage of the window.

  • The name of the window’s owner.

  • The name of the window.

  • Indicates whether the window is on screen.

    Remark

    This value remembers whether the PlanetKitScreenCaptureWindow was on screen at the time it was created. To check if it is currently visible on the screen, use isVisibleOnScreen.

  • Indicates whether the window’s backing is located in video memory.

  • The rectangle of the captured window image.

    Remark

    If the last window image is captured successfully from PlanetKitScreenCaptureWindow.capture(), the captured window rectangle will be set at capturedBounds. The default value is .zero. This value is based on the screen coordinates system.

  • The bundle identifier of the window’s owner.

  • The bundle object associated with the window’s bundle ID.

  • Indicates whether the target application window has multiple windows and the whole windows or a specific window need to be captured.

    Remark

    The default value is false.

  • Checks if the window with the specified window ID is currently visible on the screen.

  • Initializes a PlanetKitScreenCaptureWindow instance with the given window ID.

  • A textual representation of the PlanetKitScreenCaptureWindow instance.

  • Returns an array of PlanetKitScreenCaptureWindow instances based on the given window ID and option.

  • Returns a PlanetKitScreenCaptureWindow instance based on the given window ID.

  • Returns an array of PlanetKitScreenCaptureWindow instances based on the given process ID.

Capturable