Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
Updated Developer Docs
  • Loading branch information
latenitefilms committed Apr 9, 2021
1 parent b3aa060 commit dfdc890
Show file tree
Hide file tree
Showing 109 changed files with 1,787 additions and 537 deletions.
41 changes: 26 additions & 15 deletions SUMMARY.md
Expand Up @@ -43,6 +43,9 @@

* [cp](api/cp/cp.md)
* [18n](api/cp/cp.18n.md)
* [aftereffects](api/cp/cp.adobe.aftereffects.md)
* [app](api/cp/cp.adobe.aftereffects.app.md)
* [shortcuts](api/cp/cp.adobe.aftereffects.shortcuts.md)
* [app](api/cp/cp.app.md)
* [menu](api/cp/cp.app.menu.md)
* [prefs](api/cp/cp.app.prefs.md)
Expand Down Expand Up @@ -334,7 +337,11 @@
## Bundled Plugins API

* [plugins](api/plugins/index.md)
* [tangent](api/plugins/plugins.colorfinale.tangent.md)
* [manager](api/plugins/plugins.aftereffects.application.manager.md)
* [effects](api/plugins/plugins.aftereffects.effects.md)
* [preferences](api/plugins/plugins.aftereffects.preferences.md)
* [shortcuts](api/plugins/plugins.aftereffects.shortcuts.md)
* [manager](api/plugins/plugins.aftereffects.tangent.manager.md)
* [manager](api/plugins/plugins.compressor.application.manager.md)
* [bugreport](api/plugins/plugins.compressor.feedback.bugreport.md)
* [media](api/plugins/plugins.compressor.watchfolders.panels.media.md)
Expand Down Expand Up @@ -365,9 +372,8 @@
* [userguide](api/plugins/plugins.core.helpandsupport.userguide.md)
* [language](api/plugins/plugins.core.language.md)
* [prefs](api/plugins/plugins.core.loupedeck.prefs.md)
* [changeapplications](api/plugins/plugins.core.loupedeckct.changeapplications.md)
* [manager](api/plugins/plugins.core.loupedeckct.manager.md)
* [prefs](api/plugins/plugins.core.loupedeckct.prefs.md)
* [manager](api/plugins/plugins.core.loupedeckctandlive.manager.md)
* [prefs](api/plugins/plugins.core.loupedeckctandlive.prefs.md)
* [prefs](api/plugins/plugins.core.loupedeckplus.prefs.md)
* [manager](api/plugins/plugins.core.menu.manager.md)
* [section](api/plugins/plugins.core.menu.manager.section.md)
Expand All @@ -393,23 +399,16 @@
* [prefs](api/plugins/plugins.core.shortcuts.prefs.md)
* [manager](api/plugins/plugins.core.streamdeck.manager.md)
* [prefs](api/plugins/plugins.core.streamdeck.prefs.md)
* [commandpost](api/plugins/plugins.core.tangent.commandpost.md)
* [favourites](api/plugins/plugins.core.tangent.commandpost.favourites.md)
* [functions](api/plugins/plugins.core.tangent.commandpost.functions.md)
* [manager](api/plugins/plugins.core.tangent.manager.md)
* [action](api/plugins/plugins.core.tangent.manager.action.md)
* [binding](api/plugins/plugins.core.tangent.manager.binding.md)
* [connection](api/plugins/plugins.core.tangent.manager.connection.md)
* [controls](api/plugins/plugins.core.tangent.manager.controls.md)
* [group](api/plugins/plugins.core.tangent.manager.group.md)
* [menu](api/plugins/plugins.core.tangent.manager.menu.md)
* [mode](api/plugins/plugins.core.tangent.manager.mode.md)
* [named](api/plugins/plugins.core.tangent.manager.named.md)
* [parameter](api/plugins/plugins.core.tangent.manager.parameter.md)
* [os](api/plugins/plugins.core.tangent.os.md)
* [display](api/plugins/plugins.core.tangent.os.display.md)
* [pasteboard](api/plugins/plugins.core.tangent.os.pasteboard.md)
* [sound](api/plugins/plugins.core.tangent.os.sound.md)
* [window](api/plugins/plugins.core.tangent.os.window.md)
* [prefs](api/plugins/plugins.core.tangent.prefs.md)
* [manager](api/plugins/plugins.core.toolbox.manager.md)
* [caffeinate](api/plugins/plugins.core.tools.caffeinate.md)
Expand All @@ -429,6 +428,7 @@
* [panel](api/plugins/plugins.core.watchfolders.manager.panel.md)
* [menuitem](api/plugins/plugins.core.watchfolders.menuitem.md)
* [manager](api/plugins/plugins.diskutility.application.manager.md)
* [manager](api/plugins/plugins.ecammlive.application.manager.md)
* [custom](api/plugins/plugins.finalcutpro.actions.custom.md)
* [backupinterval](api/plugins/plugins.finalcutpro.advanced.backupinterval.md)
* [disablewaveforms](api/plugins/plugins.finalcutpro.advanced.disablewaveforms.md)
Expand Down Expand Up @@ -510,15 +510,21 @@
* [audio](api/plugins/plugins.finalcutpro.tangent.audio.md)
* [browser](api/plugins/plugins.finalcutpro.tangent.browser.md)
* [clip](api/plugins/plugins.finalcutpro.tangent.clip.md)
* [commandpost](api/plugins/plugins.finalcutpro.tangent.commandpost.md)
* [color](api/plugins/plugins.finalcutpro.tangent.color.md)
* [functions](api/plugins/plugins.finalcutpro.tangent.commandpost.functions.md)
* [common](api/plugins/plugins.finalcutpro.tangent.common.md)
* [edit](api/plugins/plugins.finalcutpro.tangent.edit.md)
* [features](api/plugins/plugins.finalcutpro.tangent.features.md)
* [generator](api/plugins/plugins.finalcutpro.tangent.generator.md)
* [info](api/plugins/plugins.finalcutpro.tangent.info.md)
* [manager](api/plugins/plugins.finalcutpro.tangent.manager.md)
* [modes](api/plugins/plugins.finalcutpro.tangent.modes.md)
* [new](api/plugins/plugins.finalcutpro.tangent.new.md)
* [open](api/plugins/plugins.finalcutpro.tangent.open.md)
* [os](api/plugins/plugins.finalcutpro.tangent.os.md)
* [display](api/plugins/plugins.finalcutpro.tangent.os.display.md)
* [pasteboard](api/plugins/plugins.finalcutpro.tangent.os.pasteboard.md)
* [sound](api/plugins/plugins.finalcutpro.tangent.os.sound.md)
* [window](api/plugins/plugins.finalcutpro.tangent.os.window.md)
* [overlay](api/plugins/plugins.finalcutpro.tangent.overlay.md)
* [pasteboard](api/plugins/plugins.finalcutpro.tangent.pasteboard.md)
* [playback](api/plugins/plugins.finalcutpro.tangent.playback.md)
Expand Down Expand Up @@ -586,6 +592,8 @@
* [manager](api/plugins/plugins.motion.application.manager.md)
* [bugreport](api/plugins/plugins.motion.feedback.bugreport.md)
* [manager](api/plugins/plugins.resolve.application.manager.md)
* [emulation ===](api/plugins/plugins.resolve.tangent.emulation ===.md)
* [manager](api/plugins/plugins.resolve.tangent.manager.md)
* [manager](api/plugins/plugins.skype.application.manager.md)
* [shortcuts](api/plugins/plugins.skype.shortcuts.md)
* [manager](api/plugins/plugins.systempreferences.application.manager.md)
Expand All @@ -603,7 +611,9 @@
* [audiodevice](api/hs/hs.audiodevice.md)
* [datasource](api/hs/hs.audiodevice.datasource.md)
* [watcher](api/hs/hs.audiodevice.watcher.md)
* [audiounit](api/hs/hs.audiounit.md)
* [axuielement](api/hs/hs.axuielement.md)
* [axtextmarker](api/hs/hs.axuielement.axtextmarker.md)
* [observer](api/hs/hs.axuielement.observer.md)
* [base64](api/hs/hs.base64.md)
* [battery](api/hs/hs.battery.md)
* [watcher](api/hs/hs.battery.watcher.md)
Expand Down Expand Up @@ -691,6 +701,7 @@
* [socket](api/hs/hs.socket.md)
* [udp](api/hs/hs.socket.udp.md)
* [sound](api/hs/hs.sound.md)
* [spaces](api/hs/hs.spaces.md)
* [watcher](api/hs/hs.spaces.watcher.md)
* [speech](api/hs/hs.speech.md)
* [listener](api/hs/hs.speech.listener.md)
Expand Down
19 changes: 19 additions & 0 deletions api/cp/cp.adobe.aftereffects.app.md
@@ -0,0 +1,19 @@
# [docs](index.md) » cp.adobe.aftereffects.app
---

The `cp.app` for Adobe After Effects.

## API Overview
* Constants - Useful values which cannot be changed
* [app](#app)

## API Documentation

### Constants

#### [app](#app)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects.app <cp.app>` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Constant |
| **Description** | The `cp.app` for After Effects. |

80 changes: 80 additions & 0 deletions api/cp/cp.adobe.aftereffects.md
@@ -0,0 +1,80 @@
# [docs](index.md) » cp.adobe.aftereffects
---

Adobe After Effects Extension

## Submodules
* [cp.adobe.aftereffects.app](cp.adobe.aftereffects.app.md)
* [cp.adobe.aftereffects.shortcuts](cp.adobe.aftereffects.shortcuts.md)

## API Overview
* Constants - Useful values which cannot be changed
* [preferences](#preferences)
* Functions - API calls offered directly by the extension
* [allowScriptsToWriteFilesAndAccessNetwork](#allowscriptstowritefilesandaccessnetwork)
* [preferencesFilePath](#preferencesfilepath)
* [preferencesPath](#preferencespath)
* [refreshPreferences](#refreshpreferences)
* [shortcutsPreferences](#shortcutspreferences)
* [shortcutsPreferencesPath](#shortcutspreferencespath)

## API Documentation

### Constants

#### [preferences](#preferences)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects.preferences <cp.app.prefs>` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Constant |
| **Description** | The `cp.app.prefs` for After Effects. |

### Functions

#### [allowScriptsToWriteFilesAndAccessNetwork](#allowscriptstowritefilesandaccessnetwork)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:allowScriptsToWriteFilesAndAccessNetwork() -> boolean` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Function |
| **Description** | Is "Allow Scripts to Write Files and Access Network" enabled in After Effects Preferences? |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>A boolean</li></ul> |

#### [preferencesFilePath](#preferencesfilepath)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:preferencesFilePath() -> string` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Function |
| **Description** | The path to the main Preferences file. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>A string</li></ul> |

#### [preferencesPath](#preferencespath)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:preferencesPath() -> string | nil` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Function |
| **Description** | The path to After Effects Preferences folder. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>A string or <code>nil</code> if no path can be found.</li></ul> |

#### [refreshPreferences](#refreshpreferences)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:refreshPreferences() -> none` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Function |
| **Description** | If After Effects is running, this forces the preferences file to be saved to disk. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>None</li></ul> |

#### [shortcutsPreferences](#shortcutspreferences)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:shortcutsPreferences() -> table` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Function |
| **Description** | Gets a table of all the active After Effects keyboard shortcuts. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>A table</li></ul> |

#### [shortcutsPreferencesPath](#shortcutspreferencespath)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:shortcutsPreferencesPath() -> string` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Function |
| **Description** | Gets the active shortcut key preferences file path. |
| **Parameters** | <ul><li>None</li></ul> |
| **Returns** | <ul><li>A string</li></ul> |

33 changes: 33 additions & 0 deletions api/cp/cp.adobe.aftereffects.shortcuts.md
@@ -0,0 +1,33 @@
# [docs](index.md) » cp.adobe.aftereffects.shortcuts
---

Translations between After Effects shortcuts and Hammerspoon-friendly shortcuts.

## API Overview
* Constants - Useful values which cannot be changed
* [keys](#keys)
* [labels](#labels)
* [modifiers](#modifiers)

## API Documentation

### Constants

#### [keys](#keys)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects.shortcuts.keys -> table` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Constant |
| **Description** | Table containing key translations. |

#### [labels](#labels)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects.shortcuts.labels -> table` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Constant |
| **Description** | Table containing label translations. |

#### [modifiers](#modifiers)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects.shortcuts.modifiers -> table` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Constant |
| **Description** | Table containing modifier translations. |

15 changes: 12 additions & 3 deletions api/cp/cp.apple.finalcutpro.inspector.color.CorrectionsBar.md
Expand Up @@ -15,6 +15,7 @@ Requires Final Cut Pro 10.4 or later.
* Methods - API calls which can only be made on an object returned by a constructor
* [activate](#activate)
* [add](#add)
* [doActivate](#doactivate)
* [doShow](#doshow)
* [findCorrectionLabel](#findcorrectionlabel)
* [show](#show)
Expand Down Expand Up @@ -56,12 +57,12 @@ Requires Final Cut Pro 10.4 or later.
### Methods

#### [activate](#activate)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.CorrectionsBar:activate(correctionType, number) -> cp.rx.go.Statement` </span> |
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.CorrectionsBar:activate(correctionType, number) -> cp.apple.finalcutpro.inspector.color.CorrectionsBar` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Method |
| **Description** | A Statement that activates a correction type. |
| **Description** | Activates a correction type. |
| **Parameters** | <ul><li><code>correctionType</code> - The correction type as string.</li><li><code>number</code> - The number of the correction.</li></ul> |
| **Returns** | <ul><li>The <code>Statement</code>.</li></ul> |
| **Returns** | <ul><li><code>cp.apple.finalcutpro.inspector.color.CorrectionsBar</code> object.</li></ul> |

#### [add](#add)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.CorrectionsBar:add(correctionType) -> cp.apple.finalcutpro.inspector.color.CorrectionsBar` </span> |
Expand All @@ -71,6 +72,14 @@ Requires Final Cut Pro 10.4 or later.
| **Parameters** | <ul><li><code>correctionType</code> - The correction type as string.</li></ul> |
| **Returns** | <ul><li><code>cp.apple.finalcutpro.inspector.color.CorrectionsBar</code> object.</li></ul> |

#### [doActivate](#doactivate)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.CorrectionsBar:doActivate(correctionType, number) -> cp.rx.go.Statement` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Method |
| **Description** | A Statement that activates a correction type. |
| **Parameters** | <ul><li><code>correctionType</code> - The correction type as string.</li><li><code>number</code> - The number of the correction.</li></ul> |
| **Returns** | <ul><li>The <code>Statement</code>.</li></ul> |

#### [doShow](#doshow)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.CorrectionsBar:doShow() -> cp.rx.go.Statement` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
Expand Down

0 comments on commit dfdc890

Please sign in to comment.