|
ADC Home > Reference Library > Reference > Apple Applications > Final Cut Pro/Final Cut Express > FxPlug Reference
|
FxParameterRetrievalAPI |
| Declared In: |
Defines the functions the application provides to retrieve parameter values.
This is version 1 of the FxParameterRetrievalAPI protocol.
NOTE: The -getAngle:fromParm:atTime: method has been deprecated. Please use
-getFloatValue: instead.
getBitmap:layerOffsetX:layerOffsetY:requestInfo:fromParm:atTime: |
Gets a bitmap image from a parameter. This method allocates memory for the image that the plug-in should release when processing is complete.
- (BOOL)getBitmap:(FxBitmap **)image layerOffsetX:(double *)offsetX layerOffsetY:(double *)offsetY requestInfo:(FxRenderInfo)info fromParm:(UInt32)parmID atTime:(double)time;
image offsetX offsetY info parmId time Returns YES if the image is retrieved 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.
getBoolValue:fromParm:atTime: |
Gets a boolean value from a parameter.
- (BOOL)getBoolValue:(BOOL *)value fromParm:(UInt32)parmID atTime:(double)time;
value parmId time Returns YES if the value is retrieved 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.
getCustomParameterValue:fromParm: |
Gets an opaque value object from a custom parameter.
- (BOOL)getCustomParameterValue:(id <NSCoding> *)value fromParm:(UInt32)parmId;
value parmId Returns YES if the value is retrieved successfully; NO otherwise.
getFloatValue:fromParm:atTime: |
Gets a floating point value from a parameter.
- (BOOL)getFloatValue:(double *)value fromParm:(UInt32)parmId atTime:(double)time;
value parmId time Returns YES if the value is retrieved successfully; NO otherwise.
When used to get 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.
getIntValue:fromParm:atTime: |
Gets an integer value from a parameter.
- (BOOL)getIntValue:(int *)value fromParm:(UInt32)parmId atTime:(double)time;
value parmId time Returns YES if the value is retrieved 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.
getParameterFlags:fromParm: |
Gets current state of a parameter.
- (BOOL)getParameterFlags:(FxParameterFlags *)flags fromParm:(UInt32)parmId;
flags parmId Returns YES if the state information is retrieved successfully; NO otherwise.
getRedValue:GreenValue:BlueValue:AlphaValue:fromParm:atTime: |
Gets RGBA color value (in 0.0 - 1.0 floating point) from a parameter.
- (BOOL)getRedValue:(double *)red GreenValue:(double *)green BlueValue:(double *)blue AlphaValue:(double *)alpha fromParm:(UInt32)parmID atTime:(double)time;
red green blue alpha parmId time Returns YES if the values are retrieved 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.
getRedValue:GreenValue:BlueValue:fromParm:atTime: |
Gets RGB color values (in 0.0 - 1.0 floating point) from a parameter.
- (BOOL)getRedValue:(double *)red GreenValue:(double *)green BlueValue:(double *)blue fromParm:(UInt32)parmID atTime:(double)time;
red green blue parmId time Returns YES if the values are retrieved 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.
getTexture:layerOffsetX:layerOffsetY:requestInfo:fromParm:atTime: |
Gets a texture image from a parameter. This method allocates memory for the image that the plug-in should release when processing is complete.
- (BOOL)getTexture:(FxTexture **)image layerOffsetX:(double *)offsetX layerOffsetY:(double *)offsetY requestInfo:(FxRenderInfo)info fromParm:(UInt32)parmID atTime:(double)time;
image offsetX offsetY info parmId time Returns YES if the image is retrieved 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.
getXValue:YValue:fromParm:atTime: |
Gets the xy position value (in 0.0 - 1.0 floating point) from a parameter.
- (BOOL)getXValue:(double *)x YValue:(double *)y fromParm:(UInt32)parmID atTime:(double)time;
x y parmId time Returns YES if the values are retrieved 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.
|