SUMMARY.md

Summary

Getting Started

• Introduction
• Installation & Setup

Lua

• Lua Overview

Contributing

• Naming Conventions
• CommandPost-App
• CommandPost

Control CommandPost

• AppleScript
• Command Line Tool
• URL Handler

Plugins

• Plugins Overview

Internationalisation

• Translating CommandPost

Final Cut Pro

• FCPXML
• iXML
• Package Contents

Bundled Extensions

• axuielement
• gambiarra
• i18n
• mimetypes
• moses
• resty
• semver
• slaxml
• touchbar

CommandPost API

• cp
  • apple
    • compressor
    • finalcutpro
      • cmd
        • CommandEditor
      • content
        • Clip
      • destinations
      • export
        • destinations
        • ExportDialog
        • GoToPrompt
        • ReplaceAlert
        • SaveSheet
      • import
        • MediaImport
      • keycodes
      • main
        • Browser
        • ColorBoard
        • ColorPucker
        • EffectsBrowser
        • FullScreenWindow
        • GeneratorsBrowser
        • Inspector
          • AudioInspector
          • ColorInspector
            • ColorBoard
            • ColorCurves
            • ColorWheels
            • HueSaturationCurves
          • EffectInspector
          • GeneratorInspector
          • InfoInspector
          • ShareInspector
          • TextInspector
          • TitleInspector
          • TransitionInspector
          • VideoInspector
        • LibrariesBrowser
        • LibrariesFilmstrip
        • LibrariesList
        • MediaBrowser
        • Playhead
        • PrimaryWindow
        • SecondaryWindow
        • Timeline
        • TimelineAppearance
        • TimelineContents
        • TimelineToolbar
        • Viewer
      • MenuBar
      • plugins
      • prefs
        • ImportPanel
        • PlaybackPanel
        • PreferencesWindow
      • WindowWatcher
  • bench
  • choices
    • builder
  • commands
    • command
    • englishKeyCodes
    • shortcut
      • builder
  • config
    • accessibilityStateCallback
    • dockIconClickCallback
    • fileDroppedToDockIconCallback
    • shutdownCallback
    • textDroppedToDockIconCallback
  • developer
  • dialog
  • feedback
  • ids
  • idle
  • just
  • localized
  • plist
    • archiver
  • plugins
    • env
  • prop
  • sourcewatcher
  • strings
    • source
      • plist
      • table
  • text
    • matcher
  • tools
  • ui
    • Alert
    • axutils
    • Button
    • CheckBox
    • PopUpButton
    • RadioButton
    • ScrollArea
    • Slider
    • Table
    • TextField
    • Window
  • utf16
    • be
    • le
  • watcher
  • web
    • generate
    • html
    • text
    • ui

Bundled Plugins API

• plugins
  • core
    • accessibility
    • action
      • activator
      • handler
      • manager
    • commands
      • actions
      • commandaction
      • global
    • console
    • helpandsupport
      • credits
      • feedback
      • userguide
    • language
    • menu
      • bottom
      • helpandsupport
        • commandpost
      • manager
        • section
      • top
    • midi
      • manager
        • controls
    • preferences
      • advanced
      • general
      • manager
      • panels
        • advanced
        • general
        • menubar
        • midi
        • notifications
        • plugins
        • shortcuts
        • streamdeck
        • tangent
        • touchbar
        • webapp
      • updates
    • quit
    • setup
      • panel
    • streamdeck
      • manager
    • touchbar
      • manager
        • virtual
          • updateLocationCallback
        • widgets
        • widgets
          • volume
          • windowSlide
    • watchfolders
      • manager
        • panel
    • webapp
  • compressor
    • watchfolders
      • panels
        • media
  • finalcutpro
    • commands
      • actions
    • browser
      • addnote
      • keywords
      • playhead
    • clipboard
      • history
      • manager
      • shared
    • commands
    • console
    • export
      • batch
    • feedback
      • bugreport
    • fullscreen
      • shortcuts
    • hacks
      • backupinterval
      • movingmarkers
      • playbackrendering
      • shortcuts
      • smartcollectionslabel
    • hud
    • import
      • ignorecard
      • preferences
    • language
    • menu
      • administrator
        • advancedfeatures
      • clipboard
      • helpandsupport
        • finalcutpro
      • mediaimport
      • menuaction
      • proxyicon
      • timeline
        • assignshortcuts
      • tools
        • notifications
      • top
      • viewer
        • showtimecode
    • midi
      • controls
        • colorboard
        • zoom
      • manager
    • notifications
      • imessage
      • manager
      • prowl
      • pushover
    • open
    • os
      • voice
    • preferences
      • panels
        • finalcutpro
      • scanfinalcutpro
    • sharing
      • xml
    • streamdeck
    • tangent manager
    • text2speech
    • timeline
      • audioeffects
      • colorboard
      • commandsetactions
      • disablewaveforms
      • effects
      • generators
      • height
      • lanes
      • matchframe
      • mousezoom
      • movetoplayhead
      • multicam
      • playback
      • playhead
      • pluginactions
      • pluginshortcuts
      • pluginshortcuts
      • preferences
      • selectalltimelineclips
      • stabilization
      • titles
      • transitions
      • videoeffects
      • zoomtoselection
    • touchbar
      • virtual
      • widgets
        • colorboard
        • zoom
    • viewer
      • showtimecode
      • showtimelineinplayer
      • timecodeoverlay
    • watchfolders
      • panels
        • fcpxml
        • media
    • watchers
      • preferences
      • version

Hammerspoon API

• hs
  • alert
  • appfinder
  • applescript
  • application
    • watcher
  • audiodevice
    • datasource
    • watcher
  • base64
  • battery
    • watcher
  • brightness
  • caffeinate
    • watcher
  • canvas
    • drawing
    • matrix
  • chooser
  • console
  • crash
  • deezer
  • dialog
  • distributednotifications
  • doc
    • builder
    • hsdocs
    • markdown
    • spoonsupport
  • dockicon
  • drawing
    • color
  • eventtap
    • event
  • expose
  • fnutils
  • fs
    • volume
  • geometry
  • grid
  • hash
  • hints
  • host
    • locale
  • hotkey
    • modal
  • http
  • httpserver
    • hsminweb.cgilua.lp
    • hsminweb.cgilua
    • hsminweb.cgilua.urlcode
    • hsminweb
  • image
  • inspect
  • ipc
  • itunes
  • javascript
  • json
  • keycodes
  • layout
  • location
    • geocoder
  • logger
  • menubar
  • messages
  • midi
  • milight
  • mjomatic
  • mouse
  • network
    • configuration
    • host
    • ping
      • echoRequest
    • reachability
  • noises
  • notify
  • osascript
  • pasteboard
  • pathwatcher
  • plist
  • redshift
  • screen
    • watcher
  • settings
  • sharing
  • socket
    • udp
  • sound
  • spaces.watcher
  • speech
    • listener
  • spoons
  • spotify
  • spotlight
    • group
    • item
  • sqlite3
  • streamdeck
  • styledtext
  • tabs
  • task
  • timer
    • delayed
  • uielement
    • watcher
  • urlevent
  • usb
    • watcher
  • utf8
  • vox
  • watchable
  • webview
    • datastore
    • toolbar
    • usercontent
  • wifi
    • watcher
  • window
    • filter
    • highlight
    • layout
    • switcher
    • tiling