Version
arrow_right Table of Contents

Other Documentation

Wwise SDK 2021.1.11

Classes

struct   ak_wwise_plugin_interface_ptr
  Interface description and base class for every Wwise Authoring plug-in interface. More...
 
struct   ak_wwise_plugin_instance_ptr
  Generic base for all plug-in instances. In C++, this is derived. In C, they are equivalent. More...
 
struct   ak_wwise_plugin_cpp_base_instance
  Generic base for all plug-in instances in C++. More...
 
struct   ak_wwise_plugin_backend_instance
  Plug-in backend instance. More...
 
struct   ak_wwise_plugin_frontend_instance
  Plug-in frontend instance. More...
 
struct   ak_wwise_plugin_host_instance_v1
  Base host-provided instance type for ak_wwise_plugin_host_v1. More...
 
struct   ak_wwise_plugin_host_conversion_helpers_instance_v1
  Base host-provided instance type for ak_wwise_plugin_host_conversion_helpers_v1. More...
 
struct   ak_wwise_plugin_host_data_writer_instance_v1
  Base host-provided instance type for ak_wwise_plugin_host_data_writer_v1. More...
 
struct   ak_wwise_plugin_host_object_media_instance_v1
  Base host-provided instance type for ak_wwise_plugin_host_object_media_v1. More...
 
struct   ak_wwise_plugin_host_object_store_instance_v1
  Base host-provided instance type for ak_wwise_plugin_host_object_store_v1. More...
 
struct   ak_wwise_plugin_host_property_set_instance_v1
  Base host-provided instance type for ak_wwise_plugin_host_property_set_v1. More...
 
struct   ak_wwise_plugin_host_undo_manager_instance_v1
  Base host-provided instance type for ak_wwise_plugin_host_undo_manager_v1. More...
 
struct   ak_wwise_plugin_host_xml_reader_instance_v1
  Base host-provided instance type for reading XML files through ak_wwise_plugin_host_xml_v1. More...
 
struct   ak_wwise_plugin_host_xml_writer_instance_v1
  Base host-provided instance type for writing XML files through ak_wwise_plugin_host_xml_v1. More...
 
struct   ak_wwise_plugin_analysis_task_instance_v1
  Base instance type for providing analysis task services through ak_wwise_plugin_analysis_task_v1. More...
 
struct   ak_wwise_plugin_audio_plugin_instance_v1
  Base instance type for providing audio plug-in backend services through ak_wwise_plugin_audio_plugin_v1. More...
 
struct   ak_wwise_plugin_conversion_instance_v1
  Base instance type for providing a conversion plug-in through ak_wwise_plugin_conversion_v1. More...
 
struct   ak_wwise_plugin_custom_data_instance_v1
  Base instance type for providing custom data loading and saving through ak_wwise_plugin_custom_data_v1. More...
 
struct   ak_wwise_plugin_property_display_name_instance_v1
  Base instance type for providing display names to properties through ak_wwise_plugin_property_display_name_v1. More...
 
struct   ak_wwise_plugin_feedback_aware_instance_v1
  Base instance type for providing property-based feedback through ak_wwise_plugin_feedback_aware_v1. More...
 
struct   ak_wwise_plugin_gui_conversion_windows_instance_v1
  Base instance type for providing a Windows frontend for a conversion plug-in through ak_wwise_plugin_gui_conversion_windows_v1. More...
 
struct   ak_wwise_plugin_gui_windows_instance_v1
  Base instance type for providing a Windows frontend for an audio plug-in through ak_wwise_plugin_gui_windows_v1. More...
 
struct   ak_wwise_plugin_link_backend_instance_v1
  Base host-provided instance to retrieve the related backend instance, as shown in the frontend. More...
 
struct   ak_wwise_plugin_link_frontend_instance_v1
  Base host-provided instance to retrieve the related frontend instances related to the current backend. More...
 
struct   ak_wwise_plugin_media_converter_instance_v1
  Base instance type for providing custom media conversion through ak_wwise_plugin_media_converter_v1. More...
 
struct   ak_wwise_plugin_notifications_host_instance_v1
  Base instance type for receiving notifications on host changes events. More...
 
struct   ak_wwise_plugin_notifications_monitor_instance_v1
  Base instance type for receiving Sound Engine's monitoring data. More...
 
struct   ak_wwise_plugin_notifications_object_media_instance_v1
  Base instance type for receiving notifications on related object media's changes. More...
 
struct   ak_wwise_plugin_notifications_object_store_instance_v1
  Base instance type for receiving notifications on related Object Store's changes. More...
 
struct   ak_wwise_plugin_notifications_property_set_instance_v1
  Base instance type for receiving notifications on property set's changes. More...
 
struct   ak_wwise_plugin_source_instance_v1
  Base instance type for providing source-specific information, through ak_wwise_plugin_source_v1. More...
 
struct   ak_wwise_plugin_undo_event_instance_v1
  Base instance type for providing custom undo operations through ak_wwise_plugin_undo_event_v1. More...
 
struct   ak_wwise_plugin_license_instance_v1
  Base instance type for providing licensing information, through ak_wwise_plugin_license_v1. More...
 
struct   ak_wwise_plugin_first_time_creation_message_instance_v1
  Base instance type for providing a message shown the first time an instance is created through ak_wwise_plugin_first_time_creation_message_v1. More...
 
struct   ak_wwise_plugin_sink_devices_instance_v1
  Base instance type for providing a device list for your custom sink through ak_wwise_plugin_sink_devices_v1. More...
 
struct   ak_wwise_plugin_test_service_instance_v1
 
struct   ak_wwise_plugin_test_service_instance_v2
 
struct   ak_wwise_plugin_undo_event_pair_v1
  A definition of an undo event, with a specific interface and instance. More...
 

Macros

#define  AK_WWISE_PLUGIN_BASE_INTERFACE_FROM_ID(in_interface, in_version)
 
#define  AK_WWISE_PLUGIN_DERIVE_FROM_INSTANCE_BASE   : public ak_wwise_plugin_cpp_base_instance
  Define a generic instance base, either in C or in C++. More...
 
#define  AK_WWISE_PLUGIN_DERIVE_FROM_BACKEND_INSTANCE(x)    struct x : public ak_wwise_plugin_backend_instance {}
  Define an instance type as a backend. More...
 
#define  AK_WWISE_PLUGIN_DERIVE_FROM_FRONTEND_INSTANCE(x)    struct x : public ak_wwise_plugin_frontend_instance {}
  Define an instance type as a frontend. More...
 

Typedefs

typedef int  ak_wwise_plugin_undo_group_id
  Unique identifier for a particular undo group. Useful to reopen an unapplied closed group session. More...
 

Enumerations

enum   ak_wwise_plugin_interface_type {
  AK_WWISE_PLUGIN_INTERFACE_TYPE_UNKNOWN, AK_WWISE_PLUGIN_INTERFACE_TYPE_PLUGIN_CONTAINER, AK_WWISE_PLUGIN_INTERFACE_TYPE_ANALYSIS_TASK, AK_WWISE_PLUGIN_INTERFACE_TYPE_AUDIO_PLUGIN,
  AK_WWISE_PLUGIN_INTERFACE_TYPE_CONVERSION, AK_WWISE_PLUGIN_INTERFACE_TYPE_CUSTOM_DATA, AK_WWISE_PLUGIN_INTERFACE_TYPE_FEEDBACK_AWARE, AK_WWISE_PLUGIN_INTERFACE_TYPE_FIRST_TIME_CREATION_MESSAGE,
  AK_WWISE_PLUGIN_INTERFACE_TYPE_LICENSE, AK_WWISE_PLUGIN_INTERFACE_TYPE_MEDIA_CONVERTER, AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_HOST, AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_MONITOR,
  AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_OBJECT_MEDIA, AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_OBJECT_STORE, AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_PROPERTY_SET, AK_WWISE_PLUGIN_INTERFACE_TYPE_PROPERTY_DISPLAY_NAME,
  AK_WWISE_PLUGIN_INTERFACE_TYPE_SINK_DEVICES, AK_WWISE_PLUGIN_INTERFACE_TYPE_SOURCE, AK_WWISE_PLUGIN_INTERFACE_TYPE_UNDO_EVENT, AK_WWISE_PLUGIN_INTERFACE_TYPE_GUI_CONVERSION_WINDOWS,
  AK_WWISE_PLUGIN_INTERFACE_TYPE_GUI_WINDOWS, AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST, AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_CONVERSION_HELPERS, AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_OBJECT_MEDIA,
  AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_OBJECT_STORE, AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_PROPERTY_SET, AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_UNDO_MANAGER, AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_DATA_WRITER,
  AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_XML, AK_WWISE_PLUGIN_INTERFACE_TYPE_LINK_BACKEND, AK_WWISE_PLUGIN_INTERFACE_TYPE_LINK_FRONTEND, AK_WWISE_PLUGIN_INTERFACE_TYPE_NATIVE_ISERVICEPROVIDER,
  AK_WWISE_PLUGIN_INTERFACE_TYPE_NATIVE_IWAUDIODEVICEPLUGIN, AK_WWISE_PLUGIN_INTERFACE_TYPE_NATIVE_IWCONVERSIONPLUGIN, AK_WWISE_PLUGIN_INTERFACE_TYPE_NATIVE_IWEFFECTPLUGIN, AK_WWISE_PLUGIN_INTERFACE_TYPE_NATIVE_IWSOURCEPLUGIN,
  AK_WWISE_PLUGIN_INTERFACE_TYPE_TESTSERVICE, AK_WWISE_PLUGIN_INTERFACE_TYPE_NUM
}
  List of every single interface known to the plug-in system. More...
 
enum   ak_wwise_plugin_undo_group_close_action {
  AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CLOSE, AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY, AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_FIRST_EVENT_NAME, AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_LAST_EVENT_NAME,
  AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CANCEL
}
  Action to apply once this undo group is closed. More...
 

Detailed Description