An open-source screen recorder built with web technology
```
| Save to Disk |
| Upload to Dropbox |
| Share on GIPHY |
```
In the above case, the second and third item are added by two different share services.
The share service is a plain object defining some metadata:
- `title`: The title used in the export menu. For example: `Share to GIPHY`.
#### `keyboardShortcut`
[List of possible values](https://www.electronjs.org/docs/api/accelerator)
```js
const config = {
keyboardShortcut: {
title: 'Toggle Unicorn Mode',
customType: 'keyboardShortcut',
required: true,
default: 'Command+Shift+5'
}
};
// Later
electron.globalShortcut.register(config.get('shortcut'), () => { /* ... */ });
```
**Note:** Kap will not register any action for the keyboard shortcut. That is up to the plugin implementation.
## General APIs
Every type of plugin and service can additionally export the following:
- `didInstall(config)`: A hook that will be called when the plugin is first installed.
- `didConfigChange(newValues, oldValues, config)`: A hook that will be called whenever the config of the plugin is changed.
- `willUninstall(config)`: A hook that will be called when a plugin is being uninstalled. It can be used to clean up artifacts.
In addition to these, each plugin needs to export at least one of the following:
- `shareServices`: an array of share services and described above
- `editServices`: an array of edit services and described above
- `recordServices`: an array of record services and described above
## OAuth
Sometimes services require an [OAuth](https://oauth.net/2/) flow to retrieve a token. These flows are often required to be completed in the browser and not in a webview. For this reason, Kap provides deep linking support. Follow these steps to support OAuth in your plugin:
- When the export starts, check if the `accessToken` is available (if you have already authenticated) in the plugin config. This should not be listed in the JSON Schema options mentioned above unless the user is meant to edit them.
- If it's not available, [open an external link](https://www.electronjs.org/docs/api/shell#shellopenexternalurl-options) to the OAuth provider's page with the correct parameters. Usually client ID.
- When registering the app, provide something like `kap://plugins/{pluginName}/auth` as the callback URL.
- Call `context.waitForDeepLink()` and wait for the user to go through the process.
- When the above call resolves, you'll have the remaining path, along with any extra info the API added. In the above example, it would be something like `auth?code=###`.
- You can now exchange the code for a token, and then store that in the config, so you can use it for future exports.
For an example of this flow in action, check out [kap-dropbox](https://github.com/karaggeorge/kap-dropbox).
If the API provider only allows HTTP/HTTPS URLs, or if you don't want to do the code exchange in the plugin (to avoid having the secret in the code), you might need to create a proxy, similar to the [one used for kap-dropbox](https://github.com/karaggeorge/kap-dropbox/tree/main/oauth-proxy), to trigger the deep link.
## Removing your Kap plugin
Since npm doesn't allow you to remove packages from the registry, Kap filters out deprecated packages in the plugin list.
When you are ready to retire your Kap plugin, simply run `npm deprecate kap-plugin "Deprecated"`.
[Read more about the `npm-deprecate` command](https://docs.npmjs.com/cli/deprecate)
================================================
FILE: main/aperture.ts
================================================
import {windowManager} from './windows/manager';
import {setRecordingTray, setPausedTray, disableTray, resetTray} from './tray';
import {setCropperShortcutAction} from './global-accelerators';
import {settings} from './common/settings';
import {track} from './common/analytics';
import {plugins} from './plugins';
import {getAudioDevices, getSelectedInputDeviceId} from './utils/devices';
import {showError} from './utils/errors';
import {RecordServiceContext, RecordServiceState} from './plugins/service-context';
import {setCurrentRecording, updatePluginState, stopCurrentRecording} from './recording-history';
import {Recording} from './video';
import {ApertureOptions, StartRecordingOptions} from './common/types';
import {InstalledPlugin} from './plugins/plugin';
import {RecordService, RecordServiceHook} from './plugins/service';
import {getCurrentDurationStart, getOverallDuration, setCurrentDurationStart, setOverallDuration} from './utils/track-duration';
const createAperture = require('aperture');
const aperture = createAperture();
let recordingPlugins: Array<{plugin: InstalledPlugin; service: RecordService}> = [];
const serviceState = new Map