Protocol

FxParameterRetrievalAPI

The FxParameterRetrievalAPI protocol defines the methods the host application provides to retrieve parameter values.

Declaration

@protocol FxParameterRetrievalAPI

Overview

This is version 1 of the FxParameterRetrievalAPI protocol.

Topics

Getting Parameter Values

- getBitmap:layerOffsetX:layerOffsetY:requestInfo:fromParm:atTime:

Gets a bitmap image from a parameter.

Required.

- getBoolValue:fromParm:atTime:

Gets a boolean value from a parameter.

Required.

- getCustomParameterValue:fromParm:

Gets an opaque value object from a custom parameter.

Required.

- getFloatValue:fromParm:atTime:

Gets a floating point value from a parameter.

Required.

- getIntValue:fromParm:atTime:

Gets an integer value from a parameter.

Required.

- getParameterFlags:fromParm:

Gets current state of a parameter.

Required.

- getRedValue:greenValue:blueValue:alphaValue:fromParm:atTime:

Gets RGBA color value (in 0.0 - 1.0 floating point) from a parameter.

Required.

- getRedValue:greenValue:blueValue:fromParm:atTime:

Gets RGB color values (in 0.0 - 1.0 floating point) from a parameter.

Required.

- getRedValue:GreenValue:BlueValue:AlphaValue:fromParm:atTime:

Gets RGBA color value (in 0.0 - 1.0 floating point) from a parameter.

- getRedValue:GreenValue:BlueValue:fromParm:atTime:

Gets RGB color values (in 0.0 - 1.0 floating point) from a parameter.

- getTexture:layerOffsetX:layerOffsetY:requestInfo:fromParm:atTime:

Gets a texture image from a parameter.

Required.

- getXValue:YValue:fromParm:atTime:

Gets the x,y position value (in 0.0 - 1.0 floating point) from a parameter.

Required.

Constants

FxParameterFlags

These constants specify the characteristics of parameters display.

Expanded Parameter Flag

The following constant is provided for backward compatibility: FxPlug 1.0 had misnamed the flag that indicates that a group parameter is collapsed.

Relationships