Skip to content

Latest commit

 

History

History
122 lines (120 loc) · 15.3 KB

index.md

File metadata and controls

122 lines (120 loc) · 15.3 KB

Hammerspoon


Project Links

Resource Link
Website http://www.hammerspoon.org/
GitHub page https://github.com/Hammerspoon/hammerspoon
Getting Started Guide http://www.hammerspoon.org/go/
Spoon Plugin Documentation https://github.com/Hammerspoon/hammerspoon/blob/master/SPOONS.md
Official Spoon repository http://www.hammerspoon.org/Spoons
IRC channel irc://chat.freenode.net/#hammerspoon
Mailing list https://groups.google.com/forum/#!forum/hammerspoon/
LuaSkin API docs http://www.hammerspoon.org/docs/LuaSkin/

API Documentation

Module Description
cp Core CommandPost functionality
cp.apple.compressor Represents the Compressor application, providing functions that allow different tasks to be accomplished.
cp.apple.finalcutpro Represents the Final Cut Pro application, providing functions that allow different tasks to be accomplished.
cp.apple.finalcutpro.cmd.CommandEditor Command Editor Module.
cp.apple.finalcutpro.content.Clip Represents a clip of media inside FCP.
cp.apple.finalcutpro.export.destinations Provides access to the list of Share Destinations configured for the user.
cp.apple.finalcutpro.export.ExportDialog Export Dialog Module.
cp.apple.finalcutpro.export.GoToPrompt Go To Prompt.
cp.apple.finalcutpro.export.ReplaceAlert Replace Alert
cp.apple.finalcutpro.export.SaveSheet Save Sheet
cp.apple.finalcutpro.ids Final Cut Pro IDs.
cp.apple.finalcutpro.import.MediaImport Media Import
cp.apple.finalcutpro.keycodes Keycodes Module
cp.apple.finalcutpro.main.Browser Browser Module.
cp.apple.finalcutpro.main.ColorBoard Color Board Module.
cp.apple.finalcutpro.main.ColorPucker Color Pucker Module.
cp.apple.finalcutpro.main.EffectsBrowser Effects Browser Module.
cp.apple.finalcutpro.main.FullScreenWindow Full Screen Window
cp.apple.finalcutpro.main.GeneratorsBrowser Generators Browser Module.
cp.apple.finalcutpro.main.Inspector Inspector
cp.apple.finalcutpro.main.Inspector.AudioInspector Audio Inspector Module.
cp.apple.finalcutpro.main.Inspector.ColorInspector Color Inspector Module.
cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorBoard Color Board Module.
cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorCurves Color Curves Module.
cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorWheels Color Wheels Module.
cp.apple.finalcutpro.main.Inspector.ColorInspector.HueSaturationCurves Hue/Saturation Curves Module.
cp.apple.finalcutpro.main.Inspector.EffectInspector Effect Inspector Module.
cp.apple.finalcutpro.main.Inspector.GeneratorInspector Generator Inspector Module.
cp.apple.finalcutpro.main.Inspector.InfoInspector Video Inspector Module.
cp.apple.finalcutpro.main.Inspector.ShareInspector Share Inspector Module.
cp.apple.finalcutpro.main.Inspector.TextInspector Text Inspector Module.
cp.apple.finalcutpro.main.Inspector.TitleInspector Title Inspector Module.
cp.apple.finalcutpro.main.Inspector.TransitionInspector Transition Inspector Module.
cp.apple.finalcutpro.main.Inspector.VideoInspector Video Inspector Module.
cp.apple.finalcutpro.main.LibrariesBrowser Libraries Browser Module.
cp.apple.finalcutpro.main.LibrariesFilmstrip Libraries Filmstrip Module.
cp.apple.finalcutpro.main.LibrariesList Libraries List Module.
cp.apple.finalcutpro.main.MediaBrowser Media Browser Module.
cp.apple.finalcutpro.main.Playhead Playhead Module.
cp.apple.finalcutpro.main.PrimaryWindow Primary Window Module.
cp.apple.finalcutpro.main.SecondaryWindow Secondary Window Module.
cp.apple.finalcutpro.main.Timeline Timeline Module.
cp.apple.finalcutpro.main.TimelineAppearance Timeline Appearance Module.
cp.apple.finalcutpro.main.TimelineContents Timeline Contents Module.
cp.apple.finalcutpro.main.TimelineToolbar Timeline Toolbar
cp.apple.finalcutpro.main.Viewer Viewer Module.
cp.apple.finalcutpro.MenuBar Represents the Final Cut Pro menu bar, providing functions that allow different tasks to be accomplished.
cp.apple.finalcutpro.plugins Scan Final Cut Pro bundle for Effects, Generators, Titles & Transitions.
cp.apple.finalcutpro.prefs.ImportPanel Import Panel Module.
cp.apple.finalcutpro.prefs.PlaybackPanel Playback Panel Module.
cp.apple.finalcutpro.prefs.PreferencesWindow Preferences Window Module.
cp.apple.finalcutpro.windowfilter Window Filter for Final Cut Pro.
cp.apple.finalcutpro.WindowWatcher Window Watcher Module.
cp.bench Benchmarking Tool.
cp.choices Choices Module.
cp.choices.builder Choices Builder Module.
cp.commands Commands Module.
cp.commands.command Commands Module.
cp.commands.englishKeyCodes Returns a table of all the English Key Codes.
cp.commands.shortcut Shortcut Commands
cp.commands.shortcut.builder Shortcut Commands Builder Module.
cp.config Manage CommandPost's constants and settings.
cp.config.dockIconClickCallback Callback which triggers when the CommandPost Dock Icon is clicked
cp.config.fileDroppedToDockIconCallback File Dropped to Dock Icon Callback
cp.config.shutdownCallback Shutdown Callback Module.
cp.config.textDroppedToDockIconCallback Text Dropped to Dock Icon Callback
cp.developer Developer Tools
cp.dialog A collection of handy Dialog tools for CommandPost.
cp.feedback Feedback Form.
cp.idle This library allows tasks to be queue for execution when the computer has
cp.ids Allows managing values/IDs which can vary between versions.
cp.just This module provides functions to help with performing tasks which may be
cp.localized Helps look up localized names for folders.
cp.plist Reads & Writes plist data.
cp.plist.archiver Supports 'defrosting' a table which is made up from an 'NSKeyArchiver' record.
cp.plugins This is a simple plugin manager.
cp.plugins.env Provides access to resources in the plugin environment. In generally, this will be files stored in a Complex Plugin's folder.
cp.prop This is a utility library for helping keep track of single-value property states. Each property provides access to a single value. Must be readable, but may be read-only. It works by creating a table which has a get and (optionally) a set function which are called when changing the state.
cp.sourcewatcher Watches folders for specific file extensions and reloads the app if they change.
cp.strings Provides strings from (potentially) multiple sources, with support for loading from multiple languages.
cp.strings.source.plist Loads strings from a plist with allowing for a given language variation. Eg:
cp.strings.source.table Loads strings from provided tables, allowing for a given language variation. Eg:
cp.text This module provides support for loading, manipulating, and comparing unicode text data.
cp.text.matcher This module provides support for loading, manipulating, and comparing unicode text data.
cp.tools A collection of handy miscellaneous tools for Lua development.
cp.ui.Alert Alert UI Module.
cp.ui.axutils Utility functions to support hs._asm.axuielement
cp.ui.Button Button Module.
cp.ui.CheckBox Check Box UI Module.
cp.ui.PopUpButton Pop Up Button Module.
cp.ui.RadioButton Radio Button Module.
cp.ui.ScrollArea Scroll Area Module.
cp.ui.Slider Slider Module.
cp.ui.Table Represents an AXTable in the Apple Accessibility UX API.
cp.ui.TextField Text Field Module.
cp.ui.Window A Window UI element.
cp.utf16 A pure-LUA implementation of UTF-16 decoding
cp.utf16.be A pure-LUA implementation of UTF-16 decoding with big-endian ordering.
cp.utf16.le A pure-LUA implementation of UTF-16 decoding with little-endian ordering.
cp.watcher This extension provides support for setting up 'event watchers'.
cp.web.generate Functions for Generating HTML UI Items
cp.web.html Functions for Generating HTML markup.
cp.web.text Functions for managing text on the web.
cp.web.ui This extension contains functions which simplify the creation of standard UI events