AAX_IEffectDescriptor.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013 by Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  CONFIDENTIAL: This document contains confidential information.  Do not 
 *  read or examine this document unless you are an Avid Technology employee
 *  or have signed a non-disclosure agreement with Avid Technology which protects
 *  the confidentiality of this document.  DO NOT DISCLOSE ANY INFORMATION 
 *  CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT 
 *  OF Avid Technolgy, INC.
 *
 */

/*================================================================================================*/


#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* iComponentDescriptor ) = 0;
    virtual AAX_Result                          AddName ( const char *iPlugInName ) = 0;
    virtual AAX_Result                          AddCategory ( uint32_t iCategory ) = 0;
    virtual AAX_Result                          AddCategoryBypassParameter ( uint32_t iCategory, AAX_CParamID iParamID ) = 0;
    virtual AAX_Result                          AddProcPtr ( void * iProcPtr, AAX_CProcPtrID iProcID ) = 0;
    virtual AAX_IPropertyMap *                  NewPropertyMap () = 0;
    virtual AAX_Result                          SetProperties ( AAX_IPropertyMap * iProperties ) = 0;
    virtual AAX_Result                          AddResourceInfo ( AAX_EResourceType iResourceType, const char * iInfo ) = 0;
    virtual AAX_Result                          AddMeterDescription( AAX_CTypeID iMeterID, const char * iMeterName, AAX_IPropertyMap * iProperties ) = 0;
    virtual AAX_Result                          AddControlMIDINode ( AAX_CTypeID iNodeID, AAX_EMIDINodeType iNodeType, const char iNodeName[], uint32_t iChannelMask ) = 0;

};

#endif // AAX_IEFFECTDESCRIPTOR_H