Protocol

FxParameterSettingAPI

The FxParameterSettingAPI protocol defines the methods the host application provides to set a plug-in’s parameter values.

Declaration

@protocol FxParameterSettingAPI

Overview

Please note that your plug-in should not attempt to set parameters or flags on any thread other than the main UI thread. That means that it cannot set parameters during rendering or on threads your plug-in has started itself or asked the host to start via the FxThread API. In addition, your plug-in should not attempt to display modal dialogs on non-UI threads.

This is version 1 of the FxParameterSettingAPI protocol.

Topics

Setting Parameter Values

- setBoolValue:toParm:atTime:

Sets a Boolean value for a parameter.

Required.

- setCustomParameterValue:toParm:

Sets an opaque value object for a custom parameter.

Required.

- setFloatValue:toParm:atTime:

Sets an float value for a parameter.

Required.

- setIntValue:toParm:atTime:

Sets an integer value for a parameter.

Required.

- setParameterFlags:toParm:

Sets the current state of the parameter.

Required.

- setRedValue:greenValue:blueValue:alphaValue:toParm:atTime:

Sets RGBA color value (in 0.0 - 1.0 floating point) for a parameter.

Required.

- setRedValue:GreenValue:BlueValue:AlphaValue:toParm:atTime:

Sets RGBA color value (in 0.0 - 1.0 floating point) for a parameter.

- setRedValue:greenValue:blueValue:toParm:atTime:

Sets RGB color value (in 0.0 - 1.0 floating point) for a parameter.

Required.

- setRedValue:GreenValue:BlueValue:toParm:atTime:

Sets RGB color value (in 0.0 - 1.0 floating point) for a parameter.

- setXValue:YValue:toParm:atTime:

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

Required.

Relationships