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

FxOptionalParameterSettingAPI

Declared In:

FxOptionalParameterAPI.h

Introduction

Defines the functions the application provides to set parameter values.

Methods

-setHistogramBlackIn:BlackOut:WhiteIn:WhiteOut:Gamma:forChannel:fromParm:atTime:: Sets the values in a histogram parameter group.

setHistogramBlackIn:BlackOut:WhiteIn:WhiteOut:Gamma:forChannel:fromParm:atTime:

Sets the values in a histogram parameter group.

- (BOOL)setHistogramBlackIn:(double)blackIn BlackOut:(double)blackOut WhiteIn:(double)whiteIn WhiteOut:(double)whiteOut Gamma:(double)gamma forChannel:(int)channel fromParm:(UInt32)parmId atTime:(double)time;

Parameters

blackIn: The new black in level value.
blackOut: The new black out level value.
whiteIn: The new white in level value.
whiteOut: The new white out level value.
gamma: The new gamma value.
channel: Specified channel for new histogram values (RGB: 0, Red : 1, Green: 2, Blue: 3, Alpha: 4).
parmId: Parameter identifier assigned upon creation.
time: Specified time, expressed in canonical frames, to set the parameter values.

Return Value

Returns YES if the values is successfully set; NO if the parameter cannot be found.

Discussion

Depending on the host application, the time value may be relative to the start of the timeline or to the start of the clip. See the header file FxPlug/FxHostCapabilities.h.

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