docs » cp.apple.finalcutpro.main.Timeline


Timeline Module.

API Overview

API Documentation

Functions

matches

Signature cp.apple.finalcutpro.main.Timeline.matches(element) -> boolean
Type Function
Description Checks to see if an element matches what we think it should be.
Parameters
  • element - An axuielementObject to check.
Returns
  • true if matches otherwise false.

matchesMain

Signature cp.apple.finalcutpro.main.Timeline.matchesMain(element) -> boolean
Type Function
Description Checks to see if an element matches what we think it should be.
Parameters
  • element - An axuielementObject to check.
Returns
  • true if matches otherwise false

Constructors

new

Signature cp.apple.finalcutpro.main.Timeline.new(app) -> Timeline
Type Constructor
Description Creates a new Timeline instance.
Parameters
  • app - The cp.apple.finalcutpro object.
Returns
  • A new Timeline object.

Methods

app

Signature cp.apple.finalcutpro.main.Timeline:app() -> App
Type Method
Description Returns the app instance representing Final Cut Pro.
Parameters
  • None
Returns
  • App

contents

Signature cp.apple.finalcutpro.main.Timeline:contents() -> TimelineContent
Type Method
Description Gets the Timeline Contents. The Content is the main body of the timeline,
Parameters
  • None
Returns
  • TimelineContent object.

effects

Signature cp.apple.finalcutpro.main.Timeline:effects() -> EffectsBrowser
Type Method
Description Gets the (sometimes hidden) Effect Browser.
Parameters
  • None
Returns
  • EffectsBrowser object.

hide

Signature cp.apple.finalcutpro.main.Timeline:hide() -> Timeline
Type Method
Description Hide's the Timeline (regardless of whether it was on the Primary or Secondary display).
Parameters
  • None
Returns
  • Timeline object.

playhead

Signature cp.apple.finalcutpro.main.Timeline:playhead() -> Playhead
Type Method
Description Gets the Timeline Playhead.
Parameters
  • None
Returns
  • Playhead object.

show

Signature cp.apple.finalcutpro.main.Timeline:show() -> Timeline
Type Method
Description Show's the Timeline on the Primary Display.
Parameters
  • None
Returns
  • Timeline object.

showOnPrimary

Signature cp.apple.finalcutpro.main.Timeline:showOnPrimary() -> Timeline
Type Method
Description Show's the Timeline on the Primary Display.
Parameters
  • None
Returns
  • Timeline object.

showOnSecondary

Signature cp.apple.finalcutpro.main.Timeline:showOnSecondary() -> Timeline
Type Method
Description Show's the Timeline on the Secondary Display.
Parameters
  • None
Returns
  • Timeline object.

skimmingPlayhead

Signature cp.apple.finalcutpro.main.Timeline:skimmingPlayhead() -> Playhead
Type Method
Description Gets the Playhead that tracks under the mouse while skimming.
Parameters
  • None
Returns
  • Playhead object.

toolbar

Signature cp.apple.finalcutpro.main.Timeline:toolbar() -> TimelineToolbar
Type Method
Description Gets the bar at the top of the timeline.
Parameters
  • None
Returns
  • TimelineToolbar object.

transitions

Signature cp.apple.finalcutpro.main.Timeline:transitions() -> EffectsBrowser
Type Method
Description Gets the (sometimes hidden) Transitions Browser.
Parameters
  • None
Returns
  • EffectsBrowser object.

results matching ""

    No results matching ""