FxParameterCreationAPI_v2

Introduction

Defines the methods provided by the host application to create parameters.

Discussion

This is version 2 of the Pararameter Creation API. This version 2 protocol is a superset of version 1.

NOTE: A plug-in that doesn't need the new functionality found in version 2 should simply conform to the version 1 protocol. This will ensure compatibility with older plug-in hosts that might not support version 2.

Methods

-addStringParameterWithName:parmId:defaultValue:parmFlags:

Creates a string parameter and adds it to the plug-in's parameter list.

Creates a string parameter and adds it to the plug-in's parameter list.

- (BOOL)addStringParameterWithName:(NSString *)name parmId:(UInt32)parmId defaultValue:(NSString *)defaultValue 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.

defaultValue

Initial value for the parameter.

flags

Flags that encode various state values for the parameter.

Return Value

Returns YES if the application successfully creates a floating point slider 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