AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_ICollection.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2013-2017, 2019 by Avid Technology, Inc.
5  * All rights reserved.
6  *
7  * CONFIDENTIAL: This document contains confidential information. Do not
8  * read or examine this document unless you are an Avid Technology employee
9  * or have signed a non-disclosure agreement with Avid Technology which protects
10  * the confidentiality of this document. DO NOT DISCLOSE ANY INFORMATION
11  * CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT
12  * OF Avid Technology, INC.
13  *
14  */
15 
22 /*================================================================================================*/
23 
24 
25 #ifndef AAX_ICOLLECTION_H
26 #define AAX_ICOLLECTION_H
27 
28 #include "AAX.h"
29 
31 class AAX_IPropertyMap;
33 class IACFDefinition;
34 
54 {
55 public:
56  virtual ~AAX_ICollection() {}
57 
58 public: // AAX_IACFCollection
59 
64 
86  virtual AAX_Result AddEffect ( const char * inEffectID, AAX_IEffectDescriptor* inEffectDescriptor ) = 0;
87 
94  virtual AAX_Result SetManufacturerName( const char* inPackageName ) = 0;
106  virtual AAX_Result AddPackageName( const char *inPackageName ) = 0;
113  virtual AAX_Result SetPackageVersion( uint32_t inVersion ) = 0;
126  virtual AAX_Result SetProperties ( AAX_IPropertyMap * inProperties ) = 0;
127 
128 public: // AAX_ICollection
129 
138  virtual const AAX_IDescriptionHost* DescriptionHost() const = 0;
139 
151  virtual IACFDefinition* HostDefinition() const = 0;
152 
153 };
154 
155 #endif
Various utility definitions for AAX.
int32_t AAX_Result
Definition: AAX.h:337
Publicly inherits from IACFUnknown.This abstract interface is used to indentify all of the plug-in co...
Definition: AAX_ACFInterface.doxygen:297
Interface to represent a plug-in binary's static description.
Definition: AAX_ICollection.h:54
virtual AAX_Result SetProperties(AAX_IPropertyMap *inProperties)=0
Set the properties of the collection.
virtual const AAX_IDescriptionHost * DescriptionHost() const =0
virtual AAX_Result SetPackageVersion(uint32_t inVersion)=0
Set the plug-in package version number.
virtual AAX_Result AddEffect(const char *inEffectID, AAX_IEffectDescriptor *inEffectDescriptor)=0
Add an Effect description to the collection.
virtual AAX_IPropertyMap * NewPropertyMap()=0
Create a new property map.
virtual AAX_Result SetManufacturerName(const char *inPackageName)=0
Set the plug-in manufacturer name.
virtual ~AAX_ICollection()
Definition: AAX_ICollection.h:56
virtual IACFDefinition * HostDefinition() const =0
virtual AAX_Result AddPackageName(const char *inPackageName)=0
Set the plug-in package name.
virtual AAX_IDescriptionHost * DescriptionHost()=0
virtual AAX_IEffectDescriptor * NewDescriptor()=0
Create a new Effect descriptor.
Definition: AAX_IDescriptionHost.h:25
Description interface for an effect's (plug-in type's) components.
Definition: AAX_IEffectDescriptor.h:50
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:59