Protocol

FxParameterRetrievalAPI_v6

Defines the functions the application provides to retrieve parameter values.

Declaration

@protocol FxParameterRetrievalAPI_v6

Topics

Instance Methods

- getBoolValue:fromParameter:atTime:

Gets a boolean value from a parameter.

Required.

- getCustomParameterValue:fromParameter:atTime:

Retrieves the (possibly keyframed) value of a custom parameter at a given time.

Required.

- getFloatValue:fromParameter:atTime:

Gets a floating point value from a parameter.

Required.

- getFontName:fromParameter:atTime:

Retrieves the family and typeface of a given font.

Required.

- getGradientSamples:numSamples:depth:fromParameter:atTime:

Gets the Gradient parameter settings.

Required.

- getIntValue:fromParameter:atTime:

Gets an integer value from a parameter.

Required.

- getParameterFlags:fromParameter:

Gets current state of a parameter.

Required.

- getPathID:fromParameter:atTime:

Retrieves the (possibly keyframed) value of a pathID parameter at a given time.

Required.

- getRedValue:greenValue:blueValue:alphaValue:fromParameter:atTime:

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

Required.

- getRedValue:greenValue:blueValue:fromParameter:atTime:

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

Required.

- getStringParameterValue:fromParameter:

Gets a string value from a string parameter.

Required.

- getXValue:YValue:fromParameter:atTime:

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

Required.

Legacy Versions

FxParameterRetrievalAPI

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

FxParameterRetrievalAPI_v2

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

FxParameterRetrievalAPI_v3

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

FxParameterRetrievalAPI_v4

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

FxParameterRetrievalAPI_v5

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

Relationships

Inherits From

See Also

Parameter APIs

FxParameterCreationAPI_v5

Defines the methods provided by the host application to create parameters.

FxParameterSettingAPI_v5

Defines the functions the application provides to set parameter values.

FxDynamicParameterAPI_v3

Allows your plugin to create parameters on-the-fly.