Version
menu
Wwise SDK 2025.1.0
Classes | Namespaces | Typedefs | Enumerations
PluginDef.h File Reference

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

#include "PluginHelpers.h"
#include "PluginInstanceTypes.h"
#include "../../SoundEngine/Common/IAkPlugin.h"

Go to the source code of this file.

Classes

struct  AK.Wwise::Plugin::LicenseID
 
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::ConvertedFileInfo
 
struct  AK.Wwise::Plugin::OpenedConvertedFile
 
struct  ak_wwise_plugin_undo_event_pair_v1
 A definition of an undo event, with a specific interface and instance. More...
 

Namespaces

namespace  AK
 Definition of data structures for AkAudioObject.
 
 AK::WwiseAuthoringAPI
 
namespace  AK.Wwise
 
 AK::Wwise::Plugin
 

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...
 
typedef uint32_t ak_wwise_plugin_property_set_braces
 Bitfield composed of values defined in ak_wwise_plugin_property_set_braces_values. 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...
 
enum  ak_wwise_plugin_property_set_braces_values {
  AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_NOTIFY = 1 << 0, AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_UNDO_EVENTS = 1 << 1, AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_SET_VALUE = 1 << 2, AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_REORDER_CHILDREN = 1 << 3,
  AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_DISABLE_PROPERTY_CONSTRAINTS = 1 << 4, AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_DIRTY = 1 << 5, AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_CREATE_PROPERTY_ON_SET_VALUE = 1 << 6, AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_CHANGE_TO_EXISTING_VALUE_TYPE = 1 << 7,
  AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_LOADING = 1 << 8, AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_UNLOADING = 1 << 9, AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_DELETING = 1 << 10, AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_SET_OBJECT_LIST = 1 << 11
}
 Bitfield values of brace types, used to delay or avoid certain actions normally triggered as a result of a property set mutation. More...
 

Detailed Description

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

Definition in file PluginDef.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