Version

menu_open

include/AK/SoundEngine/Common/IAkPlugin.h File Reference

Go to the source code of this file.

Classes

struct   AkPluginInfo
class   AK::IAkGameObjectPluginInfo
  Game object information available to plugins. More...
class   AK::IAkVoicePluginInfo
class   AK::IAkPluginContextBase
  Interface to retrieve contextual information available to all types of plugins. More...
class   AK::IAkEffectPluginContext
class   AK::IAkSourcePluginContext
class   AK::IAkMixerPluginContext
  Interface to retrieve contextual information for a mixer. More...
class   AK::IAkPluginParam
class   AK::IAkPlugin
class   AK::IAkEffectPlugin
  Software effect plug-in interface (see How to Create Wwise Sound Engine Effect Plug-ins). More...
class   AK::IAkInPlaceEffectPlugin
  Software effect plug-in interface for in-place processing (see How to Create Wwise Sound Engine Effect Plug-ins). More...
class   AK::IAkOutOfPlaceEffectPlugin
  Software effect plug-in interface for out-of-place processing (see How to Create Wwise Sound Engine Effect Plug-ins). More...
class   AK::IAkMixerInputContext
  Interface to retrieve information about an input of a mixer. More...
class   AK::IAkSinkPluginContext
class   AK::IAkSinkPlugin
  Software effect plug-in interface for sink (audio end point) plugins. More...
class   AK::IAkSourcePlugin
  Wwise sound engine source plug-in interface (see How to Create Wwise Sound Engine Source Plug-ins). More...
class   AK::IAkGlobalPluginContext
  Global plugin context used for plugin registration/initialization. Games query this interface from the sound engine. More...
class   AK::PluginRegistration

Namespaces

namespace   AK
 

Audiokinetic namespace.


Defines

#define  AK_OLDEST_SUPPORTED_WWISESDK_VERSION   ((2016<<8) | 1)
#define  AK_FLOAT_TO_SAMPLETYPE(__in__)   (__in__)
  This function can be useful to convert from normalized floating point audio samples to Wii-pipeline format samples.
#define  AK_FLOAT_TO_SAMPLETYPE_NOCLIP(__in__)   (__in__)
  This function can be useful to convert from normalized floating point audio samples to Wii-pipeline format samples when the input is not not to exceed (-1,1) range.
#define  AK_SAMPLETYPE_TO_FLOAT(__in__)   (__in__)
  This function can be useful to convert from Wii-pipeline format samples to normalized floating point audio samples.
#define  AK_DBTOLIN(__db__)   (powf(10.f,(__db__) * 0.05f))
#define  AK_IMPLEMENT_PLUGIN_FACTORY(_pluginName_, _plugintype_, _companyid_, _pluginid_)
#define  AK_STATIC_LINK_PLUGIN(_pluginName_)
#define  DEFINE_PLUGIN_REGISTER_HOOK   AK_DLLEXPORT AK::PluginRegistration * g_pAKPluginList = NULL;

Typedefs

typedef AK::IAkPlugin *(*  AkCreatePluginCallback )(AK::IAkPluginMemAlloc *in_pAllocator)
  Registered plugin creation function prototype.
typedef AK::IAkPluginParam *(*  AkCreateParamCallback )(AK::IAkPluginMemAlloc *in_pAllocator)
  Registered plugin parameter node creation function prototype.

Enumerations

enum   AkPluginType {
  AkPluginTypeNone = 0, AkPluginTypeCodec = 1, AkPluginTypeSource = 2, AkPluginTypeEffect = 3,
  AkPluginTypeMotionDevice = 4, AkPluginTypeMotionSource = 5, AkPluginTypeMixer = 6, AkPluginTypeSink = 7,
  AkPluginTypeMask = 0xf
}

Variables

AK_DLLEXPORT
AK::PluginRegistration
g_pAKPluginList

Detailed Description

Software source plug-in and effect plug-in interfaces.

Definition in file IAkPlugin.h.


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