plugins.finalcutpro.timeline.mousezoom.md

docs » plugins.finalcutpro.timeline.mousezoom

---

Allows you to zoom in or out of a Final Cut Pro timeline using the mechanical scroll wheel on your mouse or the Touch Pad on the Magic Mouse when holding down the OPTION modifier key.

Special Thanks: Iain Anderson (@funwithstuff) for all his incredible testing!

API Overview

• Variables - Configurable values
• customModifier
• enabled
• numberOfTouchDevices
• offset
• threshold
• Functions - API calls offered directly by the extension
• findMagicMouses
• start
• stop
• update

API Documentation

Variables

customModifier

Signature	plugins.finalcutpro.timeline.mousezoom.customModifier <cp.prop: string>
Type	Variable
Description	Custom Modifier as string.

enabled

Signature	plugins.finalcutpro.timeline.mousezoom.enabled <cp.prop: boolean>
Type	Variable
Description	Toggles the Enable Proxy Menu Icon

numberOfTouchDevices

Signature	plugins.finalcutpro.timeline.mousezoom.numberOfTouchDevices -> number
Type	Variable
Description	Number of Touch Devices Detected.

offset

Signature	plugins.finalcutpro.timeline.mousezoom.offset -> number
Type	Variable
Description	Offset Value used in difference calculations.

threshold

Signature	plugins.finalcutpro.timeline.mousezoom.threshold -> number
Type	Variable
Description	Threshold Value used in difference calculations.

Functions

findMagicMouses

Signature	plugins.finalcutpro.timeline.mousezoom.findMagicMouses() -> none
Type	Function
Description	Find Magic Mouse Devices and adds them to a table.
Parameters	None
Returns	None

start

Signature	plugins.finalcutpro.timeline.mousezoom.start() -> none
Type	Function
Description	Enables the ability to zoon a timeline using your mouse scroll wheel and the OPTION modifier key.
Parameters	None
Returns	None

stop

Signature	plugins.finalcutpro.timeline.mousezoom.stop() -> none
Type	Function
Description	Disables the ability to zoom a timeline using your mouse scroll wheel and the OPTION modifier key.
Parameters	None
Returns	None

update

Signature	plugins.finalcutpro.timeline.mousezoom.update() -> none
Type	Function
Description	Checks to see whether or not we should enable the timeline zoom watchers.
Parameters	None
Returns	None