Table of Contents

Wwise SDK 2021.1.2
ak_wwise_plugin_host_property_set_v1 Struct Reference

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

#include <HostPropertySet.h>

Inheritance diagram for ak_wwise_plugin_host_property_set_v1:
ak_wwise_plugin_interface_ptr

Public Types

using  Instance = ak_wwise_plugin_host_property_set_instance_v1
  Base host-provided instance type for ak_wwise_plugin_host_property_set_v1. More...
 

Public Member Functions

  ak_wwise_plugin_host_property_set_v1 ()
 
- Public Member Functions inherited from ak_wwise_plugin_interface_ptr
constexpr  ak_wwise_plugin_base_interface (decltype(m_interface) in_interface, decltype(m_version) in_version)
 
constexpr  ak_wwise_plugin_base_interface ()
 
constexpr  ak_wwise_plugin_base_interface (std::underlying_type< decltype(m_interface)>::type in_interface, decltype(m_version) in_version)
 

Public Attributes

bool(*  GetValue )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, AK::WwiseAuthoringAPI::AkVariantBase *out_varProperty)
  Retrieves the value of a specific property as a variant. More...
 
bool(*  SetValue )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, 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 struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName)
  Returns true if the specified property exists. More...
 
bool(*  PropertyHasRTPC )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const char *in_pszPropertyName)
  Get the RTPC binding status for the specified property. More...
 
bool(*  PropertyHasState )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const char *in_pszPropertyName)
  Returns whether the specified property is bound to a state object. More...
 
bool(*  PropertyHasLinked )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const char *in_pszPropertyName)
  Returns whether the specified property has at least some linked platforms. More...
 
bool(*  PropertyHasUnlinked )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const char *in_pszPropertyName)
  Returns whether the specified property has at least some platforms that are not linked. More...
 
bool(*  PropertyPlatformIsLinked )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName)
  Returns whether the specified property's platform is linked. More...
 
const GUID *(*  GetID )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this)
  Returns the internal unique identifier of the corresponding object. More...
 
int(*  GetType )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName)
  Retrieves the type of a specific property. More...
 
bool(*  ClearValue )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName)
  Resets a property value to its default. More...
 
bool(*  SetValueString )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, const char *in_propertyValue)
  Modifies a property to a string value. More...
 
bool(*  SetValueInt64 )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, 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 )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, 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 )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, 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 )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, 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 )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, 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 )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, 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 )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, 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 )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, 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 )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, double in_propertyValue)
  Modifies a property to a 64-bit floating point value. More...
 
bool(*  SetValueReal32 )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, float in_propertyValue)
  Modifies a property to a 32-bit floating point value. More...
 
bool(*  SetValueBool )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, bool in_propertyValue)
  Modifies a property to a boolean value. More...
 
bool(*  GetValueString )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, const char **out_propertyValue)
  Retrieves the string value of a specific property. More...
 
bool(*  GetValueInt64 )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, int64_t *out_propertyValue)
  Retrieves the 64-bit signed integer value of a specific property. More...
 
bool(*  GetValueInt32 )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, int32_t *out_propertyValue)
  Retrieves the 32-bit signed integer value of a specific property. More...
 
bool(*  GetValueInt16 )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, int16_t *out_propertyValue)
  Retrieves the 16-bit signed integer value of a specific property. More...
 
bool(*  GetValueInt8 )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, int8_t *out_propertyValue)
  Retrieves the 8-bit signed integer value of a specific property. (Future use) More...
 
bool(*  GetValueUInt64 )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, uint64_t *out_propertyValue)
  Retrieves the 64-bit unsigned integer value of a specific property. (Future use) More...
 
bool(*  GetValueUInt32 )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, uint32_t *out_propertyValue)
  Retrieves the 32-bit unsigned integer value of a specific property. (Future use) More...
 
bool(*  GetValueUInt16 )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, uint16_t *out_propertyValue)
  Retrieves the 16-bit unsigned integer value of a specific property. (Future use) More...
 
bool(*  GetValueUInt8 )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, uint8_t *out_propertyValue)
  Retrieves the 8-bit unsigned integer value of a specific property. (Future use) More...
 
bool(*  GetValueReal64 )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, double *out_propertyValue)
  Retrieves the 64-bit floating point value of a specific property. More...
 
bool(*  GetValueReal32 )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, float *out_propertyValue)
  Retrieves the 32-bit floating point value of a specific property. More...
 
bool(*  GetValueBool )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName, bool *out_propertyValue)
  Retrieves the boolean value of a specific property. More...
 
- Public Attributes inherited from ak_wwise_plugin_interface_ptr
ak_wwise_plugin_interface_type  m_interface: 32
  Interface type (see ak_wwise_plugin_interface_type) More...
 
uint32_t  m_version: 32
  Version of the interface. 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 76 of file HostPropertySet.h.