AAX_IPropertyMap.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013-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 AAX_IPROPERTYMAP_H
#define AAX_IPROPERTYMAP_H
 
#include "AAX_Properties.h"
#include "AAX.h"
 
class IACFUnknown;
 
class AAX_IPropertyMap 
{
public:
    virtual ~AAX_IPropertyMap() {}
    
    
    //
    // AAX_IACFPropertyMap methods
    //
    
    virtual AAX_CBoolean        GetProperty ( AAX_EProperty inProperty, AAX_CPropertyValue * outValue ) const = 0;
    virtual AAX_CBoolean        GetPointerProperty ( AAX_EProperty inProperty, const void** outValue ) const = 0;
    virtual AAX_Result          AddProperty ( AAX_EProperty inProperty, AAX_CPropertyValue inValue ) = 0;
    virtual AAX_Result          AddPointerProperty ( AAX_EProperty inProperty, const void* inValue ) = 0;
    virtual AAX_Result          AddPointerProperty ( AAX_EProperty inProperty, const char* inValue ) = 0; 
    virtual AAX_Result          RemoveProperty ( AAX_EProperty inProperty ) = 0;
    
    virtual AAX_Result          AddPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad* inPluginIDs, uint32_t inNumPluginIDs) = 0;
    
    virtual AAX_CBoolean        GetPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad** outPluginIDs, uint32_t* outNumPluginIDs) const = 0;
    
    
    //
    // AAX_IPropertyMap methods
    //
    
    virtual IACFUnknown*        GetIUnknown() = 0;
};
 
#endif // AAX_IPROPERTYMAP_H