_plugin_def_8h

Wwise SDK 2025.1.0

 /*******************************************************************************
 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
 released in source code form as part of the SDK installer package.
  
 Commercial License Usage
  
 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
 may use this file in accordance with the end user license agreement provided 
 with the software or, alternatively, in accordance with the terms contained in a
 written agreement between you and Audiokinetic Inc.
  
 Apache License Usage
  
 Alternatively, this file may be used under the Apache License, Version 2.0 (the 
 "Apache License"); you may not use this file except in compliance with the 
 Apache License. You may obtain a copy of the Apache License at 
 http://www.apache.org/licenses/LICENSE-2.0.
  
 Unless required by applicable law or agreed to in writing, software distributed
 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
 the specific language governing permissions and limitations under the License.
  
   Copyright (c) 2025 Audiokinetic Inc.
 *******************************************************************************/
  
 /**
  * \brief Wwise Authoring Plug-ins - Base plug-in definitions
  * \file AK/Wwise/Plugin/PluginDef.h
  */
  
 #pragma once
  
 #include "PluginHelpers.h"
 #include "PluginInstanceTypes.h"
  
 // Everthing in this section needs:
 // - to be converted back to plain vanilla C
 // - create optional interfaces for classes
 // - create compulsory convertion functions for enums
 #ifdef __cplusplus
 #include "../../SoundEngine/Common/IAkPlugin.h"
  
 namespace AK
 {
     namespace WwiseAuthoringAPI
     {
         class AkVariantBase;
     }
 }
  
 namespace AK
 {
     namespace Wwise
     {
         namespace Plugin
         {
             /// License type.
             enum LicenseType
             {
                 LicenseType_Trial = 1,      ///< Used for both Trial and Evaluation License handling
                 LicenseType_Purchased,      ///< The license was purchased
                 LicenseType_Academic        ///< The license is for academic
             };
  
             /// License status.
             enum LicenseStatus
             {
                 LicenseStatus_Unlicensed,   ///< No license found
                 LicenseStatus_Expired,      ///< A license is found, but is expired
                 LicenseStatus_Valid,        ///< A license is found and is valid
  
                 LicenseStatus_Incompatible  ///< The plugin was made for an older version of Wwise
             };
  
             struct LicenseID
             {
                 // nul-terminated 8 characters license
                 char id[9];
             };
  
             /// Type of operation for the NotifyInnerObjectAddedRemoved function.
             enum NotifyInnerObjectOperation
             {
                 InnerObjectAdded,
                 InnerObjectRemoved
             };
  
             struct MonitorData
             {
                 uint64_t uGameObjectID;
                 void* pData;
                 unsigned int uDataSize;
             };
  
             /// Import channel configuration options.
             enum AudioFileChannel
             {
                 Channel_mono = 0,
                 Channel_stereo = 1,
                 Channel_mono_drop = 2,
                 Channel_stereo_drop = 3,
                 Channel_as_input = 4,
                 Channel_mono_drop_right = 5,
                 Channel_stereo_balance = 6,
             };
  
             /// Log message severity.
             enum Severity
             {
                 Severity_Success = -1,  ///< operation was executed without errors or will not produce errors
                 Severity_Message,       ///< not impacting the integrity of the current operation
                 Severity_Warning,       ///< potentially impacting the integrity of the current operation
                 Severity_Error,         ///< impacting the integrity of the current operation
                 Severity_FatalError,    ///< impacting the completion of the current operation
             };
  
             /// Represents the association between a dialog control (such as
             /// a checkbox or radio button) and a plug-in property.
             /// \aknote
             /// You should not need to use this structure directly. Instead, use the 
             /// AK_BEGIN_POPULATE_TABLE(), AK_POP_ITEM(), and AK_END_POPULATE_TABLE() macros.
             /// \endaknote
             /// \sa
             /// - \ref wwiseplugin_dialog_guide_poptable
             struct PopulateTableItem
             {
                 uint32_t uiID;              ///< The dialog control resource ID
                 const char * pszProp;       ///< The property name
             };
  
             /// Dialog type. Source plug-ins can be edited in the Property Editor or
             /// the Contents Editor, while effect plug-ins can only be edited in the
             /// Effect Editor.
             /// \sa
             /// - \ref wwiseplugin_dialogcode
             enum eDialog
             {
                 SettingsDialog,         ///< Main plug-in dialog. This is the dialog used in the Property
                                         ///< Editor for source plug-ins, and in the Effect Editor for
                                         ///< effect plug-ins.
                 ContentsEditorDialog    ///< Contents Editor dialog. This is the small dialog used in the
                                         ///< Contents Editor for source plug-ins.
             };
  
             /// Conversion error code.
             enum ConversionResult
             {
                 ConversionSuccess = 0,
                 ConversionWarning = 1,
                 ConversionFailed = 2,
             };
  
             class IProgress
             {
             public:
                 /// Call this to set the name of the operation currently done.
                 /// If not called the operation will have an empty name in the UI.
                 /// The name should be on a single line.
                 virtual void SetCurrentOperationName(const char * in_szOperationName) = 0;
  
                 /// Should be called at the beginning of the operation to set the min and max value
                 virtual void SetRange(uint32_t in_dwMinValue, uint32_t in_dwMaxValue) = 0;
  
                 /// Notify of the advancement of the task.
                 virtual void NotifyProgress(uint32_t in_dwProgress) = 0;
  
                 /// Check if the user has cancelled the task
                 virtual bool IsCancelled() const = 0;
  
                 /// Display an error message to the user.
                 /// The message should be on a single line.
                 virtual void ErrorMessage(const char * in_rErrorText, Severity in_eSeverity = Severity_Warning) = 0;
             };
  
             /// Interface to let the plug in give us a string of any size.
             /// The pointer to the interface should not be kept.
             class IWriteString
             {
             public:
                 virtual void WriteString(const char * in_szString,
                     int in_iStringLength) = 0;
             };
  
             /// Interfaces used to set and get the properties from a plug in.
             class IReadOnlyProperties
             {
             public:
                 virtual bool GetValue(const char * in_szPropertyName,
                     AK::WwiseAuthoringAPI::AkVariantBase& out_rValue) const = 0;
  
                 virtual int GetType(
                     const char* in_pszPropertyName      ///< The name of the property
                 ) const = 0;
  
                 virtual bool GetValueString(
                     const char * in_pszPropertyName,        ///< The name of the property
                     const char*& out_varProperty        ///< The returned value of the property
                 ) const = 0;
  
                 virtual bool GetValueInt64(
                     const char * in_pszPropertyName,        ///< The name of the property
                     int64_t& out_varProperty        ///< The returned value of the property
                 ) const = 0;
  
                 virtual bool GetValueInt32(
                     const char * in_pszPropertyName,        ///< The name of the property
                     int32_t& out_varProperty        ///< The returned value of the property
                 ) const = 0;
  
                 virtual bool GetValueInt16(
                     const char * in_pszPropertyName,        ///< The name of the property
                     int16_t& out_varProperty        ///< The returned value of the property
                 ) const = 0;
  
                 virtual bool GetValueInt8(
                     const char * in_pszPropertyName,        ///< The name of the property
                     int8_t& out_varProperty     ///< The returned value of the property
                 ) const = 0;
  
                 virtual bool GetValueUInt64(
                     const char * in_pszPropertyName,        ///< The name of the property
                     uint64_t& out_varProperty       ///< The returned value of the property
                 ) const = 0;
  
                 virtual bool GetValueUInt32(
                     const char * in_pszPropertyName,        ///< The name of the property
                     uint32_t& out_varProperty       ///< The returned value of the property
                 ) const = 0;
  
                 virtual bool GetValueUInt16(
                     const char * in_pszPropertyName,        ///< The name of the property
                     uint16_t& out_varProperty       ///< The returned value of the property
                 ) const = 0;
  
                 virtual bool GetValueUInt8(
                     const char * in_pszPropertyName,        ///< The name of the property
                     uint8_t& out_varProperty        ///< The returned value of the property
                 ) const = 0;
  
                 virtual bool GetValueReal64(
                     const char * in_pszPropertyName,        ///< The name of the property
                     double& out_varProperty     ///< The returned value of the property
                 ) const = 0;
  
                 virtual bool GetValueReal32(
                     const char * in_pszPropertyName,        ///< The name of the property
                     float& out_varProperty      ///< The returned value of the property
                 ) const = 0;
  
                 virtual bool GetValueBool(
                     const char * in_pszPropertyName,        ///< The name of the property
                     bool& out_varProperty       ///< The returned value of the property
                 ) const = 0;
  
                 inline const char* GetString(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     const char* result;
                     AKVERIFY(GetValueString(in_pszPropertyName, result));
                     return result;
                 }
  
                 inline int64_t GetInt64(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     int64_t result;
                     AKVERIFY(GetValueInt64(in_pszPropertyName, result));
                     return result;
                 }
  
                 inline int32_t GetInt32(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     int32_t result;
                     AKVERIFY(GetValueInt32(in_pszPropertyName, result));
                     return result;
                 }
  
                 inline int16_t GetInt16(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     int16_t result;
                     AKVERIFY(GetValueInt16(in_pszPropertyName, result));
                     return result;
                 }
  
                 inline int8_t GetInt8(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     int8_t result;
                     AKVERIFY(GetValueInt8(in_pszPropertyName, result));
                     return result;
                 }
  
                 inline uint64_t GetUInt64(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     uint64_t result;
                     AKVERIFY(GetValueUInt64(in_pszPropertyName, result));
                     return result;
                 }
  
                 inline uint32_t GetUInt32(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     uint32_t result;
                     AKVERIFY(GetValueUInt32(in_pszPropertyName, result));
                     return result;
                 }
  
                 inline uint16_t GetUInt16(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     uint16_t result;
                     AKVERIFY(GetValueUInt16(in_pszPropertyName, result));
                     return result;
                 }
  
                 inline uint8_t GetUInt8(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     uint8_t result;
                     AKVERIFY(GetValueUInt8(in_pszPropertyName, result));
                     return result;
                 }
  
                 inline double GetReal64(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     double result;
                     AKVERIFY(GetValueReal64(in_pszPropertyName, result));
                     return result;
                 }
  
                 inline float GetReal32(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     float result;
                     AKVERIFY(GetValueReal32(in_pszPropertyName, result));
                     return result;
                 }
  
                 inline bool GetBool(
                     const char * in_pszPropertyName     ///< The name of the property
                 ) const
                 {
                     bool result;
                     AKVERIFY(GetValueBool(in_pszPropertyName, result));
                     return result;
                 }
             };
  
             class IReadWriteProperties : public IReadOnlyProperties
             {
             public:
                 virtual bool SetValue(const char * in_szPropertyName,
                     const AK::WwiseAuthoringAPI::AkVariantBase& in_rValue) = 0;
  
                 virtual bool ClearValue(
                     const char* in_pszPropertyName      ///< The name of the property
                 ) = 0;
  
                 virtual bool SetValueString(
                     const char * in_pszPropertyName,        ///< The name of the property
                     const char * in_varProperty ///< The value to set
                 ) = 0;
  
                 virtual bool SetValueInt64(
                     const char * in_pszPropertyName,        ///< The name of the property
                     int64_t in_varProperty  ///< The value to set
                 ) = 0;
  
                 virtual bool SetValueInt32(
                     const char * in_pszPropertyName,        ///< The name of the property
                     int32_t in_varProperty  ///< The value to set
                 ) = 0;
  
                 virtual bool SetValueInt16(
                     const char * in_pszPropertyName,        ///< The name of the property
                     int16_t in_varProperty  ///< The value to set
                 ) = 0;
  
                 virtual bool SetValueInt8(
                     const char * in_pszPropertyName,        ///< The name of the property
                     int8_t in_varProperty   ///< The value to set
                 ) = 0;
  
                 virtual bool SetValueUInt64(
                     const char * in_pszPropertyName,        ///< The name of the property
                     uint64_t in_varProperty ///< The value to set
                 ) = 0;
  
                 virtual bool SetValueUInt32(
                     const char * in_pszPropertyName,        ///< The name of the property
                     uint32_t in_varProperty ///< The value to set
                 ) = 0;
  
                 virtual bool SetValueUInt16(
                     const char * in_pszPropertyName,        ///< The name of the property
                     uint16_t in_varProperty ///< The value to set
                 ) = 0;
  
                 virtual bool SetValueUInt8(
                     const char * in_pszPropertyName,        ///< The name of the property
                     uint8_t in_varProperty  ///< The value to set
                 ) = 0;
  
                 virtual bool SetValueReal64(
                     const char * in_pszPropertyName,        ///< The name of the property
                     double in_varProperty   ///< The value to set
                 ) = 0;
  
                 virtual bool SetValueReal32(
                     const char * in_pszPropertyName,        ///< The name of the property
                     float in_varProperty    ///< The value to set
                 ) = 0;
  
                 virtual bool SetValueBool(
                     const char * in_pszPropertyName,        ///< The name of the property
                     bool in_varProperty ///< The value to set
                 ) = 0;
             };
  
             // Note: This should be kept in line with AkChunkHeader
             struct RiffHeader
             {
                 uint32_t fccChunkId;
                 uint32_t dwDataSize;
             };
             
             struct ConversionContext
             {
                 //
                 // Inputs
                 //
                 const GUID* platformID;
                 const GUID* basePlatformID;
                 const char* sourceFileName;
                 const char* destinationFileName;
                 AK::Wwise::Plugin::IProgress* progress;
                 AK::Wwise::Plugin::IWriteString* error;
  
                 bool noDecode;
  
                 const IReadOnlyProperties* sourceProperties;
                 IReadWriteProperties* pluginProperties;
  
                 // Analysis data types available for this source.
                 uint32_t analysisDataTypes;
  
                 // False if source context contains at least one value that is not the default.
                 bool isDefault;
  
                 // Required downmix normalization gain (linear), 1 if not available / desired.
                 float downmixNormalizationGain;
             };
  
             struct ConvertedFileInfo
             {
                 uint32_t dataSize = 0;          ///< Actual size of data, taking duration into account (for prefetch)
                 uint32_t duration = -1;         ///< Actual duration of data, or -1 for entire file
                 uint32_t sampleRate = 0;        ///< Number of samples per second
                 AkChannelConfig channelConfig;  ///< Channel configuration
                 uint32_t decodedFileSize = -1;  ///< File size of file when decoded to PCM format, *If* offline decoding is supported by the codec. Otherwise has value NO_OFFLINE_DECODING (-1)
                 uint8_t abyHash[16] = { 0 };    ///< Converted file hash (as present in the HASH chunk).
             };
  
             struct OpenedConvertedFile
                 : public ConvertedFileInfo
             {
                 const void* data = nullptr;     ///< Pointer to start of file data
             };
         }
     }
 }
 #endif
  
 /** \addtogroup global
  * @{
  */
  
 /**
  * \brief A definition of an undo event, with a specific interface and instance.
  * 
  * Allows to bind an event from any source: Authoring or any plug-in. Allows to have multiple separate interfaces.
  * 
  * - ak_wwise_plugin_undo_event_v1 C interface for an undo event.
  * - ak_wwise_plugin_undo_event_instance_v1 C instance for an undo event.
  * - AK::Wwise::Plugin::V1::UndoEvent C++ class for an undo event.
  * - ak_wwise_plugin_host_undo_manager_v1 C interface for the undo manager.
  * - AK::Wwise::Plugin::V1::UndoManager C++ class for the undo manager.
  */
 struct ak_wwise_plugin_undo_event_pair_v1
 {
     struct ak_wwise_plugin_undo_event_v1* m_interface;                                                                  ///< The interface to execute that undo event's commands.
     struct ak_wwise_plugin_undo_event_instance_v1* m_instance;                                                          ///< The specific instance usued for that particular undo event.
 };
  
 typedef int ak_wwise_plugin_undo_group_id;                                                                              ///< Unique identifier for a particular undo group. Useful to reopen an unapplied closed group session.
  
 /**
  * \brief Action to apply once this undo group is closed.
  * 
  * The goal of an undo group is to keep a list of actions being executed that can be undone (for example, a
  * property set modification). Once the operations are all done, this indicates what should be done with the internal
  * operations.
  * 
  * - \ref AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY : The usual operation is to open an undo group, and then close
  *   and apply the group to the undo stack. This provides a valid Undo/Redo label, as well as a description of all
  *   the operations that need to be done.
  * - \ref AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_FIRST_EVENT_NAME
  *   and AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_LAST_EVENT_NAME are convenience operations, where the Undo
  *   operation title is retrieved from either the first or the last event's name, instead of hard-coding it ourselves.
  * - \ref AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CANCEL cancels the undo operations. It happens when an abnormal
  *   termination occurs, such as an error, or the user cancelling a lengthy operation. Since the operation states
  *   aren't known, you are responsible to handle the stored undo yourself, and manually revert all operations first
  *   before closing the action. An example of this operation is doing a slider drag event, where the user presses
  *   the Escape key instead of doing a Mouse Up. Effectively, all the inner operations will simply be cancelled by storing
  *   the initial value before doing the cancel operation on close.
  * - \ref AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CLOSE temporarily closes the undo state, leaving it possible to reopen
  *   it later. This is useful during lengthy processes, such as a user dragging a slider. You are expected to
  *   temporarily close the undo group when going out of scope, and reopening it when receiving a new system mouse drag
  *   event in this particular example.
  */
 typedef enum {
     AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CLOSE,                                                                      ///< Close this group session (going out of scope), but do not apply it yet.
     AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY,                                                                      ///< Close this group session permanently, and apply its operations to the englobing group.
     AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_FIRST_EVENT_NAME,                                                     ///< Same than AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY, but copies the name of the first inner undo event as the name.
     AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_LAST_EVENT_NAME,                                                      ///< Same than AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY, but copies the name of the last inner undo event as the name.
     AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CANCEL                                                                      ///< Close this group session permanently, and cancel all its internal operations. Undo operations are not applied.
 } ak_wwise_plugin_undo_group_close_action;
  
 /**
  * \brief Bitfield values of brace types, used to delay or avoid certain actions normally triggered as a result
  * of a property set mutation.
  *
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_NOTIFY : Do not notify of changes
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_UNDO_EVENTS : Do not create undo events
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_SET_VALUE : Collapse set values notifications once the brace is closed
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_REORDER_CHILDREN : Children are being reordered
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_DISABLE_PROPERTY_CONSTRAINTS : Disable property constraints
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_DIRTY : Inhibit the project's dirty state
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_CREATE_PROPERTY_ON_SET_VALUE : Create a new property when an unknown property is set
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_CHANGE_TO_EXISTING_VALUE_TYPE : Allow a property type change if the provided type differs from its current type
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_LOADING : Indicates the object is being loaded
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_UNLOADING : Indicates the object is being unloaded
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_DELETING : Indicates the object is being deleted
  * - \ref AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_SET_OBJECT_LIST : Collapse the final set object list once the last brace is closed
  *
  * \sa
  * - AK::Wwise::Plugin::PropertySet::OpenBraces
  * - AK::Wwise::Plugin::PropertySet::CloseBraces
 */
 typedef enum
 {
     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,
 } ak_wwise_plugin_property_set_braces_values;
  
 /// \brief Bitfield composed of values defined in \c ak_wwise_plugin_property_set_braces_values
 typedef uint32_t ak_wwise_plugin_property_set_braces;
  
 /**
  * @}
  */

AK.Wwise::Plugin::IReadWriteProperties::SetValueUInt16

virtual bool SetValueUInt16(const char *in_pszPropertyName, uint16_t in_varProperty)=0

AK.Wwise::Plugin::ConvertedFileInfo::decodedFileSize

uint32_t decodedFileSize

File size of file when decoded to PCM format, If offline decoding is supported by the codec....

Definition: PluginDef.h:476

AK.Wwise::Plugin::IProgress::ErrorMessage

virtual void ErrorMessage(const char *in_rErrorText, Severity in_eSeverity=Severity_Warning)=0

AK.Wwise::Plugin::ConversionContext::isDefault

bool isDefault

Definition: PluginDef.h:464

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_DIRTY

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_DIRTY

Definition: PluginDef.h:573

ak_wwise_plugin_undo_event_instance_v1

Base instance type for providing custom undo operations through ak_wwise_plugin_undo_event_v1.

Definition: PluginInstanceTypes.h:473

AK.Wwise::Plugin::IReadOnlyProperties::GetValueReal64

virtual bool GetValueReal64(const char *in_pszPropertyName, double &out_varProperty) const =0

AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CLOSE

@ AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CLOSE

Close this group session (going out of scope), but do not apply it yet.

Definition: PluginDef.h:538

AK.Wwise::Plugin::IReadOnlyProperties::GetInt32

int32_t GetInt32(const char *in_pszPropertyName) const

Definition: PluginDef.h:274

AK.Wwise::Plugin::IReadOnlyProperties::GetValueBool

virtual bool GetValueBool(const char *in_pszPropertyName, bool &out_varProperty) const =0

AK.Wwise::Plugin::IWriteString::WriteString

virtual void WriteString(const char *in_szString, int in_iStringLength)=0

Definition of data structures for AkAudioObject.

Definition: AkWwiseSDKVersion.cs:31

AK.Wwise::Plugin::eDialog

eDialog

Definition: PluginDef.h:138

AK.Wwise::Plugin::IReadOnlyProperties::GetUInt16

uint16_t GetUInt16(const char *in_pszPropertyName) const

Definition: PluginDef.h:319

AK.Wwise::Plugin::IReadWriteProperties::SetValueReal32

virtual bool SetValueReal32(const char *in_pszPropertyName, float in_varProperty)=0

AK.Wwise::Plugin::ConversionContext::noDecode

bool noDecode

Definition: PluginDef.h:455

AK.Wwise::Plugin::ContentsEditorDialog

@ ContentsEditorDialog

Definition: PluginDef.h:142

AK.Wwise::Plugin::PopulateTableItem::pszProp

const char * pszProp

The property name.

Definition: PluginDef.h:129

AK.Wwise::Plugin::IReadOnlyProperties::GetValueInt16

virtual bool GetValueInt16(const char *in_pszPropertyName, int16_t &out_varProperty) const =0

AK.Wwise::Plugin::IReadOnlyProperties::GetValueInt8

virtual bool GetValueInt8(const char *in_pszPropertyName, int8_t &out_varProperty) const =0

AK.Wwise::Plugin::ConversionContext::destinationFileName

const char * destinationFileName

Definition: PluginDef.h:451

PluginInstanceTypes.h

Wwise Authoring Plug-in Instance Types.

AK.Wwise::Plugin::LicenseStatus_Expired

@ LicenseStatus_Expired

A license is found, but is expired.

Definition: PluginDef.h:70

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_LOADING

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_LOADING

Definition: PluginDef.h:576

AK.Wwise::Plugin::OpenedConvertedFile::data

const void * data

Pointer to start of file data.

Definition: PluginDef.h:483

AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY

@ AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY

Close this group session permanently, and apply its operations to the englobing group.

Definition: PluginDef.h:539

AK.Wwise::Plugin::ConversionContext::sourceFileName

const char * sourceFileName

Definition: PluginDef.h:450

AK.Wwise::Plugin::IReadWriteProperties::SetValueInt8

virtual bool SetValueInt8(const char *in_pszPropertyName, int8_t in_varProperty)=0

AK.Wwise::Plugin::IReadOnlyProperties::GetReal64

double GetReal64(const char *in_pszPropertyName) const

Definition: PluginDef.h:337

AK.Wwise::Plugin::ConversionSuccess

@ ConversionSuccess

Definition: PluginDef.h:149

AK.Wwise::Plugin::IReadWriteProperties::SetValueUInt64

virtual bool SetValueUInt64(const char *in_pszPropertyName, uint64_t in_varProperty)=0

AK.Wwise::Plugin::IReadOnlyProperties::GetInt8

int8_t GetInt8(const char *in_pszPropertyName) const

Definition: PluginDef.h:292

AK.Wwise::Plugin::InnerObjectAdded

@ InnerObjectAdded

Definition: PluginDef.h:85

AkChannelConfig

Definition: AkSpeakerConfig.h:436

AK.Wwise::Plugin::ConvertedFileInfo::sampleRate

uint32_t sampleRate

Number of samples per second.

Definition: PluginDef.h:474

AK.Wwise::Plugin::IReadOnlyProperties::GetUInt8

uint8_t GetUInt8(const char *in_pszPropertyName) const

Definition: PluginDef.h:328

AK.Wwise::Plugin::ConversionWarning

@ ConversionWarning

Definition: PluginDef.h:150

ak_wwise_plugin_undo_event_v1

API to create a custom undo event in a plug-in.

Definition: HostUndoManager.h:45

ak_wwise_plugin_property_set_braces

uint32_t ak_wwise_plugin_property_set_braces

Bitfield composed of values defined in ak_wwise_plugin_property_set_braces_values.

Definition: PluginDef.h:583

AK.Wwise::Plugin::IReadOnlyProperties::GetValueUInt8

virtual bool GetValueUInt8(const char *in_pszPropertyName, uint8_t &out_varProperty) const =0

AK.Wwise::Plugin::IProgress::NotifyProgress

virtual void NotifyProgress(uint32_t in_dwProgress)=0

Notify of the advancement of the task.

AK.Wwise::Plugin::IReadWriteProperties::SetValueInt64

virtual bool SetValueInt64(const char *in_pszPropertyName, int64_t in_varProperty)=0

AK.Wwise::Plugin::InnerObjectRemoved

@ InnerObjectRemoved

Definition: PluginDef.h:86

AK.Wwise::Plugin::ConvertedFileInfo

Definition: PluginDef.h:471

AK.Wwise::Plugin::SettingsDialog

@ SettingsDialog

Definition: PluginDef.h:139

AK.Wwise::Plugin::ConversionContext::platformID

const GUID * platformID

Definition: PluginDef.h:448

AK.Wwise::Plugin::NotifyInnerObjectOperation

NotifyInnerObjectOperation

Type of operation for the NotifyInnerObjectAddedRemoved function.

Definition: PluginDef.h:84

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_NOTIFY

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_NOTIFY

Definition: PluginDef.h:568

AK.Wwise::Plugin::IReadWriteProperties::ClearValue

virtual bool ClearValue(const char *in_pszPropertyName)=0

AK.Wwise::Plugin::ConversionContext::basePlatformID

const GUID * basePlatformID

Definition: PluginDef.h:449

AK.Wwise::Plugin::ConvertedFileInfo::dataSize

uint32_t dataSize

Actual size of data, taking duration into account (for prefetch)

Definition: PluginDef.h:472

AK.Wwise::Plugin::MonitorData::uGameObjectID

uint64_t uGameObjectID

Definition: PluginDef.h:91

AK.Wwise::Plugin::Channel_stereo

@ Channel_stereo

Definition: PluginDef.h:100

ak_wwise_plugin_undo_event_pair_v1::m_interface

struct ak_wwise_plugin_undo_event_v1 * m_interface

The interface to execute that undo event's commands.

Definition: PluginDef.h:507

AK.Wwise::Plugin::IReadOnlyProperties::GetUInt64

uint64_t GetUInt64(const char *in_pszPropertyName) const

Definition: PluginDef.h:301

AK.Wwise::Plugin::MonitorData::uDataSize

unsigned int uDataSize

Definition: PluginDef.h:93

AK.Wwise::Plugin::PopulateTableItem

Definition: PluginDef.h:127

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_REORDER_CHILDREN

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_REORDER_CHILDREN

Definition: PluginDef.h:571

AK.Wwise::Plugin::LicenseType

LicenseType

License type.

Definition: PluginDef.h:60

AK.Wwise::Plugin::IReadOnlyProperties::GetValueUInt32

virtual bool GetValueUInt32(const char *in_pszPropertyName, uint32_t &out_varProperty) const =0

AK.Wwise::Plugin::IReadOnlyProperties::GetValueUInt16

virtual bool GetValueUInt16(const char *in_pszPropertyName, uint16_t &out_varProperty) const =0

AK.Wwise::Plugin::RiffHeader::dwDataSize

uint32_t dwDataSize

Definition: PluginDef.h:440

AK.Wwise::Plugin::IReadOnlyProperties::GetUInt32

uint32_t GetUInt32(const char *in_pszPropertyName) const

Definition: PluginDef.h:310

AK.Wwise::Plugin::IReadWriteProperties::SetValueInt32

virtual bool SetValueInt32(const char *in_pszPropertyName, int32_t in_varProperty)=0

AK.Wwise::Plugin::ConversionContext::error

AK::Wwise::Plugin::IWriteString * error

Definition: PluginDef.h:453

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_CHANGE_TO_EXISTING_VALUE_TYPE

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_CHANGE_TO_EXISTING_VALUE_TYPE

Definition: PluginDef.h:575

AK.Wwise::Plugin::IReadOnlyProperties::GetValue

virtual bool GetValue(const char *in_szPropertyName, AK::WwiseAuthoringAPI::AkVariantBase &out_rValue) const =0

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_DELETING

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_DELETING

Definition: PluginDef.h:578

AK.Wwise::Plugin::IReadOnlyProperties::GetInt16

int16_t GetInt16(const char *in_pszPropertyName) const

Definition: PluginDef.h:283

AK.Wwise::Plugin::Channel_mono_drop

@ Channel_mono_drop

Definition: PluginDef.h:101

AK.Wwise::Plugin::LicenseID

Definition: PluginDef.h:77

AK.Wwise::Plugin::Severity_Error

@ Severity_Error

impacting the integrity of the current operation

Definition: PluginDef.h:114

ak_wwise_plugin_undo_group_id

int ak_wwise_plugin_undo_group_id

Unique identifier for a particular undo group. Useful to reopen an unapplied closed group session.

Definition: PluginDef.h:511

AK.Wwise::Plugin::IProgress::SetCurrentOperationName

virtual void SetCurrentOperationName(const char *in_szOperationName)=0

AK.Wwise::Plugin::IReadWriteProperties::SetValueString

virtual bool SetValueString(const char *in_pszPropertyName, const char *in_varProperty)=0

AKVERIFY

#define AKVERIFY(x)

Definition: AkAssert.h:69

ak_wwise_plugin_undo_group_close_action

Action to apply once this undo group is closed.

Definition: PluginDef.h:537

AK.Wwise::Plugin::IReadOnlyProperties::GetValueString

virtual bool GetValueString(const char *in_pszPropertyName, const char *&out_varProperty) const =0

AK.Wwise::Plugin::IReadOnlyProperties::GetReal32

float GetReal32(const char *in_pszPropertyName) const

Definition: PluginDef.h:346

AK.Wwise::Plugin::ConversionContext

Definition: PluginDef.h:444

AK.Wwise::Plugin::IProgress::IsCancelled

virtual bool IsCancelled() const =0

Check if the user has cancelled the task.

AK.Wwise::Plugin::LicenseStatus_Unlicensed

@ LicenseStatus_Unlicensed

No license found.

Definition: PluginDef.h:69

AK.Wwise::Plugin::Channel_as_input

@ Channel_as_input

Definition: PluginDef.h:103

AK.Wwise::Plugin::Channel_stereo_drop

@ Channel_stereo_drop

Definition: PluginDef.h:102

AK.Wwise::Plugin::Severity_FatalError

@ Severity_FatalError

impacting the completion of the current operation

Definition: PluginDef.h:115

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_DISABLE_PROPERTY_CONSTRAINTS

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_DISABLE_PROPERTY_CONSTRAINTS

Definition: PluginDef.h:572

AK.Wwise::Plugin::ConversionResult

ConversionResult

Conversion error code.

Definition: PluginDef.h:148

AK.Wwise::Plugin::IReadOnlyProperties

Interfaces used to set and get the properties from a plug in.

Definition: PluginDef.h:187

AK.Wwise::Plugin::LicenseStatus_Valid

@ LicenseStatus_Valid

A license is found and is valid.

Definition: PluginDef.h:71

AK.Wwise::Plugin::Channel_mono

@ Channel_mono

Definition: PluginDef.h:99

AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_LAST_EVENT_NAME

@ AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_LAST_EVENT_NAME

Same than AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY, but copies the name of the last inner undo e...

Definition: PluginDef.h:541

AK.Wwise::Plugin::IReadOnlyProperties::GetValueUInt64

virtual bool GetValueUInt64(const char *in_pszPropertyName, uint64_t &out_varProperty) const =0

AK.Wwise::Plugin::IReadOnlyProperties::GetType

virtual int GetType(const char *in_pszPropertyName) const =0

AK.Wwise::Plugin::IReadWriteProperties::SetValueUInt32

virtual bool SetValueUInt32(const char *in_pszPropertyName, uint32_t in_varProperty)=0

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_SET_VALUE

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_SET_VALUE

Definition: PluginDef.h:570

AK.Wwise::Plugin::IReadWriteProperties

Definition: PluginDef.h:366

AK.Wwise::Plugin::IReadOnlyProperties::GetString

const char * GetString(const char *in_pszPropertyName) const

Definition: PluginDef.h:256

AK.Wwise::Plugin::Severity_Warning

@ Severity_Warning

potentially impacting the integrity of the current operation

Definition: PluginDef.h:113

AK.Wwise::Plugin::Channel_stereo_balance

@ Channel_stereo_balance

Definition: PluginDef.h:105

AK.Wwise::Plugin::IReadWriteProperties::SetValueReal64

virtual bool SetValueReal64(const char *in_pszPropertyName, double in_varProperty)=0

AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CANCEL

@ AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CANCEL

Close this group session permanently, and cancel all its internal operations. Undo operations are not...

Definition: PluginDef.h:542

AK.Wwise::Plugin::Severity

Severity

Log message severity.

Definition: PluginDef.h:110

AK.Wwise::Plugin::ConversionContext::pluginProperties

IReadWriteProperties * pluginProperties

Definition: PluginDef.h:458

AK.Wwise::Plugin::ConversionContext::sourceProperties

const IReadOnlyProperties * sourceProperties

Definition: PluginDef.h:457

ak_wwise_plugin_property_set_braces_values

Bitfield values of brace types, used to delay or avoid certain actions normally triggered as a result...

Definition: PluginDef.h:567

AK.Wwise::Plugin::AudioFileChannel

AudioFileChannel

Import channel configuration options.

Definition: PluginDef.h:98

AK.Wwise::Plugin::IReadWriteProperties::SetValue

virtual bool SetValue(const char *in_szPropertyName, const AK::WwiseAuthoringAPI::AkVariantBase &in_rValue)=0

AK.Wwise::Plugin::IReadOnlyProperties::GetValueInt32

virtual bool GetValueInt32(const char *in_pszPropertyName, int32_t &out_varProperty) const =0

AK.Wwise::Plugin::ConvertedFileInfo::duration

uint32_t duration

Actual duration of data, or -1 for entire file.

Definition: PluginDef.h:473

AK.Wwise::Plugin::IWriteString

Definition: PluginDef.h:179

AK.Wwise::Plugin::Severity_Success

@ Severity_Success

operation was executed without errors or will not produce errors

Definition: PluginDef.h:111

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_UNDO_EVENTS

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_NO_UNDO_EVENTS

Definition: PluginDef.h:569

AK.Wwise::Plugin::ConversionFailed

@ ConversionFailed

Definition: PluginDef.h:151

ak_wwise_plugin_undo_event_pair_v1

A definition of an undo event, with a specific interface and instance.

Definition: PluginDef.h:506

AK.Wwise::Plugin::IReadOnlyProperties::GetBool

bool GetBool(const char *in_pszPropertyName) const

Definition: PluginDef.h:355

AK.Wwise::Plugin::RiffHeader

Definition: PluginDef.h:438

AK.Wwise::Plugin::IProgress::SetRange

virtual void SetRange(uint32_t in_dwMinValue, uint32_t in_dwMaxValue)=0

Should be called at the beginning of the operation to set the min and max value.

AK.Wwise::Plugin::LicenseType_Academic

@ LicenseType_Academic

The license is for academic.

Definition: PluginDef.h:63

AK.Wwise::Plugin::ConversionContext::downmixNormalizationGain

float downmixNormalizationGain

Definition: PluginDef.h:467

AK.Wwise::Plugin::IReadWriteProperties::SetValueUInt8

virtual bool SetValueUInt8(const char *in_pszPropertyName, uint8_t in_varProperty)=0

AK.Wwise::Plugin::Severity_Message

@ Severity_Message

not impacting the integrity of the current operation

Definition: PluginDef.h:112

AK.Wwise::Plugin::OpenedConvertedFile

Definition: PluginDef.h:482

AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_FIRST_EVENT_NAME

@ AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY_FIRST_EVENT_NAME

Same than AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY, but copies the name of the first inner undo ...

Definition: PluginDef.h:540

AK.Wwise::Plugin::IReadOnlyProperties::GetInt64

int64_t GetInt64(const char *in_pszPropertyName) const

Definition: PluginDef.h:265

AK.Wwise::Plugin::ConvertedFileInfo::channelConfig

AkChannelConfig channelConfig

Channel configuration.

Definition: PluginDef.h:475

AK.Wwise::Plugin::ConversionContext::progress

AK::Wwise::Plugin::IProgress * progress

Definition: PluginDef.h:452

PluginHelpers.h

Wwise Authoring Plug-ins - Helper tools, potentially defined elsewhere.

AK.Wwise::Plugin::RiffHeader::fccChunkId

uint32_t fccChunkId

Definition: PluginDef.h:439

AK.Wwise::Plugin::Channel_mono_drop_right

@ Channel_mono_drop_right

Definition: PluginDef.h:104

AK.Wwise::Plugin::LicenseStatus_Incompatible

@ LicenseStatus_Incompatible

The plugin was made for an older version of Wwise.

Definition: PluginDef.h:73

AK.Wwise::Plugin::IProgress

Definition: PluginDef.h:155

AK.Wwise::Plugin::LicenseStatus

LicenseStatus

License status.

Definition: PluginDef.h:68

AK.Wwise::Plugin::MonitorData::pData

void * pData

Definition: PluginDef.h:92

AK.Wwise::Plugin::PopulateTableItem::uiID

uint32_t uiID

The dialog control resource ID.

Definition: PluginDef.h:128

AK.Wwise::Plugin::LicenseType_Purchased

@ LicenseType_Purchased

The license was purchased.

Definition: PluginDef.h:62

AK.Wwise::Plugin::IReadOnlyProperties::GetValueInt64

virtual bool GetValueInt64(const char *in_pszPropertyName, int64_t &out_varProperty) const =0

AK.Wwise::Plugin::IReadWriteProperties::SetValueInt16

virtual bool SetValueInt16(const char *in_pszPropertyName, int16_t in_varProperty)=0

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_UNLOADING

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_UNLOADING

Definition: PluginDef.h:577

AK.Wwise::Plugin::MonitorData

Definition: PluginDef.h:90

AK.Wwise::Plugin::IReadOnlyProperties::GetValueReal32

virtual bool GetValueReal32(const char *in_pszPropertyName, float &out_varProperty) const =0

AK.Wwise::Plugin::LicenseType_Trial

@ LicenseType_Trial

Used for both Trial and Evaluation License handling.

Definition: PluginDef.h:61

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_CREATE_PROPERTY_ON_SET_VALUE

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_CREATE_PROPERTY_ON_SET_VALUE

Definition: PluginDef.h:574

ak_wwise_plugin_undo_event_pair_v1::m_instance

struct ak_wwise_plugin_undo_event_instance_v1 * m_instance

The specific instance usued for that particular undo event.

Definition: PluginDef.h:508

AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_SET_OBJECT_LIST

@ AK_WWISE_PLUGIN_PROPERTY_SET_BRACES_SET_OBJECT_LIST

Definition: PluginDef.h:579

AK.Wwise::Plugin::ConvertedFileInfo::abyHash

uint8_t abyHash[16]

Converted file hash (as present in the HASH chunk).

Definition: PluginDef.h:477

AK.Wwise::Plugin::IReadWriteProperties::SetValueBool

virtual bool SetValueBool(const char *in_pszPropertyName, bool in_varProperty)=0

AK.Wwise::Plugin::ConversionContext::analysisDataTypes

uint32_t analysisDataTypes

Definition: PluginDef.h:461

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.

Get started with Wwise

Wwise SDK

_plugin_def_8h_source

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.