Protocol

FxParameterRetrievalAPI_v5

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

Declaration

@protocol FxParameterRetrievalAPI_v5

Overview

This protocol is only available to FxPlug 3 plug-ins.

Topics

Getting Parameter Values

- getFloatValue:fromParm:atFxTime:

Retrieves the floating point value of the specified parameter.

Required.

- getIntValue:fromParm:atFxTime:

Retrieves the integer value of the specified parameter.

Required.

- getBoolValue:fromParm:atFxTime:

Retrieves the boolean value of the specified parameter.

Required.

- getRedValue:greenValue:blueValue:fromParm:atFxTime:

Retrieves the RGB color values of the specified parameter.

Required.

- getRedValue:greenValue:blueValue:alphaValue:fromParm:atFxTime:

Retrieves the RGBA color values of the specified parameter.

Required.

- getXValue:YValue:fromParm:atFxTime:

Retrieves the X,Y position value of the specified parameter.

Required.

- getBitmap:layerOffsetX:layerOffsetY:requestInfo:fromParm:atFxTime:

Retrieves a bitmap image from the specified parameter.

Required.

- getTexture:layerOffsetX:layerOffsetY:requestInfo:fromParm:atFxTime:

Retrieves a texture image from the specified parameter.

Required.

- getPathID:fromParm:atFxTime:

Retrieves the path ID of a custom parameter at a given time.

Required.

- getCustomParameterValue:fromParm:

Retrieves the opaque value object of the specified custom parameter.

Required.

- getCustomParameterValue:fromParm:atFxTime:

Retrieves the opaque value object of the specified custom parameter at a given time.

Required.

- getFontName:fromParm:atFxTime:

Retrieves the family and typeface of the specified parameter at a given time.

Required.

- getParameterFlags:fromParm:

Retrieves the current state of the specified parameter.

Required.

- getStringParameterValue:fromParm:

Retrieves the string value of the specified parameter.

Required.

Relationships

Inherits From

See Also

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.