AAX_IEffectDescriptor.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_IEFFECTDESCRIPTOR_H
#define AAX_IEFFECTDESCRIPTOR_H
 
#include "AAX.h"
#include "AAX_Callbacks.h"
 
class AAX_IComponentDescriptor;
class AAX_IPropertyMap;
 
class AAX_IEffectDescriptor
{
public:
    virtual ~AAX_IEffectDescriptor() {}
    virtual AAX_IComponentDescriptor *          NewComponentDescriptor () = 0;
    virtual AAX_Result                          AddComponent ( AAX_IComponentDescriptor* inComponentDescriptor ) = 0;
    virtual AAX_Result                          AddName ( const char *inPlugInName ) = 0;
    virtual AAX_Result                          AddCategory ( uint32_t inCategory ) = 0;
    virtual AAX_Result                          AddCategoryBypassParameter ( uint32_t inCategory, AAX_CParamID inParamID ) = 0;
    virtual AAX_Result                          AddProcPtr ( void * inProcPtr, AAX_CProcPtrID inProcID ) = 0;
    virtual AAX_IPropertyMap *                  NewPropertyMap () = 0;
    virtual AAX_Result                          SetProperties ( AAX_IPropertyMap * inProperties ) = 0;
    virtual AAX_Result                          AddResourceInfo ( AAX_EResourceType inResourceType, const char * inInfo ) = 0;
    virtual AAX_Result                          AddMeterDescription( AAX_CTypeID inMeterID, const char * inMeterName, AAX_IPropertyMap * inProperties ) = 0;
    virtual AAX_Result                          AddControlMIDINode ( AAX_CTypeID inNodeID, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t inChannelMask ) = 0;
 
};
 
#endif // AAX_IEFFECTDESCRIPTOR_H