Version

menu_open
Wwise SDK 2023.1.4
AK.Wwise::IPluginPropertySet Class Referenceabstract

#include <AudioPlugin.h>

Public Member Functions

virtual bool GetValue (const GUID &in_guidPlatform, LPCWSTR in_pszPropertyName, VARIANT &out_varProperty)=0
 
virtual bool SetValue (const GUID &in_guidPlatform, LPCWSTR in_pszPropertyName, const VARIANT &in_varProperty)=0
 
virtual bool PropertyHasRTPC (LPCWSTR in_pszPropertyName)=0
 
virtual GUID GetCurrentPlatform ()=0
 
virtual BasePlatformID GetCurrentBasePlatform ()=0
 
virtual BasePlatformID GetDefaultNativeAuthoringPlaybackPlatform ()=0
 This function is called To retrieve the base platforms of the authoring tool. More...
 
virtual GUID GetAuthoringPlaybackPlatform ()=0
 This function is called To retrieve the custom platform being used to run while in authoring. More...
 
virtual void NotifyInternalDataChanged (AkPluginParamID in_idData, bool in_bMakeProjectDirty=true)=0
 
virtual bool CanLogUndos ()=0
 
virtual AK::Wwise::IUndoManager * GetUndoManager ()=0
 
virtual void GetLicenseStatus (const GUID &in_guidPlatform, AK::Wwise::LicenseType &out_eType, AK::Wwise::LicenseStatus &out_eStatus, UINT32 &out_uDaysToExpiry)=0
 Obtain licensing status for the plug-in. Refer to Managing Licenses for more information. More...
 
virtual void GetAssetLicenseStatus (const GUID &in_guidPlatform, AkUInt32 in_uAssetID, AK::Wwise::LicenseType &out_eType, AK::Wwise::LicenseStatus &out_eStatus, UINT32 &out_uDaysToExpiry)=0
 Obtain licensing status for a plug-in-specific asset ID. Refer to Managing Licenses for more information. More...
 
virtual const GUIDGetID () const =0
 Obtain the unique identifier of the corresponding IWObject. More...
 
virtual void WaapiCall (const char *in_szUri, const char *in_szArgs, const char *in_szOptions, AK::IAkPluginMemAlloc *in_pAlloc, char *&out_szResults, char *&out_szError) const =0
 Find and call the specified procedure. Calls made using this function are always blocking. More...
 

Detailed Description

Plug-in property set interface. An instance of this class is created and assigned to each plug-in, which in turn can use it to manage its properties. Whenever a property name is specified, it corresponds to the property name set in the plug-in's XML definition file.

Warning: The functions in this interface are not thread-safe, unless stated otherwise.
See also

Definition at line 87 of file AudioPlugin.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