AAX_IPageTable.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *  Copyright 2016-2017, 2023-2024 Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  This file is part of the Avid AAX SDK.
 *  
 *  The AAX SDK is subject to commercial or open-source licensing.
 *  
 *  By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
 *  Agreement and Avid Privacy Policy.
 *  
 *  AAX SDK License: https://developer.avid.com/aax
 *  Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
 *  
 *  Or: You may also use this code under the terms of the GPL v3 (see
 *  www.gnu.org/licenses).
 *  
 *  THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
 *  EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
 *  DISCLAIMED.
 */
 
#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