| AAX SDK 2.6.1 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- File List
- File Members

Loading...
Searching...
No Matches
AAX_ICollection.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 2019, 2023 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * CONFIDENTIAL: this document contains confidential information of Avid. Do
8 * not disclose to any third party. Use of the information contained in this
9 * document is subject to an Avid SDK license.
10 *
11 */
12
19/*================================================================================================*/
20
21
22#ifndef AAX_ICOLLECTION_H
23#define AAX_ICOLLECTION_H
24
25#include "AAX.h"
26
27 class AAX_IEffectDescriptor;
28 class AAX_IPropertyMap;
29 class AAX_IDescriptionHost;
30 class IACFDefinition;
31
50 class AAX_ICollection
51{
52 public:
53 virtual ~AAX_ICollection() {}
54
55 public: // AAX_IACFCollection
56
60 virtual AAX_IEffectDescriptor * NewDescriptor () = 0;
61
83 virtual AAX_Result AddEffect ( const char * inEffectID, AAX_IEffectDescriptor* inEffectDescriptor ) = 0;
84
91 virtual AAX_Result SetManufacturerName( const char* inPackageName ) = 0;
103 virtual AAX_Result AddPackageName( const char *inPackageName ) = 0;
110 virtual AAX_Result SetPackageVersion( uint32_t inVersion ) = 0;
115 virtual AAX_IPropertyMap * NewPropertyMap () = 0;
123 virtual AAX_Result SetProperties ( AAX_IPropertyMap * inProperties ) = 0;
124
125 public: // AAX_ICollection
126
134 virtual AAX_IDescriptionHost* DescriptionHost() = 0;
135 virtual const AAX_IDescriptionHost* DescriptionHost() const = 0;
136
148 virtual IACFDefinition* HostDefinition() const = 0;
149
150};
151
152#endif
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
IACFDefinition
Publicly inherits from IACFUnknown.This abstract interface is used to indentify all of the plug-in co...
Definition: AAX_ACFInterface.doxygen:301
AAX_ICollection
Interface to represent a plug-in binary's static description.
Definition: AAX_ICollection.h:51
AAX_ICollection::SetProperties
virtual AAX_Result SetProperties(AAX_IPropertyMap *inProperties)=0
Set the properties of the collection.
AAX_ICollection::HostDefinition
virtual IACFDefinition * HostDefinition() const =0
AAX_ICollection::SetPackageVersion
virtual AAX_Result SetPackageVersion(uint32_t inVersion)=0
Set the plug-in package version number.
AAX_ICollection::AddEffect
virtual AAX_Result AddEffect(const char *inEffectID, AAX_IEffectDescriptor *inEffectDescriptor)=0
Add an Effect description to the collection.
AAX_ICollection::NewDescriptor
virtual AAX_IEffectDescriptor * NewDescriptor()=0
Create a new Effect descriptor.
AAX_ICollection::SetManufacturerName
virtual AAX_Result SetManufacturerName(const char *inPackageName)=0
Set the plug-in manufacturer name.
AAX_ICollection::DescriptionHost
virtual AAX_IDescriptionHost * DescriptionHost()=0
AAX_ICollection::DescriptionHost
virtual const AAX_IDescriptionHost * DescriptionHost() const =0
AAX_ICollection::~AAX_ICollection
virtual ~AAX_ICollection()
Definition: AAX_ICollection.h:53
AAX_ICollection::NewPropertyMap
virtual AAX_IPropertyMap * NewPropertyMap()=0
Create a new property map.
AAX_ICollection::AddPackageName
virtual AAX_Result AddPackageName(const char *inPackageName)=0
Set the plug-in package name.
AAX_IDescriptionHost
Definition: AAX_IDescriptionHost.h:22
AAX_IEffectDescriptor
Description interface for an effect's (plug-in type's) components.
Definition: AAX_IEffectDescriptor.h:47
AAX_IPropertyMap
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:56