| 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_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"
27#include "AAX_VDescriptionHost.h"
28#include "acfunknown.h"
29#include "ACFPtr.h"
30#include <set>
31
32 class IACFUnknown;
33 class IACFPluginDefinition;
34 class AAX_IACFCollection;
35 class AAX_IEffectDescriptor;
36
41 class AAX_VCollection : public AAX_ICollection
42{
43 public:
44 AAX_VCollection (IACFUnknown * pUnkHost);
45 ~AAX_VCollection () AAX_OVERRIDE;
46
51 AAX_IEffectDescriptor * NewDescriptor () AAX_OVERRIDE;
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;
55 AAX_Result SetPackageVersion( uint32_t inVersion ) AAX_OVERRIDE;
56 AAX_IPropertyMap * NewPropertyMap () AAX_OVERRIDE;
57 AAX_Result SetProperties ( AAX_IPropertyMap * inProperties ) AAX_OVERRIDE;
58
59 AAX_IDescriptionHost* DescriptionHost() AAX_OVERRIDE;
60 const AAX_IDescriptionHost* DescriptionHost() const AAX_OVERRIDE;
61 IACFDefinition* HostDefinition() const AAX_OVERRIDE;
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
AAX_IACFCollection.h
Versioned interface to represent a plug-in binary's static description.
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
AAX_OVERRIDE
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:151
AAX_VDescriptionHost.h
AAX_ICollection.h
Interface to represent a plug-in binary's static description.
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:252
IACFDefinition
Publicly inherits from IACFUnknown.This abstract interface is used to indentify all of the plug-in co...
Definition: AAX_ACFInterface.doxygen:301
AAX_IACFCollection
Versioned interface to represent a plug-in binary's static description.
Definition: AAX_IACFCollection.h:37
AAX_ICollection
Interface to represent a plug-in binary's static description.
Definition: AAX_ICollection.h:51
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
AAX_VCollection
Version-managed concrete AAX_ICollection class.
Definition: AAX_VCollection.h:42
AAX_VCollection::SetProperties
AAX_Result SetProperties(AAX_IPropertyMap *inProperties) AAX_OVERRIDE
Set the properties of the collection.
AAX_VCollection::~AAX_VCollection
~AAX_VCollection() AAX_OVERRIDE
AAX_VCollection::AddPackageName
AAX_Result AddPackageName(const char *inPackageName) AAX_OVERRIDE
Set the plug-in package name.
AAX_VCollection::AddEffect
AAX_Result AddEffect(const char *inEffectID, AAX_IEffectDescriptor *inEffectDescriptor) AAX_OVERRIDE
Add an Effect description to the collection.
AAX_VCollection::SetManufacturerName
AAX_Result SetManufacturerName(const char *inPackageName) AAX_OVERRIDE
Set the plug-in manufacturer name.
AAX_VCollection::NewDescriptor
AAX_IEffectDescriptor * NewDescriptor() AAX_OVERRIDE
Create a new Effect descriptor.
AAX_VCollection::AAX_VCollection
AAX_VCollection(IACFUnknown *pUnkHost)
AAX_VCollection::NewPropertyMap
AAX_IPropertyMap * NewPropertyMap() AAX_OVERRIDE
Create a new property map.
AAX_VCollection::SetPackageVersion
AAX_Result SetPackageVersion(uint32_t inVersion) AAX_OVERRIDE
Set the plug-in package version number.
AAX_VCollection::GetIUnknown
IACFPluginDefinition * GetIUnknown(void) const
AAX_VCollection::DescriptionHost
AAX_IDescriptionHost * DescriptionHost() AAX_OVERRIDE
AAX_VCollection::HostDefinition
IACFDefinition * HostDefinition() const AAX_OVERRIDE
AAX_VDescriptionHost
Definition: AAX_VDescriptionHost.h:30