#cp.apple.finalcutpro.inspector.video.VideoInspector

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

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

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

#API Overview

Constants - Useful values which cannot be changed

Functions - API calls offered directly by the extension

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

Fields - Variables which can only be accessed from an object returned by a constructor

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


#API Documentation

#Constants

Signaturecp.apple.finalcutpro.inspector.video.VideoInspector.BLEND_MODES -> table
TypeConstant
DescriptionBlend Modes
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 277

Signaturecp.apple.finalcutpro.inspector.video.VideoInspector.CROP_TYPES -> table
TypeConstant
DescriptionCrop Types
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 316

Signaturecp.apple.finalcutpro.inspector.video.VideoInspector.ROLLING_SHUTTER_AMOUNTS -> table
TypeConstant
DescriptionRolling Shutter Amounts
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 334

Signaturecp.apple.finalcutpro.inspector.video.VideoInspector.SPATIAL_CONFORM_TYPES -> table
TypeConstant
DescriptionSpatial Conform Types
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 345

Signaturecp.apple.finalcutpro.inspector.video.VideoInspector.STABILIZATION_METHODS -> table
TypeConstant
DescriptionStabilisation Methods
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 325

#Functions

Signaturecp.apple.finalcutpro.inspector.video.VideoInspector.matches(element)
TypeFunction
DescriptionChecks if the provided element could be a VideoInspector.
Parameters
  • element - The element to check
Returns
  • true if it matches, false if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 78

Signaturecp.apple.finalcutpro.inspector.video.VideoInspector:selectedEffectCheckBox() -> axuielement
TypeFunction
DescriptionGets the selected effect checkbox object.
Parameters
  • None
Returns
  • A axuielement object.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 246

#Constructors

Signaturecp.apple.finalcutpro.inspector.video.VideoInspector(parent) -> cp.apple.finalcutpro.inspector.video.VideoInspector
TypeConstructor
DescriptionCreates a new VideoInspector object
Parameters
  • parent - The parent
Returns
  • A VideoInspector object
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 94

#Fields

Signaturecp.apple.finalcutpro.inspector.video.VideoInspector.contentUI <cp.prop: hs.axuielement; read-only>
TypeField
DescriptionThe axuielement containing the properties rows, if available.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 193

#Methods

Signaturecp.apple.finalcutpro.inspector.video.VideoInspector:effectCheckBoxes() -> table
TypeMethod
DescriptionGets a table containing all of the effect checkboxes.
Parameters
  • None
Returns
  • A table.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 204