![]() |
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 | 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 |
Clears all parameter mappings from the table.
This method does not clear any parameter name variations from the table. For that, use AAX_IPageTable::ClearParameterNameVariations() or AAX_IPageTable::ClearNameVariationsForParameter()
|
pure virtual |
Indicates whether the table is empty.
A table is empty if it contains no pages. A table which contains pages but no parameter assignments is not empty. A table which has associated parameter name variations but no pages is empty.
[out] | oEmpty | true if this table is empty |
|
pure virtual |
Get the number of pages currently in this table.
[out] | oNumPages | The number of pages which are present in the page table. Some pages might not contain any parameter assignments. |
|
pure virtual |
Insert a new empty page before the page at index iPage
.
iPage
is greater than the total number of pages[in] | iPage | The insertion point page index |
|
pure virtual |
Remove the page at index iPage
.
iPage
is greater than the index of the last existing page[in] | iPage | The target page index |
|
pure virtual |
Returns the total number of parameter IDs which are mapped to a page.
iPage
is greater than the index of the last existing page[in] | iPage | The target page index |
[out] | oNumParameterIdentifiers | The number of parameter identifiers which are mapped to the target page |
|
pure virtual |
Clear the parameter at a particular index in this table.
[in] | iPage | The target page index |
[in] | iIndex | The target parameter slot index within the target page |
|
pure virtual |
Get the parameter identifier which is currently mapped to an index in this table.
[in] | iPage | The target page index |
[in] | iIndex | The target parameter slot index within the target page |
[out] | oParameterIdentifier | The identifier used for the mapped parameter in the page table (may be parameter name or ID) |
|
pure virtual |
Map a parameter to this table.
If iParameterIdentifier
is an empty string then the parameter assignment will be cleared
iParameterIdentifier
is nulliPage
is greater than the index of the last existing pageiIndex
is negative[in] | iParameterIdentifier | The identifier for the parameter which will be mapped |
[in] | iPage | The target page index |
[in] | iIndex | The target parameter slot index within the target page |