Skip to content
/ Screeen Public

Observe user screen shot event in macOS.

License

Notifications You must be signed in to change notification settings

Clipy/Screeen

Repository files navigation

Screeen

Actions Status Release version License: MIT Carthage compatible Version Platform SPM supported

Observe user screen shot event and image in macOS.

Usage

CocoaPods

pod 'Screeen'

Carthage

github "Clipy/Screeen"

Example

let observer = ScreenShotObserver()
observer.delegate = self
observer.start()
func screenShotObserver(_ observer: ScreenShotObserver, addedItem item: NSMetadataItem) {
    print("added item == \(item)")
}

func screenShotObserver(_ observer: ScreenShotObserver, updatedItem item: NSMetadataItem) {
    print("updated item == \(item)")
}

func screenShotObserver(_ observer: ScreenShotObserver, removedItem item: NSMetadataItem) {
    print("removed item == \(item)")
}

Change observing status

observer.isEnabled = false // Stop observing
observer.isEnabled = true  // Restart observing

Security features of macOS 10.15 or higher

Security features have been enhanced since mac10.15 Catalina, and screenshot monitoring must be granted permission. The monitoring target can be specified for each directory, and the desktop directory is specified by default. 

When call start() for the first time, a permission alert will be displayed and monitoring will start when allow it.

Desktop directory monitoring (default)

let observer = ScreenShotObserver()
observer.start()

Desktop and Picture directories monitoring

let desktopPath = NSSearchPathForDirectoriesInDomains(.desktopDirectory, .userDomainMask, true).first
let picturePath = NSSearchPathForDirectoriesInDomains(.picturesDirectory, .userDomainMask, true).first
let directoryPaths = [desktopPath, picturePath].compactMap { $0 }
let observer = ScreenShotObserver(searchDirectoryPaths: directoryPaths)
observer.start()

Monitoring all screenshots on macOS 10.14 or earlier

let observer: ScreenShotObserver
if #available(macOS 10.15, *) {
    observer = ScreenShotObserver()
} else {
    observer = ScreenShotObserver(searchDirectoryPaths: [])
}
observer.start()

Sandbox support

In order to monitor screen shots in a Sandbox enabled application, the user must manually select the directory to be monitored.
See here for more details on how to implement it.