Contents

addPopupMenu(withName:parameterID:defaultValue:menuEntries:parameterFlags:)

Creates a popup menu parameter and adds it to the plug-in’s parameter list.

Declaration

func addPopupMenu(withName name: String, parameterID: UInt32, defaultValue: UInt32, menuEntries entries: [Any], parameterFlags flags: FxParameterFlags) -> Bool

Parameters

  • name:

    Name of the parameter in the user interface.

  • parameterID:

    Unique identifier for a parameter. Used to retrieve, set, or validate the parameter.

  • defaultValue:

    Index of the initial entry for the parameter.

  • entries:

    Array of NSStrings representing the entries in the menu.

  • flags:

    Flags that encode various state values for the parameter.

Return Value

Returns YES if the application successfully creates a popup menu parameter; NO otherwise.

Discussion

Use getIntValue(_:fromParameter:at:) to retrieve the menu parameter index value as an integer.

See Also

Instance Methods