| AAX SDK 2.8.0 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-2024 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * This file is part of the Avid AAX SDK.
8 *
9 * The AAX SDK is subject to commercial or open-source licensing.
10 *
11 * By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
12 * Agreement and Avid Privacy Policy.
13 *
14 * AAX SDK License: https://developer.avid.com/aax
15 * Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
16 *
17 * Or: You may also use this code under the terms of the GPL v3 (see
18 * www.gnu.org/licenses).
19 *
20 * THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
21 * EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
22 * DISCLAIMED.
23 *
24 */
25
32/*================================================================================================*/
33
34
35#ifndef AAX_ICOLLECTION_H
36#define AAX_ICOLLECTION_H
37
38#include "AAX.h"
39
40 class AAX_IEffectDescriptor;
41 class AAX_IPropertyMap;
42 class AAX_IDescriptionHost;
43 class IACFDefinition;
44
63 class AAX_ICollection
64{
65 public:
66 virtual ~AAX_ICollection() {}
67
68 public: // AAX_IACFCollection
69
73 virtual AAX_IEffectDescriptor * NewDescriptor () = 0;
74
96 virtual AAX_Result AddEffect ( const char * inEffectID, AAX_IEffectDescriptor* inEffectDescriptor ) = 0;
97
104 virtual AAX_Result SetManufacturerName( const char* inPackageName ) = 0;
116 virtual AAX_Result AddPackageName( const char *inPackageName ) = 0;
123 virtual AAX_Result SetPackageVersion( uint32_t inVersion ) = 0;
128 virtual AAX_IPropertyMap * NewPropertyMap () = 0;
136 virtual AAX_Result SetProperties ( AAX_IPropertyMap * inProperties ) = 0;
137
149 virtual AAX_Result GetHostVersion(uint32_t* outVersion) const = 0;
150
151 public: // AAX_ICollection
152
160 virtual AAX_IDescriptionHost* DescriptionHost() = 0;
161 virtual const AAX_IDescriptionHost* DescriptionHost() const = 0;
162
174 virtual IACFDefinition* HostDefinition() const = 0;
175};
176
177#endif
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
IACFDefinition
Publicly inherits from IACFUnknown.This abstract interface is used to indentify all of the plug-in co...
Definition: AAX_ACFInterface.doxygen:314
AAX_ICollection
Interface to represent a plug-in binary's static description.
Definition: AAX_ICollection.h:64
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:66
AAX_ICollection::GetHostVersion
virtual AAX_Result GetHostVersion(uint32_t *outVersion) const =0
Get the current version of the host.
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:35
AAX_IEffectDescriptor
Description interface for an effect's (plug-in type's) components.
Definition: AAX_IEffectDescriptor.h:60
AAX_IPropertyMap
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:69