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

Commit

Permalink
Updated Developer Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@latenitefilms
latenitefilms committed Aug 17, 2020
1 parent 4f336f3 commit ea42ec5
Show file tree
Hide file tree
Showing 173 changed files with 4,989 additions and 3,296 deletions.
48 changes: 38 additions & 10 deletions SUMMARY.md
View file
Expand Up @@ -107,7 +107,7 @@
* [FullScreenWindow](api/cp/cp.apple.finalcutpro.main.FullScreenWindow.md)
* [GeneratorsBrowser](api/cp/cp.apple.finalcutpro.main.GeneratorsBrowser.md)
* [KeywordEditor](api/cp/cp.apple.finalcutpro.main.KeywordEditor.md)
* [KeyboardShortcuts](api/cp/cp.apple.finalcutpro.main.KeywordEditor.KeyboardShortcuts.md)
* [KeywordField](api/cp/cp.apple.finalcutpro.main.KeywordField.md)
* [LibrariesBrowser](api/cp/cp.apple.finalcutpro.main.LibrariesBrowser.md)
* [LibrariesFilmstrip](api/cp/cp.apple.finalcutpro.main.LibrariesFilmstrip.md)
* [LibrariesList](api/cp/cp.apple.finalcutpro.main.LibrariesList.md)
Expand All @@ -121,8 +121,10 @@
* [menu](api/cp/cp.apple.finalcutpro.menu.md)
* [plugins](api/cp/cp.apple.finalcutpro.plugins.md)
* [guiscan](api/cp/cp.apple.finalcutpro.plugins.guiscan.md)
* [EditingPanel](api/cp/cp.apple.finalcutpro.prefs.EditingPanel.md)
* [GeneralPanel](api/cp/cp.apple.finalcutpro.prefs.GeneralPanel.md)
* [ImportPanel](api/cp/cp.apple.finalcutpro.prefs.ImportPanel.md)
* [Panel](api/cp/cp.apple.finalcutpro.prefs.Panel.md)
* [PlaybackPanel](api/cp/cp.apple.finalcutpro.prefs.PlaybackPanel.md)
* [PreferencesWindow](api/cp/cp.apple.finalcutpro.prefs.PreferencesWindow.md)
* [strings](api/cp/cp.apple.finalcutpro.strings.md)
Expand Down Expand Up @@ -158,6 +160,11 @@
* [app](api/cp/cp.apple.motion.app.md)
* [battery](api/cp/cp.battery.md)
* [bench](api/cp/cp.bench.md)
* [resolve](api/cp/cp.blackmagic.resolve.md)
* [app](api/cp/cp.blackmagic.resolve.app.md)
* [Color](api/cp/cp.blackmagic.resolve.color.Color.md)
* [Tracker](api/cp/cp.blackmagic.resolve.color.Tracker.md)
* [PrimaryWindow](api/cp/cp.blackmagic.resolve.main.PrimaryWindow.md)
* [choices](api/cp/cp.choices.md)
* [builder](api/cp/cp.choices.builder.md)
* [List](api/cp/cp.collect.List.md)
Expand Down Expand Up @@ -281,12 +288,15 @@
* [CheckBox](api/cp/cp.ui.CheckBox.md)
* [ColorWell](api/cp/cp.ui.ColorWell.md)
* [Column](api/cp/cp.ui.Column.md)
* [ComboBox](api/cp/cp.ui.ComboBox.md)
* [Dialog](api/cp/cp.ui.Dialog.md)
* [DisclosureTriangle](api/cp/cp.ui.DisclosureTriangle.md)
* [Element](api/cp/cp.ui.Element.md)
* [ElementCache](api/cp/cp.ui.ElementCache.md)
* [Grid](api/cp/cp.ui.Grid.md)
* [Group](api/cp/cp.ui.Group.md)
* [Image](api/cp/cp.ui.Image.md)
* [List](api/cp/cp.ui.List.md)
* [Menu](api/cp/cp.ui.Menu.md)
* [MenuButton](api/cp/cp.ui.MenuButton.md)
* [notifier](api/cp/cp.ui.notifier.md)
Expand Down Expand Up @@ -325,20 +335,25 @@

* [plugins](api/plugins/index.md)
* [tangent](api/plugins/plugins.colorfinale.tangent.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)
* [accessibility](api/plugins/plugins.core.accessibility.md)
* [screenrecording](api/plugins/plugins.core.accessibility.screenrecording.md)
* [activator](api/plugins/plugins.core.action.activator.md)
* [handler](api/plugins/plugins.core.action.handler.md)
* [manager](api/plugins/plugins.core.action.manager.md)
* [manager](api/plugins/plugins.core.application.manager.md)
* [prefs](api/plugins/plugins.core.audioswift.prefs.md)
* [actions](api/plugins/plugins.core.commands.actions.md)
* [global](api/plugins/plugins.core.commands.global.md)
* [console](api/plugins/plugins.core.console.md)
* [applications](api/plugins/plugins.core.console.applications.md)
* [scripts](api/plugins/plugins.core.console.scripts.md)
* [manager](api/plugins/plugins.core.controlsurfaces.manager.md)
* [automount](api/plugins/plugins.core.disk.automount.md)
* [favourites](api/plugins/plugins.core.disk.favourites.md)
* [display](api/plugins/plugins.core.display.md)
* [credits](api/plugins/plugins.core.helpandsupport.credits.md)
* [debugconsole](api/plugins/plugins.core.helpandsupport.debugconsole.md)
* [developerguide](api/plugins/plugins.core.helpandsupport.developerguide.md)
Expand All @@ -347,16 +362,16 @@
* [feedback](api/plugins/plugins.core.helpandsupport.feedback.md)
* [userguide](api/plugins/plugins.core.helpandsupport.userguide.md)
* [language](api/plugins/plugins.core.language.md)
* [banks](api/plugins/plugins.core.loupedeck.banks.md)
* [prefs](api/plugins/plugins.core.loupedeck.prefs.md)
* [default](api/plugins/plugins.core.loupedeck.prefs.default.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)
* [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)
* [menuaction](api/plugins/plugins.core.menu.menuaction.md)
* [banks](api/plugins/plugins.core.midi.controls.banks.md)
* [manager](api/plugins/plugins.core.midi.manager.md)
* [controls](api/plugins/plugins.core.midi.manager.controls.md)
* [default](api/plugins/plugins.core.midi.manager.default.md)
* [prefs](api/plugins/plugins.core.midi.prefs.md)
* [history](api/plugins/plugins.core.pasteboard.history.md)
* [general](api/plugins/plugins.core.preferences.general.md)
Expand All @@ -368,14 +383,11 @@
* [plugins](api/plugins/plugins.core.preferences.panels.plugins.md)
* [scripting](api/plugins/plugins.core.preferences.panels.scripting.md)
* [settings](api/plugins/plugins.core.preferences.panels.settings.md)
* [snippets](api/plugins/plugins.core.preferences.panels.snippets.md)
* [updates](api/plugins/plugins.core.preferences.updates.md)
* [preferences](api/plugins/plugins.core.scripting.preferences.md)
* [setup](api/plugins/plugins.core.setup.md)
* [panel](api/plugins/plugins.core.setup.panel.md)
* [actions](api/plugins/plugins.core.shortcuts.actions.md)
* [prefs](api/plugins/plugins.core.shortcuts.prefs.md)
* [banks](api/plugins/plugins.core.streamdeck.banks.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)
Expand All @@ -396,6 +408,7 @@
* [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)
* [banks](api/plugins/plugins.core.touchbar.banks.md)
* [location](api/plugins/plugins.core.touchbar.location.md)
Expand All @@ -405,16 +418,19 @@
* [virtual](api/plugins/plugins.core.touchbar.virtual.md)
* [volume](api/plugins/plugins.core.touchbar.widgets.volume.md)
* [windowSlide](api/plugins/plugins.core.touchbar.widgets.windowSlide.md)
* [panel](api/plugins/plugins.core.utilities.manager.panel.md)
* [manager](api/plugins/plugins.core.watchfolders.manager.md)
* [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)
* [custom](api/plugins/plugins.finalcutpro.actions.custom.md)
* [backupinterval](api/plugins/plugins.finalcutpro.advanced.backupinterval.md)
* [disablewaveforms](api/plugins/plugins.finalcutpro.advanced.disablewaveforms.md)
* [fcpxml](api/plugins/plugins.finalcutpro.advanced.fcpxml.md)
* [multicam](api/plugins/plugins.finalcutpro.advanced.multicam.md)
* [playbackrendering](api/plugins/plugins.finalcutpro.advanced.playbackrendering.md)
* [showtimelineinviewers](api/plugins/plugins.finalcutpro.advanced.showtimelineinviewers.md)
* [manager](api/plugins/plugins.finalcutpro.application.manager.md)
* [addnote](api/plugins/plugins.finalcutpro.browser.addnote.md)
* [appearanceandfiltering](api/plugins/plugins.finalcutpro.browser.appearanceandfiltering.md)
* [clearnotes](api/plugins/plugins.finalcutpro.browser.clearnotes.md)
Expand Down Expand Up @@ -471,7 +487,6 @@
* [timeline](api/plugins/plugins.finalcutpro.midi.controls.timeline.md)
* [video](api/plugins/plugins.finalcutpro.midi.controls.video.md)
* [zoom](api/plugins/plugins.finalcutpro.midi.controls.zoom.md)
* [manager](api/plugins/plugins.finalcutpro.midi.manager.md)
* [ifttt](api/plugins/plugins.finalcutpro.notifications.ifttt.md)
* [imessage](api/plugins/plugins.finalcutpro.notifications.imessage.md)
* [manager](api/plugins/plugins.finalcutpro.notifications.manager.md)
Expand All @@ -486,7 +501,6 @@
* [manager](api/plugins/plugins.finalcutpro.preferences.manager.md)
* [spelling](api/plugins/plugins.finalcutpro.preferences.spelling.md)
* [scan](api/plugins/plugins.finalcutpro.setup.scan.md)
* [streamdeck](api/plugins/plugins.finalcutpro.streamdeck.md)
* [audio](api/plugins/plugins.finalcutpro.tangent.audio.md)
* [browser](api/plugins/plugins.finalcutpro.tangent.browser.md)
* [clip](api/plugins/plugins.finalcutpro.tangent.clip.md)
Expand Down Expand Up @@ -539,7 +553,9 @@
* [transcode](api/plugins/plugins.finalcutpro.timeline.transcode.md)
* [transitions](api/plugins/plugins.finalcutpro.timeline.transitions.md)
* [videoeffects](api/plugins/plugins.finalcutpro.timeline.videoeffects.md)
* [zoom](api/plugins/plugins.finalcutpro.timeline.zoom.md)
* [zoomtoselection](api/plugins/plugins.finalcutpro.timeline.zoomtoselection.md)
* [fcpxmltitles](api/plugins/plugins.finalcutpro.toolbox.fcpxmltitles.md)
* [manager](api/plugins/plugins.finalcutpro.touchbar.manager.md)
* [virtual](api/plugins/plugins.finalcutpro.touchbar.virtual.md)
* [colorboard](api/plugins/plugins.finalcutpro.touchbar.widgets.colorboard.md)
Expand All @@ -552,13 +568,23 @@
* [media](api/plugins/plugins.finalcutpro.watchfolders.media.md)
* [MediaFolder](api/plugins/plugins.finalcutpro.watchfolders.media.MediaFolder.md)
* [panel](api/plugins/plugins.finalcutpro.watchfolders.media.panel.md)
* [manager](api/plugins/plugins.finder.application.manager.md)
* [audio](api/plugins/plugins.finder.audio.md)
* [dateandtime](api/plugins/plugins.finder.dateandtime.md)
* [pasteboard](api/plugins/plugins.finder.pasteboard.md)
* [history](api/plugins/plugins.finder.pasteboard.history.md)
* [panel](api/plugins/plugins.finder.preferences.panel.md)
* [powerchime](api/plugins/plugins.finder.preferences.powerchime.md)
* [window](api/plugins/plugins.finder.window.md)
* [manager](api/plugins/plugins.microsoftteams.application.manager.md)
* [manager](api/plugins/plugins.motion.application.manager.md)
* [bugreport](api/plugins/plugins.motion.feedback.bugreport.md)
* [manager](api/plugins/plugins.resolve.application.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)
* [manager](api/plugins/plugins.textedit.application.manager.md)
* [manager](api/plugins/plugins.zoom.application.manager.md)

## Hammerspoon API

Expand Down Expand Up @@ -647,6 +673,7 @@
* [notify](api/hs/hs.notify.md)
* [osascript](api/hs/hs.osascript.md)
* [pasteboard](api/hs/hs.pasteboard.md)
* [watcher](api/hs/hs.pasteboard.watcher.md)
* [pathwatcher](api/hs/hs.pathwatcher.md)
* [plist](api/hs/hs.plist.md)
* [redshift](api/hs/hs.redshift.md)
Expand Down Expand Up @@ -681,6 +708,7 @@
* [utf8](api/hs/hs.utf8.md)
* [vox](api/hs/hs.vox.md)
* [watchable](api/hs/hs.watchable.md)
* [websocket](api/hs/hs.websocket.md)
* [webview](api/hs/hs.webview.md)
* [datastore](api/hs/hs.webview.datastore.md)
* [toolbar](api/hs/hs.webview.toolbar.md)
Expand Down
9 changes: 9 additions & 0 deletions api/cp/cp.app.md
View file
Expand Up @@ -60,6 +60,7 @@ This extension differs from the `hs.application` extension in several ways:
* [doShow](#doshow)
* [hide](#hide)
* [isSupportedLocale](#issupportedlocale)
* [keyStroke](#keystroke)
* [launch](#launch)
* [notifier](#notifier)
* [quit](#quit)
Expand Down Expand Up @@ -351,6 +352,14 @@ This extension differs from the `hs.application` extension in several ways:
| **Parameters** | <ul><li>locale - The locale code string or <code>localeID</code> to check.</li></ul> |
| **Returns** | <ul><li><code>true</code> if it is supported, otherwise <code>false</code>.</li></ul> |

#### [keyStroke](#keystroke)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.app:keyStroke(modifiers, character) -> none` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| **Type** | Method |
| **Description** | Generates and emits a single keystroke event pair for the supplied keyboard |
| **Parameters** | <ul><li>modifiers - A table containing the keyboard modifiers to apply ("fn", "ctrl", "alt", "cmd" or "shift")</li><li>character - A string containing a character to be emitted</li></ul> |
| **Returns** | <ul><li>None</li></ul> |

#### [launch](#launch)
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.app:launch([waitSeconds], [path]) -> self` </span> |
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
Expand Down

0 comments on commit ea42ec5

Please sign in to comment.