Getting Started
Lua
Contributing
Control CommandPost
Plugins
Internationalisation
Final Cut Pro
Bundled Extensions
CommandPost API
Bundled Plugins API
Hammerspoon API
Have an account? Sign in

TitleInspector

Last updated 23 days ago

Title 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 title = fcp:inspector():title()
-- Menu Property:
title:compositing():blendMode():value("Subtract")
-- Slider Property:
title:compositing():opacity():value(50.0)
-- XY Property:
title:transform():position():x(-10.0)
-- CheckBox property:
title:stabilization():tripodMode():value(true)

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

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

API Overview

  • Functions - API calls offered directly by the extension

  • Constructors - API calls which return an object, typically one that offers API methods

  • Methods - API calls which can only be made on an object returned by a constructor

API Documentation

Functions

matches

Signature

cp.apple.finalcutpro.inspector.title.TitleInspector.matches(element)

Type

Function

Description

Checks if the provided element could be a TitleInspector.

Parameters

Returns

Constructors

new

Signature

cp.apple.finalcutpro.inspector.title.TitleInspector.new(parent) -> cp.apple.finalcutpro.title.TitleInspector

Type

Constructor

Description

Creates a new TitleInspector object

Parameters

Returns

Methods

app

Signature

cp.apple.finalcutpro.inspector.title.TitleInspector:app() -> table

Type

Method

Description

Returns the cp.apple.finalcutpro app table

Parameters

Returns

parent

Signature

cp.apple.finalcutpro.inspector.title.TitleInspector:parent() -> table

Type

Method

Description

Returns the TitleInspector's parent table

Parameters

Returns

show

Signature

cp.apple.finalcutpro.inspector.title.TitleInspector:show() -> TitleInspector

Type

Method

Description

Shows the Title Inspector

Parameters

Returns