Version
arrow_right Table of Contents

Other Documentation

Wwise SDK 2021.1.9
PluginDef.h File Reference

Wwise Authoring Plug-ins - Base plug-in definitions. More...

Go to the source code of this file.

Classes

struct   AK.Wwise::Plugin::MonitorData
 
struct   AK.Wwise::Plugin::PopulateTableItem
 
class   AK.Wwise::Plugin::IProgress
 
class   AK.Wwise::Plugin::IWriteString
 
class   AK.Wwise::Plugin::IReadOnlyProperties
  Interfaces used to set and get the properties from a plug in. More...
 
class   AK.Wwise::Plugin::IReadWriteProperties
 
struct   AK.Wwise::Plugin::RiffHeader
 
struct   AK.Wwise::Plugin::ConversionContext
 
struct   AK.Wwise::Plugin::OpenedConvertedFile
 
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...
 

Namespaces

namespace   AK
  Audiokinetic namespace.
 
  AK::WwiseAuthoringAPI
 
namespace   AK.Wwise
 
  AK::Wwise::Plugin
 

Macros

#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...
 
using  AK::Wwise::Plugin::CBaseInterface = ak_wwise_plugin_base_interface
  Interface description and base class for every Wwise Authoring plug-in interface. More...
 
using  AK::Wwise::Plugin::CInterfacePtr = ak_wwise_plugin_interface_ptr
 
using  AK::Wwise::Plugin::CInterfaceArrayItem = ak_wwise_plugin_interface_array_item
  A single instantiatable plug-in interface. More...
 
using  AK::Wwise::Plugin::CPluginInfo = ak_wwise_plugin_info
 
using  AK::Wwise::Plugin::CPluginContainer = ak_wwise_plugin_container
  Root interface allowing a logical unit (variable, library) to contain more than one interface. More...
 
using  AK::Wwise::Plugin::BaseInterface = CBaseInterface
  Interface description and base class for every Wwise Authoring plug-in interface. More...
 
using  AK::Wwise::Plugin::InterfacePtr = CInterfacePtr
 
using  AK::Wwise::Plugin::InterfaceArrayItem = CInterfaceArrayItem
  A single instantiatable plug-in interface. More...
 
using  AK::Wwise::Plugin::PluginInfo = CPluginInfo
 
using  AK::Wwise::Plugin::PluginContainer = CPluginContainer
  Root interface allowing a logical unit (variable, library) to contain more than one interface. More...
 

Enumerations

enum   AK::Wwise::Plugin::LicenseType { AK::Wwise::Plugin::LicenseType_Trial = 1, AK::Wwise::Plugin::LicenseType_Purchased, AK::Wwise::Plugin::LicenseType_Academic }
  License type. More...
 
enum   AK::Wwise::Plugin::LicenseStatus { AK::Wwise::Plugin::LicenseStatus_Unlicensed, AK::Wwise::Plugin::LicenseStatus_Expired, AK::Wwise::Plugin::LicenseStatus_Valid, AK::Wwise::Plugin::LicenseStatus_Incompatible }
  License status. More...
 
enum   AK::Wwise::Plugin::NotifyInnerObjectOperation { AK::Wwise::Plugin::InnerObjectAdded, AK::Wwise::Plugin::InnerObjectRemoved }
  Type of operation for the NotifyInnerObjectAddedRemoved function. More...
 
enum   AK::Wwise::Plugin::AudioFileChannel {
  AK::Wwise::Plugin::Channel_mono = 0, AK::Wwise::Plugin::Channel_stereo = 1, AK::Wwise::Plugin::Channel_mono_drop = 2, AK::Wwise::Plugin::Channel_stereo_drop = 3,
  AK::Wwise::Plugin::Channel_as_input = 4, AK::Wwise::Plugin::Channel_mono_drop_right = 5, AK::Wwise::Plugin::Channel_stereo_balance = 6
}
  Import channel configuration options. More...
 
enum   AK::Wwise::Plugin::Severity {
  AK::Wwise::Plugin::Severity_Success = -1, AK::Wwise::Plugin::Severity_Message, AK::Wwise::Plugin::Severity_Warning, AK::Wwise::Plugin::Severity_Error,
  AK::Wwise::Plugin::Severity_FatalError
}
  Log message severity. More...
 
enum   AK::Wwise::Plugin::eDialog { AK::Wwise::Plugin::SettingsDialog, AK::Wwise::Plugin::ContentsEditorDialog }
 
enum   AK::Wwise::Plugin::ConversionResult { AK::Wwise::Plugin::ConversionSuccess = 0, AK::Wwise::Plugin::ConversionWarning = 1, AK::Wwise::Plugin::ConversionFailed = 2 }
  Conversion error code. 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

Wwise Authoring Plug-ins - Base plug-in definitions.

Definition in file PluginDef.h.