Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Latest commit

 

History

History
174 lines (151 loc) · 19.9 KB

plugins.finalcutpro.tangent.common.md

File metadata and controls

174 lines (151 loc) · 19.9 KB
Raw

docs » plugins.finalcutpro.tangent.common

Common Final Cut Pro functions for Tangent

API Overview

API Documentation

Functions

buttonParameter

Signature plugins.finalcutpro.tangent.common.buttonParameter(group, param, id, label) -> number
Type Function
Description Sets up a new Button Parameter for the Tangent
Parameters
  • group - The Tangent Group.
  • param - The Parameter
  • id - The Tangent ID.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
Returns
  • An updated ID

checkboxParameter

Signature plugins.finalcutpro.tangent.common.checkboxParameter(group, param, id, label) -> number
Type Function
Description Sets up a new Checkbox Parameter for the Tangent
Parameters
  • group - The Tangent Group.
  • param - The Parameter
  • id - The Tangent ID.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
Returns
  • An updated ID

checkboxParameterByIndex

Signature plugins.finalcutpro.tangent.common.checkboxParameterByIndex(group, section, nextSection, id, label, index) -> number
Type Function
Description Sets up a new AXCheckBox object for the Tangent.
Parameters
  • group - The Tangent Group.
  • section - The section as it appears in the FCPX Inspector.
  • nextSection - The next section as it appears in the FCPX Inspector.
  • id - The Tangent ID.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
  • index - The index of the checkbox in the section.
Returns
  • An updated ID

checkboxSliderParameter

Signature plugins.finalcutpro.tangent.common.checkboxSliderParameter(group, id, label, options, resetIndex) -> number
Type Function
Description Sets up a new Popup Slider parameter for the Tangent
Parameters
  • group - The Tangent Group.
  • id - The Tangent ID.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
  • options - A table of options. The key for each option should be a number ID (in the order it appears in the UI), and the value should be another table with keys for flexoID and i18n values.
  • resetIndex - An index of which item to use when "reset" is triggered.
Returns
  • An updated ID

commandParameter

Signature plugins.finalcutpro.tangent.common.commandParameter(group, id, commandID) -> number
Type Function
Description Sets up a new Command Parameter for the Tangent
Parameters
  • group - The Tangent Group.
  • id - The Tangent ID.
  • commandID - The command ID.
Returns
  • An updated ID

doShortcut

Signature plugins.finalcutpro.tangent.common.doShortcut(id) -> none
Type Function
Description Triggers a shortcut via Rx.
Parameters
  • id - The ID of the shortcut.
Returns
  • None

doShowParameter

Signature plugins.finalcutpro.tangent.common.doShowParameter(group, param, id, label) -> number
Type Function
Description Sets up a new DoShow Parameter for the Tangent
Parameters
  • group - The Tangent Group.
  • param - The Parameter
  • id - The Tangent ID.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
Returns
  • An updated ID

dynamicPopupSliderParameter

Signature plugins.finalcutpro.tangent.common.dynamicPopupSliderParameter(group, param, id, label, defaultValue) -> number
Type Function
Description Sets up a new Popup Slider parameter for the Tangent
Parameters
  • group - The Tangent Group.
  • param - The Parameter
  • id - The Tangent ID.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
  • defaultValue - The default value to use when the reset button is pressed.
Returns
  • An updated ID

functionParameter

Signature plugins.finalcutpro.tangent.common.functionParameter(group, id, label, fn) -> number
Type Function
Description Sets up a new Function Parameter for the Tangent.
Parameters
  • group - The Tangent Group.
  • id - The Tangent ID.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
  • path - The list of menu items you'd like to activate as a table.
Returns
  • An updated ID

menuParameter

Signature plugins.finalcutpro.tangent.common.menuParameter(group, id, label, path) -> number
Type Function
Description Sets up a new Final Cut Pro Menu Parameter for the Tangent.
Parameters
  • group - The Tangent Group.
  • id - The Tangent ID.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
  • path - The list of menu items you'd like to activate as a table.
Returns
  • An updated ID

popupParameter

Signature plugins.finalcutpro.tangent.common.popupParameter(group, param, id, value, label) -> number
Type Function
Description Sets up a new Popup Parameter for the Tangent
Parameters
  • group - The Tangent Group.
  • param - The Parameter.
  • id - The Tangent ID.
  • value - The value to select as a string.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
Returns
  • An updated ID

popupParameters

Signature plugins.finalcutpro.tangent.common.popupParameters(group, param, id, options) -> number
Type Function
Description Sets up a new Popup Parameter for the Tangent
Parameters
  • group - The Tangent Group.
  • param - The Parameter
  • id - The Tangent ID.
  • options - A table of options. The key for each option should be a number ID (in the order it appears in the UI), and the value should be another table with keys for flexoID and i18n values.
Returns
  • An updated ID

popupSliderParameter

Signature plugins.finalcutpro.tangent.common.popupSliderParameter(group, param, id, label, options, resetIndex) -> number
Type Function
Description Sets up a new Popup Slider parameter for the Tangent
Parameters
  • group - The Tangent Group.
  • param - The Parameter
  • id - The Tangent ID.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
  • options - A table of options. The key for each option should be a number ID (in the order it appears in the UI), and the value should be another table with keys for flexoID and i18n values.
  • resetIndex - An index of which item to use when "reset" is triggered.
Returns
  • An updated ID

radioButtonParameter

Signature plugins.finalcutpro.tangent.common.radioButtonParameter(group, param, id, label) -> number
Type Function
Description Sets up a new Checkbox Parameter for the Tangent
Parameters
  • group - The Tangent Group.
  • param - The Parameter
  • id - The Tangent ID.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
Returns
  • An updated ID

shortcutParameter

Signature plugins.finalcutpro.tangent.common.shortcutParameter(group, id, label, shortcutID) -> number
Type Function
Description Sets up a new Final Cut Pro Shortcut Parameter for the Tangent.
Parameters
  • group - The Tangent Group.
  • id - The Tangent ID.
  • label - The label to be used by the Tangent. This can either be an i18n ID or a plain string.
  • shortcutID - The shortcut ID.
Returns
  • An updated ID

sliderParameter

Signature plugins.finalcutpro.tangent.common.sliderParameter(group, param, id, minValue, maxValue, stepSize, default, label, optionalParamA, optionalParamB) -> number, parameter
Type Function
Description Sets up a new Slider Parameter
Parameters
  • group - The Tangent Group
  • param - The Parameter
  • id - The Tangent ID
  • minValue - The minimum value
  • maxValue - The maximum value
  • stepSize - The step size
  • default - The default value
  • label - An optional label as an i18n ID or plain string. If no label is supplied the param label will be used.
  • optionalParamA - An optional parameter. Useful if you need to link parameters.
  • optionalParamB - An optional parameter. Useful if you need to link parameters.
Returns
  • An updated ID
  • The parameters value

volumeSliderParameter

Signature plugins.finalcutpro.tangent.common.volumeSliderParameter(group, param, id, minValue, maxValue, stepSize, default, label) -> number, parameter
Type Function
Description Sets up a new Volume Slider Parameter
Parameters
  • group - The Tangent Group
  • param - The Parameter
  • id - The Tangent ID
  • minValue - The minimum value
  • maxValue - The maximum value
  • stepSize - The step size
  • default - The default value
  • label - An optional label as an i18n ID or plain string. If no label is supplied the param label will be used.
Returns
  • An updated ID
  • The parameters value

xyParameter

Signature plugins.finalcutpro.tangent.common.xyParameter(group, param, id, minValue, maxValue, stepSize) -> number
Type Function
Description Sets up a new XY Parameter
Parameters
  • group - The Tangent Group
  • param - The Parameter
  • id - The Tangent ID
Returns
  • An updated ID
  • The x parameter value
  • The y parameter value
  • The xy binding