AAX SDK 2.6.1
Avid Audio Extensions Development Kit
Loading...
Searching...
No Matches
AAX_VCollection.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#ifndef AAX_VCOLLECTION_H
22#define AAX_VCOLLECTION_H
23
24#include "AAX.h"
25#include "AAX_ICollection.h"
26#include "AAX_IACFCollection.h"
28#include "acfunknown.h"
29#include "ACFPtr.h"
30#include <set>
31
32class IACFUnknown;
33class IACFPluginDefinition;
36
42{
43public:
46
52 AAX_Result AddEffect ( const char * inEffectID, AAX_IEffectDescriptor * inEffectDescriptor ) AAX_OVERRIDE;
53 AAX_Result SetManufacturerName( const char* inPackageName ) AAX_OVERRIDE;
54 AAX_Result AddPackageName( const char *inPackageName ) AAX_OVERRIDE;
58
62
63 IACFPluginDefinition* GetIUnknown(void) const;
64
65private:
66 ACFPtr<IACFUnknown> mUnkHost;
67 ACFPtr<AAX_IACFCollection> mIACFCollection;
68 AAX_VDescriptionHost mDescriptionHost;
69 std::set<AAX_IEffectDescriptor *> mEffectDescriptors;
70 std::set<AAX_IPropertyMap *> mPropertyMaps;
71};
72
73#endif
Versioned interface to represent a plug-in binary's static description.
Various utility definitions for AAX.
int32_t AAX_Result
Definition: AAX.h:334
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:151
Interface to represent a plug-in binary's static description.
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:252
Publicly inherits from IACFUnknown.This abstract interface is used to indentify all of the plug-in co...
Definition: AAX_ACFInterface.doxygen:301
Versioned interface to represent a plug-in binary's static description.
Definition: AAX_IACFCollection.h:37
Interface to represent a plug-in binary's static description.
Definition: AAX_ICollection.h:51
Definition: AAX_IDescriptionHost.h:22
Description interface for an effect's (plug-in type's) components.
Definition: AAX_IEffectDescriptor.h:47
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:56
Version-managed concrete AAX_ICollection class.
Definition: AAX_VCollection.h:42
AAX_Result SetProperties(AAX_IPropertyMap *inProperties) AAX_OVERRIDE
Set the properties of the collection.
~AAX_VCollection() AAX_OVERRIDE
AAX_Result AddPackageName(const char *inPackageName) AAX_OVERRIDE
Set the plug-in package name.
AAX_Result AddEffect(const char *inEffectID, AAX_IEffectDescriptor *inEffectDescriptor) AAX_OVERRIDE
Add an Effect description to the collection.
AAX_Result SetManufacturerName(const char *inPackageName) AAX_OVERRIDE
Set the plug-in manufacturer name.
AAX_IEffectDescriptor * NewDescriptor() AAX_OVERRIDE
Create a new Effect descriptor.
AAX_VCollection(IACFUnknown *pUnkHost)
AAX_IPropertyMap * NewPropertyMap() AAX_OVERRIDE
Create a new property map.
AAX_Result SetPackageVersion(uint32_t inVersion) AAX_OVERRIDE
Set the plug-in package version number.
IACFPluginDefinition * GetIUnknown(void) const
AAX_IDescriptionHost * DescriptionHost() AAX_OVERRIDE
IACFDefinition * HostDefinition() const AAX_OVERRIDE
Definition: AAX_VDescriptionHost.h:30