Publish parameter controls to Final Cut Pro

The following tasks describe how to publish parameters, compound parameters, rig controls, and other template elements. Published parameters appear in the Final Cut Pro X inspector.

Publish a parameter control

  1. In the effect, transition, title, or generator template, select the image layer, filter, or behavior containing the parameter to publish.

  2. In the selected item’s Inspector, do one of the following:

    • Click the parameter’s Animation menu (the downward arrow that appears when you place the pointer over the right side of the parameter row), then choose Publish.

      Choosing Publish from the Shear parameter Animation menu
    • Control-click the parameter’s name, then choose Publish from the shortcut menu.

  3. Save the template.

When you apply the modified effect, transition, title, or generator to a clip in the Final Cut Pro Timeline, the parameter control you published appears in the Final Cut Pro inspector, ready for adjustment.

Publish compound parameter controls (a parameter with nested subparameters)

  1. In the template project, select the image layer or effects object containing the compound parameter to publish.

  2. Open the selected item’s Inspector.

    To publish a compound parameter to Final Cut Pro in a collapsed state (its subparameters hidden by a disclosure triangle), make sure the parameter’s disclosure triangle is closed.

    To publish a compound parameter in an expanded state (disclosure triangle open and its subparameters exposed), make sure the parameter’s disclosure triangle is open.

  3. Do one of the following:

    • Control-click the parameter’s name, then choose Publish from the shortcut menu.

    • Click the parameter’s Animation menu (the downward arrow that appears when you place the pointer over the right side of the parameter row), then choose Publish.

  4. Save the template.

    The parameter and its subparameter controls are published. When the modified effect is applied to a clip in Final Cut Pro, the compound parameter retains its state (collapsed or expanded) at the time of publishing. If the result is not what you expected, click the disclosure triangle in the Final Cut Pro inspector to expand or collapse the subparameters manually.

    Published Rotation parameter in Publishing pane of Project Inspector

    Note: Examples of parameters with subparameters include Scale (with X, Y, and Z values) and Shear (with X and Y values).

Publish subparameter controls of a compound parameter

You can also publish specific subparameters of a compound parameter. This is a good way to limit an editor’s control over effects parameters in a Final Cut Pro project.

  1. In the template project, select the image layer or effect object containing the subparameter to publish.

  2. In the item’s Inspector, click the compound parameter’s disclosure triangle to show its subparameters.

  3. For each parameter to publish, do one of the following:

    • Click the parameter’s Animation menu (the downward arrow that appears when you place the pointer over the right side of the parameter row), then choose Publish.

    • Control-click the parameter’s name, then choose Publish from the shortcut menu.

  4. Save the template.

    The subparameter control is published. When you apply the modified effect to a clip in Final Cut Pro, the subparameter appears in the Final Cut Pro inspector.

Publish an activation checkbox for a filter or behavior

Publishing a filter or behavior activation checkbox lets Final Cut Pro users quickly turn an effect on or off.

  1. In the template project, select the filter or behavior whose activation checkbox you want to publish.

  2. In the Behaviors or Filters Inspector, do one of the following:

    • In the header row of the behavior or filter, click the Animation menu (the downward arrow that appears when you place the pointer over the right side of the row), then choose Publish.

    • Control-click the behavior or filter name, then choose Publish from the shortcut menu.

      Note: If you publish only the blue activation checkbox and no other parameters in the behavior or filter’s group of controls, only the checkbox is published.

  3. Save the template.

    When you apply the modified effect to a clip in Final Cut Pro, a checkbox with the name of the published filter or behavior appears in the Final Cut Pro inspector. Deselecting the checkbox disables the effect of that filter or behavior (including its constituent parameters).

Publish a rig control (widget)

  1. Add a rig to the template, assigning specific parameters to the rig’s widget controls.

    For more information about building rigs, creating widgets, and assigning parameters, see Rigging overview.

  2. Select the rig, then do one of the following in the Rig Inspector:

    • In the Checkbox, Pop-up, or Slider widgets, click the Animation menu (the downward arrow that appears when you place the pointer over the right side of the widget’s parameter row), then choose Publish from the shortcut menu.

    • Control-click the Checkbox, Pop-up, or Slider parameter name, then choose Publish from the shortcut menu.

  3. Save the template.

    When you apply the modified effect, transition, title, or generator to a clip in the Final Cut Pro Timeline, the rig control you published appears in the Final Cut Pro inspector.

Publish a gradient editor control

  1. In the template project, select the image layer or effect object that contains the gradient editor to publish.

  2. In the item’s Inspector, Control-click the Gradient parameter, then choose Publish from the shortcut menu.

  3. Save the template.

    When you apply the modified effect, transition, title, or generator to a clip in the Final Cut Pro Timeline, the gradient editor control appears in the Final Cut Pro inspector.

Publish a filter’s onscreen controls

You can publish a filter’s onscreen controls so that Final Cut Pro users can make filter adjustments by dragging handles in the Final Cut Pro Viewer.

  1. In the template project, select the filter object.

  2. In the Filters Inspector, select the Publish OSC checkbox.

    Filter Inspector showing Publish OSC checkbox
  3. Save the template.

When you apply the modified effect, transition, title, or generator to a clip in the Final Cut Pro Timeline, the onscreen controls for the filter appear in the Final Cut Pro Viewer.

Note: When you publish onscreen controls, their corresponding numeric controls in the Inspector are not published. You must publish Inspector parameter controls separately. See “Publish a parameter control” above.

For more information about filter onscreen controls, see Adjust filters using onscreen controls and Publish filter parameters for use in Final Cut Pro X.