![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_CParameterManager.h>
A container object for plug-in parameters.
This implementation uses a STL vector to store a plug-in's set of parameters. This class contains a real implementation of the Parameter Manager (as opposed to a proxy.)
For more information, see Parameter Manager.
Public Member Functions | |
AAX_CParameterManager () | |
~AAX_CParameterManager () | |
void | Initialize (AAX_IAutomationDelegate *iAutomationDelegateUnknown) |
Initialize the parameter manager. More... | |
int32_t | NumParameters () const |
Returns the number of parameters in this instance of the parameter manager. More... | |
void | RemoveParameterByID (AAX_CParamID identifier) |
Removes a parameter from the manager. More... | |
void | RemoveAllParameters () |
Removes all parameters from the manager. More... | |
AAX_IParameter * | GetParameterByID (AAX_CParamID identifier) |
Given a parameter ID, retrieves a reference to the requested parameter. More... | |
const AAX_IParameter * | GetParameterByID (AAX_CParamID identifier) const |
Given a parameter ID, retrieves a const reference to the requested parameter. More... | |
AAX_IParameter * | GetParameterByName (const char *name) |
Given a parameter name, retrieves a reference to the requested parameter. More... | |
const AAX_IParameter * | GetParameterByName (const char *name) const |
Given a parameter name, retrieves a const reference to the requested parameter. More... | |
AAX_IParameter * | GetParameter (int32_t index) |
Given a parameter index, retrieves a reference to the requested parameter. More... | |
const AAX_IParameter * | GetParameter (int32_t index) const |
Given a parameter index, retrieves a const reference to the requested parameter. More... | |
int32_t | GetParameterIndex (AAX_CParamID identifier) const |
void | AddParameter (AAX_IParameter *param) |
void | RemoveParameter (AAX_IParameter *param) |
Protected Attributes | |
AAX_IAutomationDelegate * | mAutomationDelegate |
std::vector< AAX_IParameter * > | mParameters |
std::map< std::string, AAX_IParameter * > | mParametersMap |
AAX_CParameterManager::AAX_CParameterManager | ( | ) |
AAX_CParameterManager::~AAX_CParameterManager | ( | ) |
void AAX_CParameterManager::Initialize | ( | AAX_IAutomationDelegate * | iAutomationDelegateUnknown | ) |
Initialize the parameter manager.
Called when plug-in instance is first instantiated. This method will initialize the plug-in's automation delegate, among other set-up tasks.
[in] | iAutomationDelegateUnknown | A reference to the plug-in's AAX_IAutomationDelegate interface |
int32_t AAX_CParameterManager::NumParameters | ( | ) | const |
Returns the number of parameters in this instance of the parameter manager.
void AAX_CParameterManager::RemoveParameterByID | ( | AAX_CParamID | identifier | ) |
Removes a parameter from the manager.
[in] | identifier | ID of the parameter that will be removed |
void AAX_CParameterManager::RemoveAllParameters | ( | ) |
Removes all parameters from the manager.
AAX_IParameter* AAX_CParameterManager::GetParameterByID | ( | AAX_CParamID | identifier | ) |
Given a parameter ID, retrieves a reference to the requested parameter.
[in] | identifier | ID of the parameter that will be retrieved |
Referenced by AAX_CMonolithicParameters::UpdateParameterNormalizedValue().
const AAX_IParameter* AAX_CParameterManager::GetParameterByID | ( | AAX_CParamID | identifier | ) | const |
Given a parameter ID, retrieves a const reference to the requested parameter.
[in] | identifier | ID of the parameter that will be retrieved |
AAX_IParameter* AAX_CParameterManager::GetParameterByName | ( | const char * | name | ) |
Given a parameter name, retrieves a reference to the requested parameter.
[in] | name | Name of the parameter that will be retrieved |
const AAX_IParameter* AAX_CParameterManager::GetParameterByName | ( | const char * | name | ) | const |
Given a parameter name, retrieves a const reference to the requested parameter.
[in] | name | ID of the parameter that will be retrieved |
AAX_IParameter* AAX_CParameterManager::GetParameter | ( | int32_t | index | ) |
Given a parameter index, retrieves a reference to the requested parameter.
Parameter indices are incremented in the order that parameters are added to the manager. See AddParameter().
[in] | index | Index of the parameter that will be retrieved |
const AAX_IParameter* AAX_CParameterManager::GetParameter | ( | int32_t | index | ) | const |
Given a parameter index, retrieves a const reference to the requested parameter.
Parameter indices are incremented in the order that parameters are added to the manager. See AddParameter().
[in] | index | Index of the parameter that will be retrieved |
int32_t AAX_CParameterManager::GetParameterIndex | ( | AAX_CParamID | identifier | ) | const |
Given a parameter ID, retrieves the index for the specified parameter
[in] | identifier | ID of the parameter that will be retrieved |
void AAX_CParameterManager::AddParameter | ( | AAX_IParameter * | param | ) |
Adds a parameter to the manager
[in] | param | Reference to the parameter that will be added |
void AAX_CParameterManager::RemoveParameter | ( | AAX_IParameter * | param | ) |
Removes a parameter to the manager
[in] | param | Reference to the parameter that will be removed |
|
protected |
|
protected |
|
protected |