cp.apple.commandeditor.md

docs » cp.apple.commandeditor

---

Functions to control and manage Apple's Command Editor - used in Final Cut Pro, Motion and Compressor.

API Overview

• Variables - Configurable values
• padKeys
• Functions - API calls offered directly by the extension
• characterStringToKeyCode
• keypadCharacterToKeyCode
• modifierMaskToModifiers
• modifierMatch
• shortcutsFromCommandSet
• translateModifiers

API Documentation

Variables

padKeys

Signature	cp.apple.commandeditor.padKeys -> table
Type	Variable
Description	Table of Pad Keys

Functions

characterStringToKeyCode

Signature	cp.apple.commandeditor.characterStringToKeyCode() -> string
Type	Function
Description	Translate Keyboard Character Strings from Command Set Format into Hammerspoon Format.
Parameters	input - Character String
Returns	Keycode as String or ""

keypadCharacterToKeyCode

Signature	cp.apple.commandeditor.keypadCharacterToKeyCode() -> string
Type	Function
Description	Translate Keyboard Keypad Character Strings from Command Set Format into Hammerspoon Format.
Parameters	input - Character String
Returns	string or nil

modifierMaskToModifiers

Signature	cp.apple.commandeditor.modifierMaskToModifiers() -> table
Type	Function
Description	Translate Keyboard Modifiers from Apple's Property List Format into Hammerspoon Format.
Parameters	value - Modifiers String
Returns	A table of modifier strings.

modifierMatch

Signature	cp.apple.commandeditor.modifierMatch(inputA, inputB) -> boolean
Type	Function
Description	Compares two modifier tables.
Parameters	inputA - table of modifiers inputB - table of modifiers
Returns	true if there's a match otherwise false
Notes	This function only takes into account 'ctrl', 'alt', 'cmd', 'shift'.

shortcutsFromCommandSet

Signature	cp.apple.commandeditor.shortcutsFromCommandSet(id, commandSet) -> table
Type	Function
Description	Gets a specific command from a specified Command Set and returns a table of Shortcuts.
Parameters	id - The ID of the command you want to get. commandSet - A table containing an entire Command Set.
Returns	A table of shortcuts for a specific command.

translateModifiers

Signature	cp.apple.commandeditor.translateModifiers() -> table
Type	Function
Description	Translate Keyboard Modifiers from Command Set Format into Hammerspoon Format.
Parameters	input - Modifiers String
Returns	table