Snippets

Snippets
​
CommandPost allows you to create Lua code snippets, which appear as actions in CommandPost's Search Console.
This means you can trigger a Snippet via a shortcut key or control surface button.
For example, to launch Final Cut Pro, you can use this simple Lua code:
cp.apple.finalcutpro:launch()
CommandPost is also compatible with Hammerspoon, so you can also use any of the examples on the Hammerspoon website:
​http://www.hammerspoon.org/go/​
You can learn more about Lua here:
​https://dev.commandpost.io/lua/lua-overview​
Here's a link to Hammerspoon's API reference:
​http://www.hammerspoon.org/docs/index.html​
Here's some direct links to some useful Hammerspoon functions:
​hs.timer.usleep(microsecs) - Add a delay
​hs.eventtap.keyStroke(modifiers, character[, delay, application]) - Trigger a virtual key stroke
​hs.application:selectMenuItem(menuitem[, isRegex]) - Trigger an application menu item
Here's some direct links to some useful CommandPost functions:
​cp.tools​
​
Examples
Press "CMD+C"
hs.eventtap.keyStroke({"cmd"}, "c")
​
Type "test"
hs.eventtap.keyStrokes("test")
​
Trigger Shortcuts with Delay's in-between
-- Type "t"
hs.eventtap.keyStroke({}, "t")
​
-- Wait 1 second
cp.just.wait(1)
​
-- Type "e"
hs.eventtap.keyStroke({}, "e")
​
Forcefully restart an application by its bundle identifier
local bundleID = "com.logitech.manager.daemon"
local apps = hs.application.applicationsForBundleID(bundleID)
if apps and apps[1] then
    apps[1]:kill9()
end
hs.application.launchOrFocusByBundleID(bundleID)
​
Select all even clips in a timeline
cp.apple.finalcutpro:launch()
local clips = cp.apple.finalcutpro:timeline():contents():clipsUI()
table.sort(clips, function(a, b) return a.AXPosition.x < b.AXPosition.x end)
local evenClips = {}
for i, clip in ipairs(clips) do
    if (i % 2 == 0) then
        table.insert(evenClips, clip)
    end
end
cp.apple.finalcutpro:timeline():contents():selectClips(evenClips)
​
Go back 500 frames and play
hs.eventtap.keyStroke({}, "-", 0)
hs.eventtap.keyStroke({}, "2", 0)
hs.eventtap.keyStroke({}, "0", 0)
hs.eventtap.keyStroke({}, "0", 0)
hs.eventtap.keyStroke({}, "0", 0)
hs.eventtap.keyStroke({}, "return")
cp.apple.finalcutpro:doShortcut("JogForward"):Now()
​
Audio Cross Dissolve Backward (J-Cut)
hs.eventtap.keyStroke({"shift"}, "]", 0)
hs.eventtap.keyStroke({}, "-", 0)
hs.eventtap.keyStroke({}, "1", 0)
hs.eventtap.keyStroke({}, "0", 0)
hs.eventtap.keyStroke({}, "return", 0)
hs.eventtap.keyStroke({"cmd"}, "up", 0)
​
-- Need To Assign Toggle Fade Out in FCPX
hs.eventtap.keyStroke({"cmd", "alt"}, "f", 0)
hs.eventtap.keyStroke({"cmd"}, "down", 0)
​
 -- Need To Assign Toggle Fade In in FCPX
hs.eventtap.keyStroke({"cmd", "shift"}, "f", 0)
hs.eventtap.keyStroke({"ctrl"}, "s", 0)
​
Audio Cross Dissolve Centre
hs.eventtap.keyStroke({"shift"}, "]", 0)
hs.eventtap.keyStroke({}, "-", 0)
hs.eventtap.keyStroke({}, "1", 0)
hs.eventtap.keyStroke({}, "0", 0)
hs.eventtap.keyStroke({}, "return", 0)
hs.eventtap.keyStroke({"cmd"}, "up", 0)
hs.eventtap.keyStroke({"cmd"}, "down", 0)
​
-- Need To Assign Toggle Fade In in FCPX
hs.eventtap.keyStroke({"cmd", "shift"}, "f", 0)
hs.eventtap.keyStroke({"ctrl"}, "s", 0)
hs.eventtap.keyStroke({}, "down", 0)
hs.eventtap.keyStroke({"shift"}, "[", 0)
hs.eventtap.keyStroke({"shift"}, "=", 0)
hs.eventtap.keyStroke({}, "1", 0)
hs.eventtap.keyStroke({}, "0", 0)
hs.eventtap.keyStroke({}, "return", 0)
hs.eventtap.keyStroke({"cmd"}, "up", 0)
hs.eventtap.keyStroke({"cmd"}, "down", 0)
​
-- Need To Assign Toggle Fade Out in FCPX
hs.eventtap.keyStroke({"cmd", "alt"}, "f")
hs.eventtap.keyStroke({"ctrl"}, "s")
​
Audio Cross Dissolve Forward (L-Cut)
hs.eventtap.keyStroke({"shift"}, "[", 0)
hs.eventtap.keyStroke({"shift"}, "=", 0)
hs.eventtap.keyStroke({}, "1", 0)
hs.eventtap.keyStroke({}, "0", 0)
hs.eventtap.keyStroke({}, "return", 0)
hs.eventtap.keyStroke({"cmd"}, "up", 0)
​
-- Need To Assign Toggle Fade In in FCPX
hs.eventtap.keyStroke({"cmd", "shift"}, "f", 0)
hs.eventtap.keyStroke({"cmd"}, "down", 0)
​
 -- Need To Assign Toggle Fade Out in FCPX
hs.eventtap.keyStroke({"cmd", "alt"}, "f", 0)
hs.eventtap.keyStroke({"ctrl"}, "s", 0)

Workflow Extension - Previous

Explanation

Next - Advanced

Snippets for Icons

Last modified 2mo ago

Export as PDF

Copy link

Outline

Trigger Shortcuts with Delay's in-between

Forcefully restart an application by its bundle identifier

Select all even clips in a timeline

Go back 500 frames and play

Audio Cross Dissolve Backward (J-Cut)

Audio Cross Dissolve Centre

Audio Cross Dissolve Forward (L-Cut)