Version

menu_open
Wwise SDK 2023.1.4
AK.Wwise::Plugin::V1::PropertySet Class Reference

Interface used to interact with property sets. More...

#include <HostPropertySet.h>

Inheritance diagram for AK.Wwise::Plugin::V1::PropertySet:
AK.Wwise::Plugin::CBaseInstanceGlue< CHostPropertySet > AK.Wwise::Plugin::CBaseInterfaceGlue< CHostPropertySet >

Public Types

enum  : InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_PROPERTY_SET }
 The interface type, as requested by this plug-in. More...
 
enum  : InterfaceVersion { k_interfaceVersion = 1 }
 The interface version, as requested by this plug-in. More...
 
using Interface = CHostPropertySet
 
- Public Types inherited from AK.Wwise::Plugin::CBaseInstanceGlue< CHostPropertySet >
using Instance = typename CInterface::Instance
 
- Public Types inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostPropertySet >
using GluedInterface = CHostPropertySet
 

Public Member Functions

bool GetValue (const GUID &in_guidPlatform, const char *in_pszPropertyName, AK::WwiseAuthoringAPI::AkVariantBase &out_varProperty) const
 Retrieves the value of a specific property as a variant. More...
 
bool SetValue (const GUID &in_guidPlatform, const char *in_pszPropertyName, const AK::WwiseAuthoringAPI::AkVariantBase &in_varProperty)
 Modifies the value of a specific property as a variant. More...
 
bool HasPropertyValue (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns true if the specified property exists. More...
 
bool PropertyHasRTPC (const char *in_pszPropertyName) const
 Get the RTPC binding status for the specified property. More...
 
bool PropertyHasState (const char *in_pszPropertyName) const
 Returns whether the specified property is bound to a state object. More...
 
bool PropertyHasLinked (const char *in_pszPropertyName) const
 Returns whether the specified property has at least some linked platforms. More...
 
bool PropertyHasUnlinked (const char *in_pszPropertyName) const
 Returns whether the specified property has at least some platforms that are not linked. More...
 
bool PropertyPlatformIsLinked (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns whether the specified property's platform is linked. More...
 
const GUIDGetID () const
 Returns the internal unique identifier of the corresponding object. More...
 
int GetType (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Retrieves the type of a specific property. More...
 
bool ClearValue (const GUID &in_guidPlatform, const char *in_pszPropertyName)
 Resets a property value to its default. More...
 
bool SetValueString (const GUID &in_guidPlatform, const char *in_pszPropertyName, const char *in_propertyValue)
 Modifies a property to a string value. More...
 
bool SetValueInt64 (const GUID &in_guidPlatform, const char *in_pszPropertyName, int64_t in_propertyValue)
 Modifies a property to a 64-bit signed integer value. More...
 
bool SetValueInt32 (const GUID &in_guidPlatform, const char *in_pszPropertyName, int32_t in_propertyValue)
 Modifies a property to a 32-bit signed integer value. More...
 
bool SetValueInt16 (const GUID &in_guidPlatform, const char *in_pszPropertyName, int16_t in_propertyValue)
 Modifies a property to a 16-bit signed integer value. More...
 
bool SetValueInt8 (const GUID &in_guidPlatform, const char *in_pszPropertyName, int8_t in_propertyValue)
 Modifies a property to an 8-bit signed integer value. (Future use) More...
 
bool SetValueUInt64 (const GUID &in_guidPlatform, const char *in_pszPropertyName, uint64_t in_propertyValue)
 Modifies a property to a 64-bit unsigned integer value. (Future use) More...
 
bool SetValueUInt32 (const GUID &in_guidPlatform, const char *in_pszPropertyName, uint32_t in_propertyValue)
 Modifies a property to a 32-bit unsigned integer value. (Future use) More...
 
bool SetValueUInt16 (const GUID &in_guidPlatform, const char *in_pszPropertyName, uint16_t in_propertyValue)
 Modifies a property to a 16-bit unsigned integer value. (Future use) More...
 
bool SetValueUInt8 (const GUID &in_guidPlatform, const char *in_pszPropertyName, uint8_t in_propertyValue)
 Modifies a property to an 8-bit unsigned integer value. (Future use) More...
 
bool SetValueReal64 (const GUID &in_guidPlatform, const char *in_pszPropertyName, double in_propertyValue)
 Modifies a property to a 64-bit floating point value. More...
 
bool SetValueReal32 (const GUID &in_guidPlatform, const char *in_pszPropertyName, float in_propertyValue)
 Modifies a property to a 32-bit floating point value. More...
 
bool SetValueBool (const GUID &in_guidPlatform, const char *in_pszPropertyName, bool in_propertyValue)
 Modifies a property to a boolean value. More...
 
bool GetValueString (const GUID &in_guidPlatform, const char *in_pszPropertyName, const char *&out_propertyValue) const
 Retrieves the string value of a specific property. More...
 
bool GetValueInt64 (const GUID &in_guidPlatform, const char *in_pszPropertyName, int64_t &out_propertyValue) const
 Retrieves the 64-bit signed integer value of a specific property. More...
 
bool GetValueInt32 (const GUID &in_guidPlatform, const char *in_pszPropertyName, int32_t &out_propertyValue) const
 Retrieves the 32-bit signed integer value of a specific property. More...
 
bool GetValueInt16 (const GUID &in_guidPlatform, const char *in_pszPropertyName, int16_t &out_propertyValue) const
 Retrieves the 16-bit signed integer value of a specific property. More...
 
bool GetValueInt8 (const GUID &in_guidPlatform, const char *in_pszPropertyName, int8_t &out_propertyValue) const
 Retrieves the 8-bit signed integer value of a specific property. (Future use) More...
 
bool GetValueUInt64 (const GUID &in_guidPlatform, const char *in_pszPropertyName, uint64_t &out_propertyValue) const
 Retrieves the 64-bit unsigned integer value of a specific property. (Future use) More...
 
bool GetValueUInt32 (const GUID &in_guidPlatform, const char *in_pszPropertyName, uint32_t &out_propertyValue) const
 Retrieves the 32-bit unsigned integer value of a specific property. (Future use) More...
 
bool GetValueUInt16 (const GUID &in_guidPlatform, const char *in_pszPropertyName, uint16_t &out_propertyValue) const
 Retrieves the 16-bit unsigned integer value of a specific property. (Future use) More...
 
bool GetValueUInt8 (const GUID &in_guidPlatform, const char *in_pszPropertyName, uint8_t &out_propertyValue) const
 Retrieves the 8-bit unsigned integer value of a specific property. (Future use) More...
 
bool GetValueReal64 (const GUID &in_guidPlatform, const char *in_pszPropertyName, double &out_propertyValue) const
 Retrieves the 64-bit floating point value of a specific property. More...
 
bool GetValueReal32 (const GUID &in_guidPlatform, const char *in_pszPropertyName, float &out_propertyValue) const
 Retrieves the 32-bit floating point value of a specific property. More...
 
bool GetValueBool (const GUID &in_guidPlatform, const char *in_pszPropertyName, bool &out_propertyValue) const
 Retrieves the boolean value of a specific property. More...
 
const char * GetString (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Retrieves the string value of a specific property and returns the value as a temporary pointer. More...
 
int64_t GetInt64 (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns the 64-bit signed integer value of a specific property. More...
 
int32_t GetInt32 (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns the 32-bit signed integer value of a specific property. More...
 
int16_t GetInt16 (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns the 16-bit signed integer value of a specific property. More...
 
int8_t GetInt8 (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns the 8-bit signed integer value of a specific property. More...
 
uint64_t GetUInt64 (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns the 64-bit unsigned integer value of a specific property. More...
 
uint32_t GetUInt32 (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns the 32-bit unsigned integer value of a specific property. More...
 
uint16_t GetUInt16 (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns the 16-bit unsigned integer value of a specific property. More...
 
uint8_t GetUInt8 (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns the 8-bit unsigned integer value of a specific property. More...
 
double GetReal64 (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns the 64-bit floating point value of a specific property. More...
 
float GetReal32 (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns the 32-bit floating point value of a specific property. More...
 
bool GetBool (const GUID &in_guidPlatform, const char *in_pszPropertyName) const
 Returns the boolean value of a specific property. More...
 

Additional Inherited Members

- Static Public Attributes inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostPropertySet >
static GluedInterfaceg_cinterface
 The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host once loaded. More...
 

Detailed Description

Interface used to interact with property sets.

A property set is a dictionary of properties, as stored inside a user's Authoring project. Whenever a property name is specified, it corresponds to the property name as set in the plug-in's XML definition file.

By default, Authoring will provide a property set, as defined in the XML definition file. It is possible to have more than one property set by requesting ak_wwise_plugin_host_object_store_v1, and adding InnerTypes in the XML definition file.

This interface supports both the unique default property set, as well as Object Store's inner property sets.

You can also subscribe to notifications through ak_wwise_plugin_notifications_property_set_v1 in order to be informed when some property set values changed.

Note: Most methods assume you acquired access to a platform as a GUID; either provided by the caller function, or retrieved through the Host interface.
The usual providers of this GUID are \ref ak_wwise_plugin_audio_plugin_v1::GetBankParameters
and \ref ak_wwise_plugin_audio_plugin_v1::GetPluginData method parameters.

You can also poll up-to-date GUIDs from \ref ak_wwise_plugin_host_v1 methods, such as
\ref ak_wwise_plugin_host_v1::GetCurrentPlatform.

Finally, you can also provide GUID_NULL as a parameter, which will access data for all platforms at
once (linked value). This is adequate only in certain cases where no platform-specific data is
possible for a value. Using the current platform is always the preferred method of access. 
See also

Definition at line 1051 of file HostPropertySet.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