ADC Home > Reference Library > Reference > Apple Applications > Final Cut Pro/Final Cut Express > FxPlug Reference

FxParameterAPI.h

Introduction

Defines the FxParameter host API protocols for creating parameters, and for getting and setting parameter values.

Protocols

FxParameterCreationAPI: Defines the methods provided by the host application to create parameters.
FxParameterCreationAPI_v2: Defines the methods provided by the host application to create parameters.
FxParameterRetrievalAPI: Defines the functions the application provides to retrieve parameter values.
FxParameterRetrievalAPI_v2: Defines the functions the application provides to retrieve parameter values.
FxParameterSettingAPI: Defines the functions the application provides to set parameter values.
FxParameterSettingAPI_v2: Defines the functions the application provides to set parameter values.

Enumerations

FxParameterFlags

enum { 
    kFxParameterFlag_DEFAULT = 0, 
    kFxParameterFlag_NOT_ANIMATABLE = 1 << 0, 
    kFxParameterFlag_HIDDEN = 1 << 1, 
    kFxParameterFlag_DISABLED = 1 << 2, 
    kFxParameterFlag_COLLAPSED = 1 << 3, 
    kFxParameterFlag_DONT_SAVE = 1 << 4, 
    kFxParameterFlag_DONT_DISPLAY_IN_DASHBOARD = 1 << 5, 
    kFxParameterFlag_CUSTOM_UI = 1 << 6, 
    kFxParameterFlag_IGNORE_MINMAX = 1 << 8, 
};

Constants

kFxParameterFlag_DEFAULT
Convenience constant. No flags set.

kFxParameterFlag_NOT_ANIMATABLE
This parameter's value is constant across time and cannot be animated.

kFxParameterFlag_HIDDEN
This parameter displays no UI to the user, but its value is saved/loaded. Note that this visibility control is independent of the DONT_DISPLAY_IN_DASHBOARD flag. It is possible to have a parameter that appears in the dashboard but not in the inspector, or vice versa.

kFxParameterFlag_DISABLED
This parameter is dimmed and disabled.

kFxParameterFlag_COLLAPSED
This Group parameter's subgroup is closed and its subparameters are not visible in the Inspector.

kFxParameterFlag_DONT_SAVE
This parameter's values are not saved/loaded.

kFxParameterFlag_DONT_DISPLAY_IN_DASHBOARD
This parameter is not visible in the dashboard controls.

kFxParameterFlag_CUSTOM_UI
This parameter uses custom UI that replaces the standard parameter UI. The plug-in must provide a custom view for this parameter. (See the FxCustomParameterActionAPI and FxCustomParameterViewHost protocols, defined in FxCustomParameterUI.h.)

kFxParameterFlag_IGNORE_MINMAX
This parameter's range is unbounded. Ignore its Min and Max values.

Discussion

Of course, not all of the flags apply meaningfully to all of the parameter types. The only flags, for example, that apply to Group parameters are COLLAPSED, DONT_DISPLAY_IN_DASHBOARD, HIDDEN, and DISABLED. You can't give a group parameter a custom UI.

Did this document help you?

Yes: Tell us what works for you.

It’s good, but: Report typos, inaccuracies, and so forth.

It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-06-05