virtual bool SetValueUInt16(const char *in_pszPropertyName, uint16_t in_varProperty)=0
virtual void ErrorMessage(const char *in_rErrorText, Severity in_eSeverity=Severity_Warning)=0
Base instance type for providing custom undo operations through ak_wwise_plugin_undo_event_v1.
virtual bool GetValueReal64(const char *in_pszPropertyName, double &out_varProperty) const =0
API to receive host's update notifications.
@ AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CLOSE
Close this group session (going out of scope), but do not apply it yet.
void ak_wwise_plugin_widget
int32_t GetInt32(const char *in_pszPropertyName) const
Base host-provided instance type for ak_wwise_plugin_host_undo_manager_v1.
virtual bool GetValueBool(const char *in_pszPropertyName, bool &out_varProperty) const =0
Frontend plug-in API for Audio plug-ins.
virtual void WriteString(const char *in_szString, int in_iStringLength)=0
Generic base for all plug-in instances. In C++, this is derived. In C, they are equivalent.
uint16_t GetUInt16(const char *in_pszPropertyName) const
virtual bool SetValueReal32(const char *in_pszPropertyName, float in_varProperty)=0
const char * pszProp
The property name.
Plug-in frontend instance.
virtual bool GetValueInt16(const char *in_pszPropertyName, int16_t &out_varProperty) const =0
virtual bool GetValueInt8(const char *in_pszPropertyName, int8_t &out_varProperty) const =0
const char * destinationFileName
@ LicenseStatus_Expired
A license is found, but is expired.
@ AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY
Close this group session permanently, and apply its operations to the englobing group.
const char * sourceFileName
uint32_t duration
Actual duration of data, or -1 for entire file.
virtual bool SetValueInt8(const char *in_pszPropertyName, int8_t in_varProperty)=0
ak_wwise_plugin_interface_ptr CInterfacePtr
double GetReal64(const char *in_pszPropertyName) const
ak_wwise_plugin_interface_array_item CInterfaceArrayItem
A single instantiatable plug-in interface.
virtual bool SetValueUInt64(const char *in_pszPropertyName, uint64_t in_varProperty)=0
int8_t GetInt8(const char *in_pszPropertyName) const
uint8_t GetUInt8(const char *in_pszPropertyName) const
Base instance type for providing custom data loading and saving through ak_wwise_plugin_custom_data_v...
Base instance type for providing a message shown the first time an instance is created through ak_wwi...
ak_wwise_plugin_container CPluginContainer
Root interface allowing a logical unit (variable, library) to contain more than one interface.
API to create a custom undo event in a plug-in.
virtual bool GetValueUInt8(const char *in_pszPropertyName, uint8_t &out_varProperty) const =0
virtual void NotifyProgress(uint32_t in_dwProgress)=0
Notify of the advancement of the task.
virtual bool SetValueInt64(const char *in_pszPropertyName, int64_t in_varProperty)=0
NotifyInnerObjectOperation
Type of operation for the NotifyInnerObjectAddedRemoved function.
virtual bool ClearValue(const char *in_pszPropertyName)=0
const GUID * basePlatformID
struct ak_wwise_plugin_undo_event_v1 * m_interface
The interface to execute that undo event's commands.
const char * templateName
#define AK_WWISE_PLUGIN_DERIVE_FROM_BACKEND_INSTANCE(x)
Define an instance type as a backend.
uint64_t GetUInt64(const char *in_pszPropertyName) const
AkChannelConfig channelConfig
Channel configuration.
Base host-provided instance type for ak_wwise_plugin_host_data_writer_v1.
Base instance type for providing audio plug-in backend services through ak_wwise_plugin_audio_plugin_...
Windows frontend plug-in API for Audio plug-ins.
virtual bool GetValueUInt32(const char *in_pszPropertyName, uint32_t &out_varProperty) const =0
virtual bool GetValueUInt16(const char *in_pszPropertyName, uint16_t &out_varProperty) const =0
uint32_t decodedFileSize
File size of file when decoded to PCM format, If offline decoding is supported by the codec....
Root interface allowing a logical unit (variable, library) to contain more than one interface.
API specific for source plug-in.
uint32_t GetUInt32(const char *in_pszPropertyName) const
Base host-provided instance to retrieve the related backend instance, as shown in the frontend.
Base host-provided instance type for ak_wwise_plugin_host_v1.
virtual bool SetValueInt32(const char *in_pszPropertyName, int32_t in_varProperty)=0
AK::Wwise::Plugin::IWriteString * error
virtual bool GetValue(const char *in_szPropertyName, AK::WwiseAuthoringAPI::AkVariantBase &out_rValue) const =0
int16_t GetInt16(const char *in_pszPropertyName) const
Generic base for all plug-in instances in C++.
@ Severity_Error
impacting the integrity of the current operation
Base instance type for providing analysis task services through ak_wwise_plugin_analysis_task_v1.
Base host-provided instance type for ak_wwise_plugin_host_conversion_helpers_v1.
API for Sound Engine's Monitor Data notification.
CInterfacePtr InterfacePtr
int ak_wwise_plugin_undo_group_id
Unique identifier for a particular undo group. Useful to reopen an unapplied closed group session.
ak_wwise_plugin_base_interface CBaseInterface
Interface description and base class for every Wwise Authoring plug-in interface.
#define AK_WWISE_PLUGIN_DERIVE_FROM_INSTANCE_BASE
Define a generic instance base, either in C or in C++.
virtual void SetCurrentOperationName(const char *in_szOperationName)=0
virtual bool SetValueString(const char *in_pszPropertyName, const char *in_varProperty)=0
ak_wwise_plugin_undo_group_close_action
Action to apply once this undo group is closed.
virtual bool GetValueString(const char *in_pszPropertyName, const char *&out_varProperty) const =0
float GetReal32(const char *in_pszPropertyName) const
virtual bool IsCancelled() const =0
Check if the user has cancelled the task.
@ LicenseStatus_Unlicensed
No license found.
Base instance type for providing display names to properties through ak_wwise_plugin_property_display...
Plug-in backend instance.
@ Severity_FatalError
impacting the completion of the current operation
Base instance type for providing a device list for your custom sink through ak_wwise_plugin_sink_devi...
Base instance type for providing source-specific information, through ak_wwise_plugin_source_v1.
Base instance type for receiving notifications on host changes events.
ConversionResult
Conversion error code.
Base instance type for providing licensing information, through ak_wwise_plugin_license_v1.
ak_wwise_plugin_widget CWidget
Base instance type for receiving notifications on related Object Store's changes.
Interfaces used to set and get the properties from a plug in.
@ LicenseStatus_Valid
A license is found and is valid.
@ 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...
virtual bool GetValueUInt64(const char *in_pszPropertyName, uint64_t &out_varProperty) const =0
virtual int GetType(const char *in_pszPropertyName) const =0
virtual ~ak_wwise_plugin_cpp_base_instance()
virtual bool SetValueUInt32(const char *in_pszPropertyName, uint32_t in_varProperty)=0
const char * GetString(const char *in_pszPropertyName) const
@ Severity_Warning
potentially impacting the integrity of the current operation
Interface able to receive notifications for custom inner property sets.
Base instance type for receiving Sound Engine's monitoring data.
Base instance type for providing a conversion plug-in through ak_wwise_plugin_conversion_v1.
virtual bool SetValueReal64(const char *in_pszPropertyName, double in_varProperty)=0
@ AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_CANCEL
Close this group session permanently, and cancel all its internal operations. Undo operations are not...
Severity
Log message severity.
IReadWriteProperties * pluginProperties
const IReadOnlyProperties * sourceProperties
Host API to retrieve a link to the plug-in's frontend interfaces.
Wwise API for general Audio Plug-in's backend.
Host API to retrieve a link to the plug-in's backend instance.
AudioFileChannel
Import channel configuration options.
Backend API to specify display names for properties.
virtual bool SetValue(const char *in_szPropertyName, const AK::WwiseAuthoringAPI::AkVariantBase &in_rValue)=0
virtual bool GetValueInt32(const char *in_pszPropertyName, int32_t &out_varProperty) const =0
Base host-provided instance to retrieve the related frontend instances related to the current backend...
Interface description and base class for every Wwise Authoring plug-in interface.
@ Severity_Success
operation was executed without errors or will not produce errors
Base host-provided instance type for reading XML files through ak_wwise_plugin_host_xml_v1.
Base host-provided instance type for ak_wwise_plugin_host_property_set_v1.
A definition of an undo event, with a specific interface and instance.
bool GetBool(const char *in_pszPropertyName) const
Base instance type for providing a Windows frontend for a conversion plug-in through ak_wwise_plugin_...
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.
#define AK_WWISE_PLUGIN_DERIVE_FROM_FRONTEND_INSTANCE(x)
Define an instance type as a frontend.
@ LicenseType_Academic
The license is for academic.
Base host-provided instance type for ak_wwise_plugin_host_object_store_v1.
float downmixNormalizationGain
ak_wwise_plugin_info CPluginInfo
virtual bool SetValueUInt8(const char *in_pszPropertyName, uint8_t in_varProperty)=0
@ Severity_Message
not impacting the integrity of the current operation
@ 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 ...
int64_t GetInt64(const char *in_pszPropertyName) const
A single instantiatable plug-in interface.
Base instance type for providing property-based feedback through ak_wwise_plugin_feedback_aware_v1.
AK::Wwise::Plugin::IProgress * progress
Wwise Authoring Plug-ins - Helper tools, potentially defined elsewhere.
@ Channel_mono_drop_right
@ LicenseStatus_Incompatible
The plugin was made for an older version of Wwise.
Base instance type for receiving notifications on property set's changes.
LicenseStatus
License status.
Base host-provided instance type for writing XML files through ak_wwise_plugin_host_xml_v1.
Backend API to specify licensing requirements.
Backend API to load and save custom data in XML format.
uint32_t uiID
The dialog control resource ID.
@ LicenseType_Purchased
The license was purchased.
virtual bool GetValueInt64(const char *in_pszPropertyName, int64_t &out_varProperty) const =0
virtual bool SetValueInt16(const char *in_pszPropertyName, int16_t in_varProperty)=0
Base instance type for providing a Windows frontend for an audio plug-in through ak_wwise_plugin_gui_...
uint32_t sampleRate
Number of samples per second.
virtual bool GetValueReal32(const char *in_pszPropertyName, float &out_varProperty) const =0
@ LicenseType_Trial
Used for both Trial and Evaluation License handling.
struct ak_wwise_plugin_undo_event_instance_v1 * m_instance
The specific instance usued for that particular undo event.
virtual bool SetValueBool(const char *in_pszPropertyName, bool in_varProperty)=0
uint32_t analysisDataTypes
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