Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2024.1.1.8691 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2024.1.1
AkSinkFactory.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 // AkSinkFactory.h
28 
29 /// \file
30 /// Plug-in unique ID and creation functions (hooks) necessary to register the mixer plug-in in the sound engine.
31 /// <br><b>Wwise effect name:</b> Sink
32 /// <br><b>Library file:</b> AkSink.lib
33 
34 #ifndef _AK_SINK_FACTORY_H_
35 #define _AK_SINK_FACTORY_H_
36 
37 
38 
39 /// \file
40 /// Registers the Audio Sink Sample plugin automatically.
41 /// This file should be included once in a .CPP (not a .h, really). The simple inclusion of this file and the linking of the library is enough to use the plugin.
42 /// <b>WARNING</b>: Include this file only if you wish to link statically with the plugins. Dynamic Libaries (DLL, so, etc) are automatically detected and do not need this include file.
43 /// <br><b>Wwise plugin name:</b> Audio Sink Sample
44 /// <br><b>Library file:</b> AkSink.lib
45 
46 const unsigned long AKEFFECTID_SINK = 152;
47 #if defined(AK_WIN)
48 AK_STATIC_LINK_PLUGIN(AkSink)
49 #endif
50 
51 #endif // _AK_SINK_FACTORY_H_
52 
AK_STATIC_LINK_PLUGIN
#define AK_STATIC_LINK_PLUGIN(_pluginName_)
Definition: IAkPlugin.h:2041
AKEFFECTID_SINK
const unsigned long AKEFFECTID_SINK
Definition: AkSinkFactory.h:46

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