Version

    Other Documentation

menu_open
Wwise SDK 2021.1.14
AK.Wwise::Plugin::V1::AudioPlugin Class Reference

Wwise API for general Audio Plug-in's backend. More...

#include <AudioPlugin.h>

Inheritance diagram for AK.Wwise::Plugin::V1::AudioPlugin:
ak_wwise_plugin_audio_plugin_instance_v1 AK.Wwise::Plugin::RequestedHostInterface< PropertySet > AK.Wwise::Plugin::RequestedHostInterface< DataWriter > ak_wwise_plugin_backend_instance AK.Wwise::Plugin::HostInterfaceGlue< PropertySet, true > AK.Wwise::Plugin::V1::Notifications::PropertySet_ AK.Wwise::Plugin::HostInterfaceGlue< DataWriter, false > ak_wwise_plugin_cpp_base_instance ak_wwise_plugin_cpp_base_instance ak_wwise_plugin_notifications_property_set_instance_v1 ak_wwise_plugin_cpp_base_instance ak_wwise_plugin_instance_ptr ak_wwise_plugin_cpp_base_instance ak_wwise_plugin_instance_ptr

Classes

struct   Interface
  The C interface, fulfilled by your plug-in. More...
 

Public Types

enum   : InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_AUDIO_PLUGIN }
  The interface type, as provided by this plug-in. More...
 
enum   : InterfaceVersion { k_interfaceVersion = 1 }
  The interface version, as provided by this plug-in. More...
 
using  Instance = CAudioPlugin::Instance
  Base instance type for providing audio plug-in backend services. More...
 
- Public Types inherited from AK.Wwise::Plugin::RequestedHostInterface< PropertySet >
using  HostInterfaceDefinition = HostInterfaceGlue< PropertySet, true >
 
- Public Types inherited from AK.Wwise::Plugin::HostInterfaceGlue< PropertySet, true >
enum  
 
enum  
 
using  GluedInterface = typename CPPInstance::GluedInterface
 
using  Instance = PropertySet
 
using  CInstance = typename CPPInstance::Instance
 
- Public Types inherited from AK.Wwise::Plugin::V1::Notifications::PropertySet_
enum   : InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_PROPERTY_SET }
  The interface type, as provided by this plug-in. More...
 
enum   : InterfaceVersion { k_interfaceVersion = 1 }
  The interface version, as provided by this plug-in. More...
 
using  Instance = CPropertySet_::Instance
  Base instance type for receiving notifications on property set's changes. More...
 
- Public Types inherited from AK.Wwise::Plugin::RequestedHostInterface< DataWriter >
using  HostInterfaceDefinition = HostInterfaceGlue< DataWriter, false >
 
- Public Types inherited from AK.Wwise::Plugin::HostInterfaceGlue< DataWriter, false >
enum  
 
enum  
 
using  GluedInterface = typename CPPInstance::GluedInterface
 
using  Instance = DataWriter
 
using  CInstance = typename CPPInstance::Instance
 

Public Member Functions

InterfacePtr  GetInterfacePointer ()
 
CAudioPlugin::Instance GetInstancePointer ()
 
const CAudioPlugin::Instance GetInstancePointer () const
 
  AudioPlugin ()
 
virtual  ~AudioPlugin ()
 
virtual bool  GetBankParameters (const GUID &in_guidPlatform, DataWriter &in_dataWriter) const
  Obtains parameters that will be written to a bank. More...
 
- Public Member Functions inherited from ak_wwise_plugin_cpp_base_instance
virtual  ~ak_wwise_plugin_cpp_base_instance ()
 
- Public Member Functions inherited from AK.Wwise::Plugin::RequestedHostInterface< PropertySet >
  RequestedHostInterface ()
 
- Public Member Functions inherited from AK.Wwise::Plugin::V1::Notifications::PropertySet_
InterfacePtr  GetInterfacePointer ()
 
CPropertySet_::Instance GetInstancePointer ()
 
const CPropertySet_::Instance GetInstancePointer () const
 
  PropertySet_ ()
 
virtual  ~PropertySet_ ()
 
virtual void  NotifyPropertyChanged (const GUID &in_guidPlatform, const char *in_pszPropertyName)
  This function is called by Wwise when a plug-in property changes. More...
 
- Public Member Functions inherited from AK.Wwise::Plugin::RequestedHostInterface< DataWriter >
  RequestedHostInterface ()
 

Additional Inherited Members

- Public Attributes inherited from AK.Wwise::Plugin::RequestedHostInterface< PropertySet >
PropertySet ::Interface g_propertySetInterface = HostInterfaceDefinition::g_cppinterface
 
HostInterfaceDefinition::Instance &  m_propertySet = *HostInterfaceDefinition::m_instance
 
- Public Attributes inherited from AK.Wwise::Plugin::RequestedHostInterface< DataWriter >
DataWriter ::Interface &  g_dataWriterInterface = HostInterfaceDefinition::g_cppinterface
 
- Static Public Attributes inherited from AK.Wwise::Plugin::HostInterfaceGlue< PropertySet, true >
static GluedInterface  g_cppinterface
  The unique interface for this plug-in interface. More...
 
- Static Public Attributes inherited from AK.Wwise::Plugin::HostInterfaceGlue< DataWriter, false >
static GluedInterface  g_cppinterface
  The unique interface for this plug-in interface. More...
 

Detailed Description


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