![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_IACFPageTable.h>
Versioned interface to the host's representation of a plug-in instance's page table.
Public Member Functions | |
virtual AAX_Result | GetNumParametersWithNameVariations (int32_t &oNumParameterIdentifiers) const =0 |
virtual AAX_Result | GetNameVariationParameterIDAtIndex (int32_t iIndex, AAX_IString &oParameterIdentifier) const =0 |
virtual AAX_Result | GetNumNameVariationsForParameter (AAX_CPageTableParamID iParameterIdentifier, int32_t &oNumVariations) const =0 |
virtual AAX_Result | GetParameterNameVariationAtIndex (AAX_CPageTableParamID iParameterIdentifier, int32_t iIndex, AAX_IString &oNameVariation, int32_t &oLength) const =0 |
virtual AAX_Result | GetParameterNameVariationOfLength (AAX_CPageTableParamID iParameterIdentifier, int32_t iLength, AAX_IString &oNameVariation) const =0 |
virtual AAX_Result | ClearParameterNameVariations ()=0 |
virtual AAX_Result | ClearNameVariationsForParameter (AAX_CPageTableParamID iParameterIdentifier)=0 |
virtual AAX_Result | SetParameterNameVariation (AAX_CPageTableParamID iParameterIdentifier, const AAX_IString &iNameVariation, int32_t iLength)=0 |
![]() | |
virtual AAX_Result | Clear ()=0 |
Clears all parameter mappings from the table. More... | |
virtual AAX_Result | Empty (AAX_CBoolean &oEmpty) const =0 |
Indicates whether the table is empty. More... | |
virtual AAX_Result | GetNumPages (int32_t &oNumPages) const =0 |
Get the number of pages currently in this table. More... | |
virtual AAX_Result | InsertPage (int32_t iPage)=0 |
Insert a new empty page before the page at index iPage . More... | |
virtual AAX_Result | RemovePage (int32_t iPage)=0 |
Remove the page at index iPage . More... | |
virtual AAX_Result | GetNumMappedParameterIDs (int32_t iPage, int32_t &oNumParameterIdentifiers) const =0 |
Returns the total number of parameter IDs which are mapped to a page. More... | |
virtual AAX_Result | ClearMappedParameter (int32_t iPage, int32_t iIndex)=0 |
Clear the parameter at a particular index in this table. More... | |
virtual AAX_Result | GetMappedParameterID (int32_t iPage, int32_t iIndex, AAX_IString &oParameterIdentifier) const =0 |
Get the parameter identifier which is currently mapped to an index in this table. More... | |
virtual AAX_Result | MapParameterID (AAX_CParamID iParameterIdentifier, int32_t iPage, int32_t iIndex)=0 |
Map a parameter to this table. More... | |
![]() | |
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE | QueryInterface (const acfIID &iid, void **ppOut)=0 |
Returns pointers to supported interfaces. More... | |
virtual acfUInt32 ACFMETHODCALLTYPE | AddRef (void)=0 |
Increments reference count. More... | |
virtual acfUInt32 ACFMETHODCALLTYPE | Release (void)=0 |
Decrements reference count. More... | |
|
pure virtual |
Get the number of parameters with name variations defined for the current table type
Provides the number of parameters with lt;ControlNameVariationslt;
which are explicitly defined for the current page table type.
'PgTL'
table type[out] | oNumParameterIdentifiers | The number of parameters with name variations explicitly associated with the current table type. |
|
pure virtual |
Get the identifier for a parameter with name variations defined for the current table type
'PgTL'
table type[in] | iIndex | The target parameter index within the list of parameters with explicit name variations defined for this table type. |
[out] | oParameterIdentifier | The identifier used for the parameter in the page table name variations list (may be parameter name or ID) |
|
pure virtual |
Get the number of name variations defined for a parameter
Provides the number of lt;ControlNameVariationslt;
which are explicitly defined for iParameterIdentifier
for the current page table type. No fallback logic is used to resolve this to the list of variations which would actually be used for an attached control surface if no explicit variations are defined for the current table type.
'PgTL'
table typeoNumVariations
if iParameterIdentifier
is not found[in] | iParameterIdentifier | The identifier for the parameter |
[out] | oNumVariations | The number of name variations which are defined for this parameter and explicitly associated with the current table type. |
|
pure virtual |
Get a parameter name variation from the page table
Only returns lt;ControlNameVariationslt;
which are explicitly defined for the current page table type. No fallback logic is used to resolve this to the abbreviation which would actually be shown on an attached control surface if no explicit variation is defined for the current table type.
'PgTL'
table typeiIndex
is out of range[in] | iParameterIdentifier | The identifier for the parameter |
[in] | iIndex | Index of the name variation |
[out] | oNameVariation | The name variation, if one is explicitly defined for this table type |
[out] | oLength | The length value for this name variation. This corresponds to the variation's sz attribute in the page table XML and may be different from the string length of iNameVariation . |
|
pure virtual |
Get a parameter name variation of a particular length from the page table
Only returns lt;ControlNameVariationslt;
which are explicitly defined of iLength
for the current page table type. No fallback logic is used to resolve this to the abbreviation which would actually be shown on an attached control surface if no explicit variation is defined for the specified length or current table type.
'PgTL'
table type[in] | iParameterIdentifier | The identifier for the parameter |
[in] | iLength | The variation length to check, i.e. the sz attribute for the name variation in the page table XML |
[out] | oNameVariation | The name variation, if one is explicitly defined for this table type and iLength |
|
pure virtual |
Clears all name variations for the current page table type
'PgTL'
table type
|
pure virtual |
Clears all name variations for a single parameter for the current page table type
'PgTL'
table typeoNumVariations
if iParameterIdentifier
is not found[in] | iParameterIdentifier | The identifier for the parameter |
|
pure virtual |
Sets a name variation explicitly for the current page table type
This will add a new name variation or overwrite the existing name variation with the same length which is defined for the current table type.
'PgTL'
table typeiNameVariation
is empty or if iLength
is less than zero[in] | iParameterIdentifier | The identifier for the parameter |
[in] | iNameVariation | The new parameter name variation |
[in] | iLength | The length value for this name variation. This corresponds to the variation's sz attribute in the page table XML and is not required to match the length of iNameVariation . |