Notes on document

Please note, this document is in an early draft form. It’s primary purpose is to discover how we will define APIs, rather than discover the detail of a specific API method. In other words, now is not the time to ask “Why doesn’t it support xyz?”, however, it is a good time to ask “If we were to add xyz, where would it live?”

Background

The purpose of the ScreenSnippet API is to allow a user to take screenshots of their desktop (unconstrained by the host application), highlight portions of the captured image and then share the output with their application. 

This functionality is similar to the Windows Screen Snippet tool that lets a user captures portions of the Windows Desktop, highlight aspects of the image and then save this image for sharing.

This functionality differs from the Electron BrowserWindow.capturePage API in that Electron is restricted in that it can only capture content from the host application and does not provide any annotation functionality.

API Design Principles

Our general principles are as follows:

Prior Art

Our general principles are as follows: