Merge branch 'master' into bryphe/docs/editorlayer-to-bufferlayer

INDEX.md

@@ -4,7 +4,22 @@ This documents the surface area of Oni's API, which is available to both _plugin
 
 A good starting point is the [Plugin API](interfaces/plugin.api.html), which is the object passed into the `activate` methods.
 
-An example `config.js` using the API object is:
+The [Plugin API](interfaces/plugin.api.html) is available in a few places:
+
+### Developer Tools
+
+There is a global `Oni` object available in the developer tools:
+- Open the command palette and execute `Open Devtools`
+- Go to the `Console` tab
+- Start executing against the `Oni` object
+
+![example](./../images/devtools-example.png)
+
+This is great for quick debugging or exploring the API surface area.
+
+### User Configuration
+
+An `Oni` API object is passed to the `activate` method of your config. An example `config.js` using the API object is:
 
 ```
 const activate = (oni) => {
@@ -16,6 +31,6 @@ module.exports = {
 }
 ```
 
-Likewise, for a plugin, the entry point is an `activate` method with a [Plugin API](interfaces/plugin.api.html) object passed in.
-
+### Plugins
 
+Like the user configuration, for plugins, the entry point is an `activate` method with an Oni object passed in.

src/index.ts

@@ -303,6 +303,41 @@ export interface Log {
     enableVerboseLogging(): void
 }
 
+/**
+ * The `recorder` API enables the taking of screenshot or recording a video.
+ *
+ * The output defaults to the `os.tmpdir()` directory, but can be overridden
+ * by the `recorder.outputPath` option.
+ */
+export interface Recorder {
+
+   /**
+    * Returns `true` if a recording is in progress, `false` otherwise
+    */
+   isRecording: boolean 
+
+   /**
+    * Start recording a video.
+    *
+    * Videos are recorded in `.webm` format.
+    */
+    startRecording(): void
+
+    /**
+     * Stop recording a video. 
+     *
+     * Optionally specify the destination `fileName`.
+     */
+    stopRecording(fileName?: string): Promise<void>
+
+    /**
+     * Take a screenshot.
+     *
+     * Optionally specify the destination `fileName.
+     */
+    takeScreenshot(fileName?: string): void
+}
+
 export interface StatusBar {
     getItem(globalId?: string): StatusBarItem
     createItem(alignment: number, globalId?: string): StatusBarItem
@@ -468,6 +503,7 @@ export namespace Plugin {
         plugins: IPluginManager
         menu: Menu.Api
         process: Process
+        recorder: Recorder
         statusBar: StatusBar
         windows: IWindowManager
         workspace: Workspace