Wwise SDK 2019.1.11
_utilities_8h_source
Version
menu_open
link
Utilities.h
102 };
112 };
168 virtual void ErrorMessage( const CString& in_rErrorText, Severity in_eSeverity = Severity_Warning ) = 0;
250 /// Your run-time plug-in receives a blob of data (AK::IAkPluginParam::Init() and AK::IAkPluginParam::SetParamsBlock())
256 /// "String" properties (as defined in the plugin's XML Description File - refer to \ref plugin_xml
257 /// for more details) are utf-16 encoded. While you are free to store this string in soundbanks as
259 /// connect the authoring tool to the sound engine. Thus, WriteUtf16String() is the preferred method
271 /// "String" properties (as defined in the plugin's XML Description File - refer to \ref plugin_xml
272 /// for more details) are utf-16 encoded. While you are free to store this string in soundbanks as
273 /// as an ansi string (using WritePascalString()), AK::IAkPluginParam::SetParam() will be passed
virtual bool WriteUtf16String(LPCWSTR in_szString)=0
virtual void Destroy()=0
Add support for a second progress bar to the IProgress interfaces.
Definition: Utilities.h:173
Definition: Utilities.h:207
Definition: Utilities.h:236
virtual bool IsCancelled()=0
Check if the user has cancelled the task.
virtual bool WriteInt16(UINT16 in_uiInt16)=0
virtual bool WriteUtf8String(const char *in_szString)=0
Definition: Utilities.h:128
virtual bool WriteData(LPCVOID in_pData, UINT32 in_cBytes, UINT32 &out_cWritten)=0
virtual void NotifyProgress(DWORD in_dwProgress)=0
Notify of the advancement of the task.
@ Severity_Warning
potentially impacting the integrity of the current operation
Definition: Utilities.h:119
virtual bool SetValue(LPCWSTR in_szPropertyName, const VARIANT &in_rValue)=0
@ Severity_Success
operation was executed without errors or will not produce errors
Definition: Utilities.h:117
virtual bool WriteByte(BYTE in_bByte)=0
virtual void WriteString(LPCWSTR in_szString, int in_iStringLength)=0
virtual bool WritePascalString(LPCWSTR in_szString, UINT32 in_uiStringLength)=0
virtual bool WriteInt32(UINT32 in_uiInt32)=0
virtual void SetRange(DWORD in_dwMinValue, DWORD in_dwMaxValue)=0
Should be called at the beginning of the operation to set the min and max value.
virtual void SetSecondOperationName(LPCWSTR in_szOperationName)=0
Definition: Utilities.h:150
Definition: Utilities.h:143
Interfaces used to set and get the properties from a plug in.
Definition: Utilities.h:136
virtual void SetCurrentOperationName(LPCWSTR in_szOperationName)=0
virtual void NotifySecondProgress(DWORD in_dwProgress)=0
Notify of the advancement of the task.
virtual void SetSecondRange(DWORD in_dwMinValue, DWORD in_dwMaxValue)=0
virtual bool WriteReal64(double in_dblReal64)=0
virtual void ErrorMessage(const CString &in_rErrorText, Severity in_eSeverity=Severity_Warning)=0
virtual bool GetValue(LPCWSTR in_szPropertyName, VARIANT &out_rValue) const =0
virtual bool WriteBool(bool in_bBool)=0
virtual bool WriteInt64(UINT64 in_uiInt64)=0
Definition: Utilities.h:197
virtual bool WriteReal32(float in_fReal32)=0
@ LicenseStatus_Incompatible
The plugin was made for an older version of Wwise.
Definition: Utilities.h:111
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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