https://github.com/clipy/screeen

Observe user screen shot event in macOS.
https://github.com/clipy/screeen

clipy macos sandbox screenshot swift

Last synced: about 2 months ago
JSON representation

Observe user screen shot event in macOS.

• Host: GitHub
• URL: https://github.com/clipy/screeen
• Owner: Clipy
• License: mit
• Created: 2016-07-10T13:34:45.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T21:48:03.000Z (about 1 year ago)
• Last Synced: 2025-04-13T12:09:07.040Z (about 2 months ago)
• Topics: clipy, macos, sandbox, screenshot, swift
• Language: Swift
• Homepage:
• Size: 162 KB
• Stars: 59
• Watchers: 2
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Screeen

[![Actions Status](https://github.com/Clipy/Screeen/workflows/Xcode-Build/badge.svg)](https://github.com/Clipy/Screeen/actions)

[![Release version](https://img.shields.io/github/release/Clipy/Screeen.svg)](https://github.com/Clipy/Screeen/releases/latest)

[![License: MIT](https://img.shields.io/github/license/Clipy/Screeen.svg)](https://github.com/Clipy/Screeen/blob/master/LICENSE)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![Version](https://img.shields.io/cocoapods/v/Screeen.svg)](http://cocoadocs.org/docsets/Screeen)

[![Platform](https://img.shields.io/cocoapods/p/Screeen.svg)](http://cocoadocs.org/docsets/Screeen)

[![SPM supported](https://img.shields.io/badge/SPM-supported-DE5C43.svg?style=flat)](https://swift.org/package-manager)

Observe user screen shot event and image in macOS.

## Usage

### CocoaPods

```

pod 'Screeen'

```

### Carthage

```

github "Clipy/Screeen"

```

## Example

```swift

let observer = ScreenShotObserver()

observer.delegate = self

observer.start()

```

```swift

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

```swift

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](./Documentation/SANDBOX.md) for more details on how to implement it.