Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2022.1.17.8543 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2022.1.17
Utilities.h
Audiokinetic namespace.
virtual void Destroy()=0
@ LicenseType_Purchased
The license was purchased.
Definition: Utilities.h:87
@ ConversionWarning
Definition: Utilities.h:191
virtual void ErrorMessage(const CStringW &in_rErrorText, Severity in_eSeverity=Severity_Warning)=0
UINT uiID
The dialog control resource ID.
Definition: Utilities.h:168
@ Severity_FatalError
impacting the completion of the current operation
Definition: Utilities.h:108
@ Severity_Message
not impacting the integrity of the current operation
Definition: Utilities.h:105
@ ConversionFailed
Definition: Utilities.h:192
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
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.
@ LicenseType_Trial
Used for both Trial and Evaluation License handling.
Definition: Utilities.h:86
ConversionResult
Conversion error code.
Definition: Utilities.h:189
@ LicenseStatus_Valid
A license is found and is valid.
Definition: Utilities.h:96
LicenseType
License type.
Definition: Utilities.h:85
LPCWSTR pszProp
The property name.
Definition: Utilities.h:169
@ Severity_Warning
potentially impacting the integrity of the current operation
Definition: Utilities.h:106
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:104
virtual bool WriteByte(BYTE in_bByte)=0
@ ConversionSuccess
Definition: Utilities.h:190
virtual void WriteString(LPCWSTR in_szString, int in_iStringLength)=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.
@ LicenseType_Academic
The license is for academic.
Definition: Utilities.h:88
LicenseStatus
License status.
Definition: Utilities.h:93
@ LicenseStatus_Expired
A license is found, but is expired.
Definition: Utilities.h:95
Interfaces used to set and get the properties from a plug in.
Definition: Utilities.h:123
virtual void SetCurrentOperationName(LPCWSTR in_szOperationName)=0
virtual bool WriteReal64(double in_dblReal64)=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
@ Severity_Error
impacting the integrity of the current operation
Definition: Utilities.h:107
virtual bool WriteReal32(float in_fReal32)=0
@ LicenseStatus_Incompatible
The plugin was made for an older version of Wwise.
Definition: Utilities.h:98
Severity
Log message severity.
Definition: Utilities.h:103
@ LicenseStatus_Unlicensed
No license found.
Definition: Utilities.h:94

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