AAX SDK  2.4.1
Avid Audio Extensions Development Kit
List of all members | Public Member Functions
AAX_IACFPageTableController Class Referenceabstract

#include <AAX_IACFPageTableController.h>

Inheritance diagram for AAX_IACFPageTableController:
[legend]
Collaboration diagram for AAX_IACFPageTableController:
[legend]

Description

Interface for host operations related to the page tables for this plug-in.

Note
In the AAX Library, access to this interface is provided through AAX_IController

Public Member Functions

virtual AAX_Result CopyTableForEffect (AAX_CPropertyValue inManufacturerID, AAX_CPropertyValue inProductID, AAX_CPropertyValue inPlugInID, uint32_t inTableType, int32_t inTablePageSize, IACFUnknown *oPageTable) const =0
 
virtual AAX_Result CopyTableOfLayoutForEffect (const char *inEffectID, const char *inLayoutName, uint32_t inTableType, int32_t inTablePageSize, IACFUnknown *oPageTable) const =0
 
- Public Member Functions inherited from IACFUnknown
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...
 

Member Function Documentation

◆ CopyTableForEffect()

virtual AAX_Result AAX_IACFPageTableController::CopyTableForEffect ( AAX_CPropertyValue  inManufacturerID,
AAX_CPropertyValue  inProductID,
AAX_CPropertyValue  inPlugInID,
uint32_t  inTableType,
int32_t  inTablePageSize,
IACFUnknown oPageTable 
) const
pure virtual

Copy the current page table data for a particular plug-in type.

The host will reject the copy and return an error if the requested plug-in type is unkown, if inTableType is unknown or if inTablePageSize is not a supported size for the given table type.

The host may also restrict plug-ins to only copying page table data from certain plug-in types, such as plug-ins from the same manufacturer or plug-in types within the same effect.

See Page Table Guide for more information about page tables.

Returns
AAX_ERROR_NULL_ARGUMENT if oPageTable is null
AAX_ERROR_INVALID_ARGUMENT if no valid page table mapping can be created due to the specified arguments
Parameters
[in]inManufacturerIDManufacturer ID of the desired plug-in type
[in]inProductIDProduct ID of the desired plug-in type
[in]inPlugInIDType ID of the desired plug-in type (AAX_eProperty_PlugInID_Native, AAX_eProperty_PlugInID_TI)
[in]inTableTypeFour-char type identifier for the requested table type (e.g. 'PgTL', 'Av81', etc.)
[in]inTablePageSizePage size for the requested table. Some tables support multiple page sizes.
[out]oPageTableThe page table object to which the page table data should be copied. oPageTable must support AAX_IACFPageTable
See also
AAX_IController::CreateTableCopyForEffect()

◆ CopyTableOfLayoutForEffect()

virtual AAX_Result AAX_IACFPageTableController::CopyTableOfLayoutForEffect ( const char *  inEffectID,
const char *  inLayoutName,
uint32_t  inTableType,
int32_t  inTablePageSize,
IACFUnknown oPageTable 
) const
pure virtual

Copy the current page table data for a particular plug-in effect and page table layout.

The host will reject the copy and return an error if the requested effect ID is unkown or if inLayoutName is not a valid layout name for the page tables registered for the effect.

The host may also restrict plug-ins to only copying page table data from certain effects, such as effects registered within the current AAX plug-in bundle.

See Page Table Guide for more information about page tables.

Returns
AAX_ERROR_NULL_ARGUMENT if inEffectID, inLayoutName, or oPageTable is null
AAX_ERROR_INVALID_ARGUMENT if no valid page table mapping can be created due to the specified arguments
Parameters
[in]inEffectIDEffect ID for the desired effect. See AAX_ICollection::AddEffect()
[in]inLayoutNamePage table layout name ("name" attribute of the PTLayout XML tag)
[in]inTableTypeFour-char type identifier for the requested table type (e.g. 'PgTL', 'Av81', etc.)
[in]inTablePageSizePage size for the requested table. Some tables support multiple page sizes.
[out]oPageTableThe page table object to which the page table data should be copied. oPageTable must support AAX_IACFPageTable
See also
AAX_IController::CreateTableCopyForLayout()

The documentation for this class was generated from the following file: