Protocol

FxDynamicParameterAPI

The FxDynamicParameterAPI protocol is implemented by the host application and specifies how plug-ins create parameters dynamically.

Declaration

@protocol FxDynamicParameterAPI

Overview

By implementing this protocol a plug-in can create and remove parameters outside of the FXBaseEffect protocol’s addParameters method. It can also get and set various properties of parameters during run-time as well, such as the minimum and maximum allowable values.

Topics

Getting the Parameter Count

- parameterCount

Returns the current number of parameters for a plug-in.

Required.

Getting a Parameter ID

- parameterIDAtIndex:

Returns the ID of the parameter at the given index.

Required.

Removing Parameters

- removeParameter:

Removes the parameter with the specified ID from the plug-ins list of parameters.

Required.

Getting and Setting the Parameter Name

- parameter:name:

Get the name of the parameter with the specified ID.

Required.

- setParameter:name:

Sets the name of the parameter specified by the parameter ID.

Required.

Creating a Popup Menu for a Parameter

- setPopupMenuParameter:entries:defaultValue:

Set the menu entries of a parameter’s popup menu.

Required.

Getting and Setting Parameter Values for Sliding Controls

- parameter:floatMinimum:maximum:sliderMinimum:sliderMaximum:

Gets the specified parameter's bounds as floating point values.

Required.

- setParameter:floatMinimum:maximum:sliderMinimum:sliderMaximum:

Sets the specified parameter’s bounds as floating point values.

Required.

- parameter:intMinimum:maximum:sliderMinimum:sliderMaximum:

Gets the specified parameter’s bounds as integer values.

Required.

- setParameter:intMinimum:maximum:sliderMinimum:sliderMaximum:

Sets the specified parameter’s bounds as integer values.

Required.

Setting Default Values

- setAsDefaultsAtTime:

Inform the host application that the settings at the given time should be considered the default settings for this parameter.

Required.

Relationships