AAX_IACFPageTable.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *  Copyright 2016-2017, 2023 Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  CONFIDENTIAL: this document contains confidential information of Avid. Do
 *  not disclose to any third party. Use of the information contained in this
 *  document is subject to an Avid SDK license.
 */
 
#ifndef AAXLibrary_AAX_IACFPageTable_h
#define AAXLibrary_AAX_IACFPageTable_h
 
// AAX Includes
#include "AAX.h"
 
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
#endif
 
// ACF Includes
#include "acfunknown.h"
 
// Forward declarations
class AAX_IString;
 
class AAX_IACFPageTable : public IACFUnknown
{
public:
    virtual AAX_Result Clear() = 0; 
    virtual AAX_Result Empty(AAX_CBoolean& oEmpty) const = 0; 
    virtual AAX_Result GetNumPages(int32_t& oNumPages) const = 0; 
    virtual AAX_Result InsertPage(int32_t iPage) = 0; 
    virtual AAX_Result RemovePage(int32_t iPage) = 0; 
    virtual AAX_Result GetNumMappedParameterIDs(int32_t iPage, int32_t& oNumParameterIdentifiers) const = 0; 
    virtual AAX_Result ClearMappedParameter(int32_t iPage, int32_t iIndex) = 0; 
    virtual AAX_Result GetMappedParameterID(int32_t iPage, int32_t iIndex, AAX_IString& oParameterIdentifier) const = 0; 
    virtual AAX_Result MapParameterID(AAX_CParamID iParameterIdentifier, int32_t iPage, int32_t iIndex) = 0; 
};
 
class AAX_IACFPageTable_V2 : public AAX_IACFPageTable
{
public:
    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; 
};
 
#ifdef __clang__
#pragma clang diagnostic pop
#endif
 
 
#endif // AAXLibrary_AAX_IACFPageTable_h