# 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

  • BLEND_MODES
  • CROP_TYPES
  • ROLLING_SHUTTER_AMOUNTS
  • SPATIAL_CONFORM_TYPES
  • STABILIZATION_METHODS

Functions - API calls offered directly by the extension

  • matches
  • selectedEffectCheckBox

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

  • VideoInspector

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

  • contentUI

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

  • effectCheckBoxes

# API Documentation

# Constants

# BLEND_MODES

Signature cp.apple.finalcutpro.inspector.video.VideoInspector.BLEND_MODES -> table
Type Constant
Description Blend Modes
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 277

# CROP_TYPES

Signature cp.apple.finalcutpro.inspector.video.VideoInspector.CROP_TYPES -> table
Type Constant
Description Crop Types
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 316

# ROLLING_SHUTTER_AMOUNTS

Signature cp.apple.finalcutpro.inspector.video.VideoInspector.ROLLING_SHUTTER_AMOUNTS -> table
Type Constant
Description Rolling Shutter Amounts
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 334

# SPATIAL_CONFORM_TYPES

Signature cp.apple.finalcutpro.inspector.video.VideoInspector.SPATIAL_CONFORM_TYPES -> table
Type Constant
Description Spatial Conform Types
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 345

# STABILIZATION_METHODS

Signature cp.apple.finalcutpro.inspector.video.VideoInspector.STABILIZATION_METHODS -> table
Type Constant
Description Stabilisation Methods
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 325

# Functions

# matches

Signature cp.apple.finalcutpro.inspector.video.VideoInspector.matches(element)
Type Function
Description Checks if the provided element could be a VideoInspector.
Parameters
  • element - The element to check
Returns
  • true if it matches, false if not.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 78

# selectedEffectCheckBox

Signature cp.apple.finalcutpro.inspector.video.VideoInspector:selectedEffectCheckBox() -> axuielement
Type Function
Description Gets the selected effect checkbox object.
Parameters
  • None
Returns
  • A axuielement object.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 246

# Constructors

# VideoInspector

Signature cp.apple.finalcutpro.inspector.video.VideoInspector(parent) -> cp.apple.finalcutpro.inspector.video.VideoInspector
Type Constructor
Description Creates a new VideoInspector object
Parameters
  • parent - The parent
Returns
  • A VideoInspector object
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 94

# Fields

# contentUI

Signature cp.apple.finalcutpro.inspector.video.VideoInspector.contentUI <cp.prop: hs.axuielement; read-only>
Type Field
Description The axuielement containing the properties rows, if available.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 193

# Methods

# effectCheckBoxes

Signature cp.apple.finalcutpro.inspector.video.VideoInspector:effectCheckBoxes() -> table
Type Method
Description Gets a table containing all of the effect checkboxes.
Parameters
  • None
Returns
  • A table.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/video/VideoInspector.lua line 204