cp.apple.finalcutpro.inspector.share.ShareInspector.md

docs » cp.apple.finalcutpro.inspector.share.ShareInspector

---

Share Inspector Module.

Section Rows (compositing, transform, etc.) have the following properties:

• enabled - (cp.ui.CheckBox) Indicates if the section is enabled.
• toggle - (cp.ui.Button) Will toggle the Hide/Show button.
• reset - (cp.ui.Button) Will reset the contents of the section.
• expanded - (cp.prop ) Get/sets whether the section is expanded.

Property Rows depend on the type of property:

Menu Property:

• value - (cp.ui.PopUpButton) The current value of the property.

Slider Property:

• value - (cp.ui.Slider) The current value of the property.

XY Property:

• x - (cp.ui.TextField) The current 'X' value.
• y - (cp.ui.TextField) The current 'Y' value.

CheckBox Property:

• value - (cp.ui.CheckBox) The currently value.

For example:

local share = fcp.inspector.share
-- Menu Property:
share:compositing():blendMode():value("Subtract")
-- Slider Property:
share:compositing():opacity():value(50.0)
-- XY Property:
share:transform():position():x(-10.0)
-- CheckBox property:
share:stabilization():tripodMode():value(true)

You should also be able to show a specific property and it will be revealed:

share:stabilization():smoothing():show():value(1.5)

API Overview

• Functions - API calls offered directly by the extension
• matches
• Constructors - API calls which return an object, typically one that offers API methods
• new

API Documentation

Functions

matches

Signature	cp.apple.finalcutpro.inspector.share.ShareInspector.matches(element)
Type	Function
Description	Checks if the provided element could be a ShareInspector.
Parameters	element - The element to check
Returns	true if it matches, false if not.

Constructors

new

Signature	cp.apple.finalcutpro.inspector.share.ShareInspector.new(parent) -> cp.apple.finalcutpro.share.ShareInspector
Type	Constructor
Description	Creates a new ShareInspector object
Parameters	parent - The parent
Returns	A ShareInspector object