Version
menu_open
link
Wwise SDK 2023.1.1
AkVoiceCompressorFXFactory.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 // AkVoiceCompressorFXFactory.h
28 
29 /// \file
30 /// Plug-in unique ID and creation functions (hooks) necessary to register the compressor plug-in in the sound engine.
31 /// <br><b>Wwise effect name:</b> Wwise VoiceCompressor
32 /// <br><b>Library file:</b> AkVoiceCompressorFX.lib
33 
34 #ifndef _AK_VOICECOMPRESSORFXFACTORY_H_
35 #define _AK_VOICECOMPRESSORFXFACTORY_H_
36 
37 
38 
39 ///
40 /// - This is the plug-in's unique ID (combined with the AKCOMPANYID_AUDIOKINETIC company ID)
41 /// - This ID must be the same as the plug-in ID in the plug-in's XML definition file, and is persisted in project files.
42 /// \akwarning
43 /// Changing this ID will cause existing projects not to recognize the plug-in anymore.
44 /// \endakwarning
45 const unsigned long AKEFFECTID_VOICECOMPRESSOR = 147;
46 
47 /// Static creation function that returns an instance of the sound engine plug-in parameter node to be hooked by the sound engine's plug-in manager.
49  AK::IAkPluginMemAlloc * in_pAllocator ///< Memory allocator interface
50  );
51 
52 /// Static creation function that returns an instance of the sound engine plug-in to be hooked by the sound engine's plug-in manager.
54  AK::IAkPluginMemAlloc * in_pAllocator ///< Memory allocator interface
55  );
56 
57 /*
58 Use the following code to register your plug-in
59 
60 AK::SoundEngine::RegisterPlugin( AkPluginTypeMixer,
61  AKCOMPANYID_AUDIOKINETIC,
62  AKEFFECTID_VOICECOMPRESSOR,
63  CreateVoiceCompressorFX,
64  CreateVoiceCompressorFXParams );
65 */
66 
67 #endif // _AK_VOICECOMPRESSORFXFACTORY_H_
68 
#define AK_FUNC(_type, _name)
AK::IAkPluginParam * CreateVoiceCompressorFXParams(AK::IAkPluginMemAlloc *in_pAllocator)
Static creation function that returns an instance of the sound engine plug-in parameter node to be ho...
const unsigned long AKEFFECTID_VOICECOMPRESSOR
AK::IAkPlugin * CreateVoiceCompressorFX(AK::IAkPluginMemAlloc *in_pAllocator)
Static creation function that returns an instance of the sound engine plug-in to be hooked by the sou...

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise