plugins.finalcutpro.sharing.xml.md

docs » plugins.finalcutpro.sharing.xml

---

Shared XML Plugin.

API Overview

• Functions - API calls offered directly by the extension
• clearSharedFiles
• init
• listFilesMenu
• shareXML
• update

API Documentation

Functions

clearSharedFiles

Signature	plugins.finalcutpro.sharing.xml.clearSharedFiles() -> none
Type	Function
Description	Clear shared files list.
Parameters	None
Returns	None

init

Signature	plugins.finalcutpro.sharing.xml.init() -> none
Type	Function
Description	Initialises the module.
Parameters	None
Returns	None

listFilesMenu

Signature	plugins.finalcutpro.sharing.xml.listFilesMenu() -> none
Type	Function
Description	List files menu.
Parameters	None
Returns	None

shareXML

Signature	plugins.finalcutpro.sharing.xml.shareXML() -> none
Type	Function
Description	Share XML
Parameters	incomingXML - XML data as string noErrors - Prevents error messages from being displayed.
Returns	None

update

Signature	plugins.finalcutpro.sharing.xml.update() -> none
Type	Function
Description	Starts or stops the watchers.
Parameters	None
Returns	None