A class encapsulating a group of AudioProcessorParameters and nested AudioProcessorParameterGroups.
More...
|
| AudioProcessorParameterGroup () |
| Creates an empty AudioProcessorParameterGroup with no name or ID.
|
|
| AudioProcessorParameterGroup (String groupID, String groupName, String subgroupSeparator) |
| Creates an empty AudioProcessorParameterGroup.
|
|
template<typename ParameterOrGroup > |
| AudioProcessorParameterGroup (String groupID, String groupName, String subgroupSeparator, std::unique_ptr< ParameterOrGroup > child) |
| Creates an AudioProcessorParameterGroup with a single child.
|
|
template<typename ParameterOrGroup , typename... Args> |
| AudioProcessorParameterGroup (String groupID, String groupName, String subgroupSeparator, std::unique_ptr< ParameterOrGroup > firstChild, Args &&... remainingChildren) |
| Creates an AudioProcessorParameterGroup with multiple children.
|
|
| AudioProcessorParameterGroup (AudioProcessorParameterGroup &&) |
| Once a group has been added to an AudioProcessor don't try to mutate it by moving or swapping it - this will crash most hosts.
|
|
AudioProcessorParameterGroup & | operator= (AudioProcessorParameterGroup &&) |
| Once a group has been added to an AudioProcessor don't try to mutate it by moving or swapping it - this will crash most hosts.
|
|
| ~AudioProcessorParameterGroup () |
| Destructor.
|
|
String | getID () const |
| Returns the group's ID.
|
|
String | getName () const |
| Returns the group's name.
|
|
String | getSeparator () const |
| Returns the group's separator string.
|
|
const AudioProcessorParameterGroup * | getParent () const noexcept |
| Returns the parent of the group, or nullptr if this is a top-level group.
|
|
void | setName (String newName) |
| Changes the name of the group.
|
|
const AudioProcessorParameterNode *const * | begin () const noexcept |
|
const AudioProcessorParameterNode *const * | end () const noexcept |
|
Array< const AudioProcessorParameterGroup * > | getSubgroups (bool recursive) const |
| Returns all subgroups of this group.
|
|
Array< AudioProcessorParameter * > | getParameters (bool recursive) const |
| Returns all the parameters in this group.
|
|
Array< const AudioProcessorParameterGroup * > | getGroupsForParameter (AudioProcessorParameter *) const |
| Searches this group recursively for a parameter and returns a depth ordered list of the groups it belongs to.
|
|
template<typename ParameterOrGroup > |
void | addChild (std::unique_ptr< ParameterOrGroup > child) |
| Adds a child to the group.
|
|
template<typename ParameterOrGroup , typename... Args> |
void | addChild (std::unique_ptr< ParameterOrGroup > firstChild, Args &&... remainingChildren) |
| Adds multiple parameters or sub-groups to this group.
|
|
A class encapsulating a group of AudioProcessorParameters and nested AudioProcessorParameterGroups.
This class is predominantly write-only; there are methods for adding group members but none for removing them. Ultimately you will probably want to add a fully constructed group to an AudioProcessor.
- See also
- AudioProcessor::addParameterGroup