AAX_IPageTable.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_IPageTable_h
#define AAXLibrary_AAX_IPageTable_h
 
#include "AAX.h"
#include "AAX_IString.h"
 
class IACFUnknown;
 
 
class AAX_IPageTable
{
public:
    
    virtual ~AAX_IPageTable()   { }
    
    //
    // AAX_IACFPageTable
    //
    
    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_CPageTableParamID iParameterIdentifier, int32_t iPage, int32_t iIndex) = 0;
    
    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;
};
 
#endif