plugins.finalcutpro.touchbar.virtual

Virtual Touch Bar Plugin.


API Overview

Constants - Useful values which cannot be changed

  • LOCATION_TIMELINE
  • VISIBILITY_ALWAYS
  • VISIBILITY_DEFAULT
  • VISIBILITY_FCP

Functions - API calls offered directly by the extension

  • updateLocation

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

  • enabled
  • location
  • visibility

API Documentation

Constants

LOCATION_TIMELINE

   
Signature plugins.finalcutpro.touchbar.virtual.LOCATION_TIMELINE -> string
Type Constant
Description Virtual Touch Bar is displayed in the top centre of the Final Cut Pro timeline
Notes None
Source src/plugins/core/touchbar/prefs/init.lua line 432

VISIBILITY_ALWAYS

   
Signature plugins.finalcutpro.touchbar.virtual.VISIBILITY_ALWAYS -> string
Type Constant
Description Virtual Touch Bar is Always Visible
Notes None
Source src/plugins/core/touchbar/prefs/init.lua line 417

VISIBILITY_DEFAULT

   
Signature plugins.finalcutpro.touchbar.virtual.VISIBILITY_DEFAULT -> string
Type Constant
Description The default visibility.
Notes None
Source src/plugins/core/touchbar/prefs/init.lua line 427

VISIBILITY_FCP

   
Signature plugins.finalcutpro.touchbar.virtual.VISIBILITY_FCP -> string
Type Constant
Description Virtual Touch Bar is only visible when Final Cut Pro is active.
Notes None
Source src/plugins/core/touchbar/prefs/init.lua line 422

Functions

updateLocation

   
Signature plugins.finalcutpro.touchbar.virtual.updateLocation() -> none
Type Function
Description Updates the Location of the Virtual Touch Bar
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/touchbar/virtual/init.lua line 202

Fields

enabled

   
Signature plugins.finalcutpro.touchbar.virtual.enabled <cp.prop: boolean>
Type Field
Description Is true if the plugin is enabled.
Notes None
Source src/plugins/core/touchbar/prefs/init.lua line 397

location

   
Signature plugins.finalcutpro.touchbar.virtual.location <cp.prop: string>
Type Field
Description The Virtual Touch Bar Location Setting
Notes None
Source src/plugins/core/touchbar/virtual/init.lua line 43

visibility

   
Signature plugins.finalcutpro.touchbar.virtual.visibility <cp.prop: string>
Type Field
Description When should the Virtual Touch Bar be visible?
Notes None
Source src/plugins/core/touchbar/prefs/init.lua line 439