|
ADC Home > Reference Library > Reference > Apple Applications > Final Cut Pro/Final Cut Express > FxPlug Reference
|
FxParameterSettingAPI |
| Declared In: |
Defines the functions the application provides to set parameter values.
This is version 1 of the FxParameterSettingAPI protocol.
setBoolValue:toParm:atTime: |
Sets the value of a boolean parameter.
- (BOOL)setBoolValue:(BOOL)value toParm:(UInt32)parmId atTime:(double)time;
value parmId time Returns YES if the value is set successfully; NO otherwise.
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.
setCustomParameterValue:toParm: |
Sets an opaque value object for a custom parameter.
- (BOOL)setCustomParameterValue:(id <NSCoding>)value toParm:(UInt32)parmId;
value parmId Returns YES if the value is set successfully; NO otherwise.
The value argument must be an instance of a class that conforms to the NSCoding protocol. If it is not, this method returns NO.
setFloatValue:toParm:atTime: |
Sets the value of a floating point parameter.
- (BOOL)setFloatValue:(double)value toParm:(UInt32)parmId atTime:(double)time;
value parmId time Returns YES if the value is set successfully; NO otherwise.
When used to set the value of an angle parameter, the result will be expressed
in counter-clockwise degrees. 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.
In FxPlug 1.2, the documentation for this method incorrectly stated that
angle values were returned in radians.
setIntValue:toParm:atTime: |
Sets the value of an integer parameter.
- (BOOL)setIntValue:(int)value toParm:(UInt32)parmId atTime:(double)time;
value parmId time Returns YES if the value is set successfully; NO otherwise.
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.
setParameterFlags:toParm: |
Sets the flags for the state of a parameter.
- (BOOL)setParameterFlags:(FxParameterFlags)flags toParm:(UInt32)parmId;
flags parmId Returns YES if the flags are set successfully; NO otherwise.
Setting or resetting the kFxParameterFlag_HIDDEN flag on a ParameterSubGroup parameter will also hide or reveal all of the controls within the group. Likewise, changing the kFxParameterFlag_DISABLED flag value affects all of the controls within the group as well.
setRedValue:GreenValue:BlueValue:AlphaValue:toParm:atTime: |
Sets the value of an RGBA color parameter
- (BOOL)setRedValue:(double)red GreenValue:(double)green BlueValue:(double)blue AlphaValue:(double)alpha toParm:(UInt32)parmId atTime:(double)time;
red green blue alpha parmId time Returns YES if the values are set successfully; NO otherwise.
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.
setRedValue:GreenValue:BlueValue:toParm:atTime: |
Set the values of an RGB color parameter.
- (BOOL)setRedValue:(double)red GreenValue:(double)green BlueValue:(double)blue toParm:(UInt32)parmId atTime:(double)time;
red green blue parmId time Returns YES if the values are set successfully; NO otherwise.
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.
setXValue:YValue:toParm:atTime: |
Sets the xy values for a position parameter.
- (BOOL)setXValue:(double)x YValue:(double)y toParm:(UInt32)parmId atTime:(double)time;
x y parmId time Returns YES if the values are set successfully; NO otherwise.
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.
|