cp.adobe.aftereffects

Adobe After Effects Extension

---

Submodules

• cp.adobe.aftereffects.app
• cp.adobe.aftereffects.shortcuts

---

API Overview

Constants - Useful values which cannot be changed

• preferences

Functions - API calls offered directly by the extension

• allowScriptsToWriteFilesAndAccessNetwork
• preferencesFilePath
• preferencesPath
• refreshPreferences
• shortcutsPreferences
• shortcutsPreferencesPath

---

API Documentation

Constants

preferences

Signature	cp.adobe.aftereffects.preferences <cp.app.prefs>
Type	Constant
Description	The cp.app.prefs for After Effects.
Notes	None
Source	src/extensions/cp/adobe/aftereffects/init.lua line 35

---

Functions

allowScriptsToWriteFilesAndAccessNetwork

Signature	cp.adobe.aftereffects:allowScriptsToWriteFilesAndAccessNetwork() -> boolean
Type	Function
Description	Is "Allow Scripts to Write Files and Access Network" enabled in After Effects Preferences?
Parameters	None
Returns	A boolean
Notes	None
Examples	None
Source	src/extensions/cp/adobe/aftereffects/init.lua line 82

---

preferencesFilePath

Signature	cp.adobe.aftereffects:preferencesFilePath() -> string
Type	Function
Description	The path to the main Preferences file.
Parameters	None
Returns	A string
Notes	None
Examples	None
Source	src/extensions/cp/adobe/aftereffects/init.lua line 62

---

preferencesPath

Signature	cp.adobe.aftereffects:preferencesPath() -> string | nil
Type	Function
Description	The path to After Effects Preferences folder.
Parameters	None
Returns	A string or nil if no path can be found.
Notes	None
Examples	None
Source	src/extensions/cp/adobe/aftereffects/init.lua line 43

---

refreshPreferences

Signature	cp.adobe.aftereffects:refreshPreferences() -> none
Type	Function
Description	If After Effects is running, this forces the preferences file to be saved to disk.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/extensions/cp/adobe/aftereffects/init.lua line 97

---

shortcutsPreferences

Signature	cp.adobe.aftereffects:shortcutsPreferences() -> table
Type	Function
Description	Gets a table of all the active After Effects keyboard shortcuts.
Parameters	None
Returns	A table
Notes	None
Examples	None
Source	src/extensions/cp/adobe/aftereffects/init.lua line 201

---

shortcutsPreferencesPath

Signature	cp.adobe.aftereffects:shortcutsPreferencesPath() -> string
Type	Function
Description	Gets the active shortcut key preferences file path.
Parameters	None
Returns	A string
Notes	None
Examples	None
Source	src/extensions/cp/adobe/aftereffects/init.lua line 116

---

---