docs » plugins.finalcutpro.timeline.playhead


Manages features relating to the Timeline Playhead.

API Overview

API Documentation

Variables

playheadLocked

Signature plugins.finalcutpro.timeline.playhead.playheadLocked <cp.prop: boolean>
Type Variable
Description Playhead Locked?

scrollingTimeline

Signature plugins.finalcutpro.timeline.playhead.scrollingTimeline <cp.prop: boolean>
Type Variable
Description Enables or disables the scrolling timeline.

Functions

checkScrollingTimeline

Signature plugins.finalcutpro.timeline.playhead.checkScrollingTimeline() -> boolean
Type Function
Description Checks to see if we should actually turn on the scrolling timeline.
Parameters
  • None
Returns
  • `true` if we should, `false` if not.

getScrollingTimelineWatcher

Signature plugins.finalcutpro.timeline.playhead.getScrollingTimelineWatcher() -> eventtap
Type Function
Description Gets the Scrolling Timeline Watcher.
Parameters
  • None
Returns
  • The scrolling timeline watcher `eventtap`.

update

Signature plugins.finalcutpro.timeline.playhead.update() -> none
Type Function
Description Ensures the Scrolling Timeline/Playhead Lock are in the correct mode
Parameters
  • None
Returns
  • None

updateWatcher

Signature plugins.finalcutpro.timeline.playhead.updateWatcher() -> none
Type Function
Description Creates or destroys the Final Cut Pro watcher.
Parameters
  • None
Returns
  • None

results matching ""

    No results matching ""