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

FxOptionalParameterCreationAPI

Declared In:

Introduction

Defines the methods for creating parameters of optional types. These parameter types are not guaranteed to be supported by all host applications.

Discussion

See discussion of parameter IDs in the header file FxPlug/FxParameterAPI.h.

Methods

-addGradientWithName:parmId:parmFlags:: Creates a gradient parameter.
-addHistogramWithName:parmId:parmFlags:: Creates a histogram parameter.

addGradientWithName:parmId:parmFlags:

Creates a gradient parameter.

- (BOOL)addGradientWithName:(NSString *)name parmId:(UInt32)parmId parmFlags:(FxParameterFlags)flags;

Parameters

name: Name of the parameter as it appears in the user interface.
parmId: Unique identifier for a parameter. Used to retrieve, set, or validate the parameter.
flags: Flags that encode various state values for the parameter.

Return Value

Returns YES if the application successfully creates a gradient parameter; NO otherwise.

addHistogramWithName:parmId:parmFlags:

Creates a histogram parameter.

- (BOOL)addHistogramWithName:(NSString *)name parmId:(UInt32)parmId parmFlags:(FxParameterFlags)flags;

Parameters

name: Name of the parameter in the user interface.
parmId: Unique identifier for a parameter. Used to retrieve, set, or validate the parameter.
flags: Flags that encode various state values for the parameter.

Return Value

Returns YES if the application successfully creates a histogram parameter; NO otherwise.

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