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

FxParameterSettingAPI_v2

Extends Protocol:	FxParameterSettingAPI
Declared In:	FxParameterAPI.h

Introduction

Defines the functions the application provides to set parameter values.

Discussion

This is version 2 of the Pararameter Setting 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

-setStringParameterValue:toParm:: Sets a string value for a string parameter.

setStringParameterValue:toParm:

Sets a string value for a string parameter.

- (BOOL)setStringParameterValue:(NSString *)string toParm:(UInt32)parmId;

Parameters

string: Specified string value for the parameter
parmId: Unique identifier for the parameter.

Return Value

Returns YES if the value is set successfully; 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