Contents

parameterID(at:)

Returns the ID of the parameter at the given index.

Declaration

func parameterID(at index: UInt32) -> UInt32

Parameters

  • index:

    The 0-based index of the parameter whose ID you wish to get.

Discussion

During -addParameters: your plugin tells the host to create parameters. Later, while running, your plugin can create new parameters using the FxParameterCreationAPI (just like in -addParameters), or it can remove them using the -removeParameter: method of this protocol. Each parameter must have a unique ID within the plugin. This method allows you to retrieve the ID of a parameter at a given index in the list of parameters. The IDs need not be sequential or even increasing. You could for example have the following:

Index

ID

Parameter

0

1

slider

1

1000

checkbox

2

10

popup menu

See Also

Instance Methods