Wwise SDK 2021.1.14
版本
menu_open
link
HostPropertySet.h
Go to the documentation of this file.
41 * A property set is a dictionary of properties, as stored inside a user's Authoring project. Whenever a
45 * By default, Authoring will provide a property set, as defined in the XML definition file. It is
46 * possible to have more than one property set by requesting ak_wwise_plugin_host_object_store_v1, and
52 * You can also subscribe to notifications through ak_wwise_plugin_notifications_property_set_v1 in order to
56 * Most methods assume you acquired access to a platform as a GUID; either provided by the caller function,
65 * Finally, you can also provide GUID_NULL as a parameter, which will access data for all platforms at
113 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
158 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
174 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
187 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
202 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
216 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
225 * \brief Returns whether the specified property has at least some platforms that are not linked.
230 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
245 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
259 * For inner property sets, as defined in Object Stores, that value is dynamic and only valid for
283 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
300 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
331 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
364 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
397 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
430 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
464 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
498 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
532 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
566 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
600 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
633 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
666 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
699 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
727 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
750 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
772 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
794 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
817 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
840 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
863 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
886 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
909 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
931 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
953 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
975 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1037 AK_WWISE_PLUGIN_BASE_INTERFACE_FROM_ID(AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_PROPERTY_SET, 1)
1038 #define AK_WWISE_PLUGIN_NOTIFICATIONS_PROPERTY_SET_V1_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
1040 .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_NOTIFICATIONS_PROPERTY_SET_V1_ID(), in_pluginInfo, in_data) \
1066 };
1076 };
1097 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1107 return MKBOOL(g_cinterface->GetValue(this, &in_guidPlatform, in_pszPropertyName, &out_varProperty));
1143 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1153 return MKBOOL(g_cinterface->SetValue(this, &in_guidPlatform, in_pszPropertyName, &in_varProperty));
1160 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1174 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1190 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1205 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1216 * \brief Returns whether the specified property has at least some platforms that are not linked.
1220 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1236 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1244 return MKBOOL(g_cinterface->PropertyPlatformIsLinked(this, &in_guidPlatform, in_pszPropertyName));
1252 * For inner property sets, as defined in Object Stores, that value is dynamic and only valid for
1275 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1293 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1325 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1335 return MKBOOL(g_cinterface->SetValueString(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1359 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1369 return MKBOOL(g_cinterface->SetValueInt64(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1393 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1403 return MKBOOL(g_cinterface->SetValueInt32(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1427 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1437 return MKBOOL(g_cinterface->SetValueInt16(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1462 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1472 return MKBOOL(g_cinterface->SetValueInt8(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1497 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1507 return MKBOOL(g_cinterface->SetValueUInt64(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1532 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1542 return MKBOOL(g_cinterface->SetValueUInt32(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1567 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1577 return MKBOOL(g_cinterface->SetValueUInt16(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1602 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1612 return MKBOOL(g_cinterface->SetValueUInt8(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1636 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1646 return MKBOOL(g_cinterface->SetValueReal64(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1670 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1680 return MKBOOL(g_cinterface->SetValueReal32(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1704 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1714 return MKBOOL(g_cinterface->SetValueBool(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1733 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1744 return MKBOOL(g_cinterface->GetValueString(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1757 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1767 return MKBOOL(g_cinterface->GetValueInt64(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1780 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1790 return MKBOOL(g_cinterface->GetValueInt32(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1803 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1813 return MKBOOL(g_cinterface->GetValueInt16(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1827 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1837 return MKBOOL(g_cinterface->GetValueInt8(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1851 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1861 return MKBOOL(g_cinterface->GetValueUInt64(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1875 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1885 return MKBOOL(g_cinterface->GetValueUInt32(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1899 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1909 return MKBOOL(g_cinterface->GetValueUInt16(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1923 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1933 return MKBOOL(g_cinterface->GetValueUInt8(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1946 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1956 return MKBOOL(g_cinterface->GetValueReal64(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1969 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1979 return MKBOOL(g_cinterface->GetValueReal32(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1992 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
2002 return MKBOOL(g_cinterface->GetValueBool(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
2006 * \brief Retrieves the string value of a specific property and returns the value as a temporary pointer.
2024 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2050 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2076 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2102 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2129 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2156 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2183 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2210 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2237 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2263 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2289 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2315 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2351 };
2361 };
2425 * Deriving your plug-in class from RequestPropertySet will automatically request both PropertySet and
2426 * Notifications::PropertySet_ interfaces. From this point, you will be able to derive from the virtual
2427 * functions as defined in Notifications::PropertySet_, and access the host-provided functions in the
2430 * This is also useful when you want to access inner property sets from the ObjectStore interface.
2433 * \aknote The AK::Wwise::Plugin::RequestPropertySet and AK::Wwise::Plugin::RequestWrite classes are automatically
2455 AK_WWISE_PLUGIN_SPECIALIZE_HOST_INTERFACE(PropertySet, propertySet,, public Notifications::PropertySet);
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.
Definition: HostPropertySet.h:1147
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)
Definition: HostPropertySet.h:502
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)
Definition: HostPropertySet.h:1831
@ k_interfaceVersion
The interface version, as provided by this plug-in.
Definition: HostPropertySet.h:2360
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.
Definition: HostPropertySet.h:335
@ k_interfaceType
The interface type, as requested by this plug-in.
Definition: HostPropertySet.h:1065
int64_t GetInt64(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the 64-bit signed integer value of a specific property.
Definition: HostPropertySet.h:2053
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_PROPERTY_SET
2021.1 Property Set host service. ak_wwise_plugin_host_property_set_v1
Definition: PluginBaseInterface.h:81
int GetType(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Retrieves the type of a specific property.
Definition: HostPropertySet.h:1278
bool SetValueString(const GUID &in_guidPlatform, const char *in_pszPropertyName, const char *in_propertyValue)
Modifies a property to a string value.
Definition: HostPropertySet.h:1329
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)
Definition: HostPropertySet.h:604
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.
Definition: HostPropertySet.h:177
virtual void NotifyPropertyChanged(const GUID &in_guidPlatform, const char *in_pszPropertyName)
This function is called by Wwise when a plug-in property changes.
Definition: HostPropertySet.h:2415
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.
Definition: HostPropertySet.h:935
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.
Definition: HostPropertySet.h:233
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.
Definition: HostPropertySet.h:286
static GluedInterface * g_cinterface
The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host onc...
Definition: PluginInfoGenerator.h:90
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.
Definition: HostPropertySet.h:1761
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)
Definition: HostPropertySet.h:1536
const GUID * GetID() const
Returns the internal unique identifier of the corresponding object.
Definition: HostPropertySet.h:1263
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface.
Definition: PluginInfoGenerator.h:51
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)
Definition: HostPropertySet.h:1501
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.
Definition: HostPropertySet.h:117
int8_t GetInt8(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the 8-bit signed integer value of a specific property.
Definition: HostPropertySet.h:2132
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.
Definition: HostPropertySet.h:957
uint16_t GetUInt16(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the 16-bit unsigned integer value of a specific property.
Definition: HostPropertySet.h:2213
RequestedHostInterface< PropertySet > RequestPropertySet
Requests a PropertySet interface, provided as m_propertySet variable.
Definition: HostPropertySet.h:2436
const CPropertySet_::Instance * GetInstancePointer() const
Definition: HostPropertySet.h:2390
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)
Definition: HostPropertySet.h:1466
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.
Definition: HostPropertySet.h:219
bool PropertyHasUnlinked(const char *in_pszPropertyName) const
Returns whether the specified property has at least some platforms that are not linked.
Definition: HostPropertySet.h:1223
@ k_interfaceType
The interface type, as provided by this plug-in.
Definition: HostPropertySet.h:2350
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.
Definition: HostPropertySet.h:2027
int32_t GetInt32(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the 32-bit signed integer value of a specific property.
Definition: HostPropertySet.h:2079
ak_wwise_plugin_notifications_property_set_instance_v1 Instance
Base instance type for receiving notifications on property set's changes.
Definition: HostPropertySet.h:999
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.
Definition: HostPropertySet.h:205
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)
Definition: HostPropertySet.h:844
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.
Definition: HostPropertySet.h:637
The C interface, fulfilled by your plug-in.
Definition: HostPropertySet.h:2367
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)
Definition: HostPropertySet.h:821
bool SetValueInt32(const GUID &in_guidPlatform, const char *in_pszPropertyName, int32_t in_propertyValue)
Modifies a property to a 32-bit signed integer value.
Definition: HostPropertySet.h:1397
uint64_t GetUInt64(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the 64-bit unsigned integer value of a specific property.
Definition: HostPropertySet.h:2159
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.
Definition: HostPropertySet.h:979
void(* NotifyPropertyChanged)(struct ak_wwise_plugin_notifications_property_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszPropertyName)
This function is called by Wwise when a plug-in property changes.
Definition: HostPropertySet.h:1021
double GetReal64(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the 64-bit floating point value of a specific property.
Definition: HostPropertySet.h:2266
bool ClearValue(const GUID &in_guidPlatform, const char *in_pszPropertyName)
Resets a property value to its default.
Definition: HostPropertySet.h:1296
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.
Definition: HostPropertySet.h:754
InterfacePtr GetInterfacePointer()
Definition: HostPropertySet.h:2383
bool GetValueString(const GUID &in_guidPlatform, const char *in_pszPropertyName, const char *&out_propertyValue) const
Retrieves the string value of a specific property.
Definition: HostPropertySet.h:1738
bool SetValueReal32(const GUID &in_guidPlatform, const char *in_pszPropertyName, float in_propertyValue)
Modifies a property to a 32-bit floating point value.
Definition: HostPropertySet.h:1674
bool GetBool(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the boolean value of a specific property.
Definition: HostPropertySet.h:2318
const GUID *(* GetID)(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this)
Returns the internal unique identifier of the corresponding object.
Definition: HostPropertySet.h:271
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.
Definition: HostPropertySet.h:368
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)
Definition: HostPropertySet.h:1903
Wwise Authoring Plug-ins - C++ class helper to automatically determine the plug-in interfaces used in...
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)
Definition: HostPropertySet.h:536
bool GetValueBool(const GUID &in_guidPlatform, const char *in_pszPropertyName, bool &out_propertyValue) const
Retrieves the boolean value of a specific property.
Definition: HostPropertySet.h:1996
PluginInfoGenerator: Associates an existing C Interface with a variable that can be used....
Definition: PluginInfoGenerator.h:105
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.
Definition: HostPropertySet.h:434
ak_wwise_plugin_host_property_set_v1 CHostPropertySet
Definition: HostPropertySet.h:1049
@ k_interfaceVersion
The interface version, as requested by this plug-in.
Definition: HostPropertySet.h:1075
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.
Definition: HostPropertySet.h:732
int16_t GetInt16(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the 16-bit signed integer value of a specific property.
Definition: HostPropertySet.h:2105
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.
Definition: HostPropertySet.h:798
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_PROPERTY_SET
2021.1 Property Set modification notification. ak_wwise_plugin_notifications_property_set_v1
Definition: PluginBaseInterface.h:68
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.
Definition: HostPropertySet.h:162
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.
Definition: HostPropertySet.h:776
bool PropertyHasLinked(const char *in_pszPropertyName) const
Returns whether the specified property has at least some linked platforms.
Definition: HostPropertySet.h:1208
bool PropertyHasRTPC(const char *in_pszPropertyName) const
Get the RTPC binding status for the specified property.
Definition: HostPropertySet.h:1177
ak_wwise_plugin_notifications_property_set_v1()
Definition: HostPropertySet.h:1001
uint32_t GetUInt32(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the 32-bit unsigned integer value of a specific property.
Definition: HostPropertySet.h:2186
Interface used to interact with property sets.
Definition: HostPropertySet.h:80
uint8_t GetUInt8(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the 8-bit unsigned integer value of a specific property.
Definition: HostPropertySet.h:2240
Interface()
Definition: HostPropertySet.h:2369
float GetReal32(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the 32-bit floating point value of a specific property.
Definition: HostPropertySet.h:2292
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface.
Definition: PluginInfoGenerator.h:50
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.
Definition: HostPropertySet.h:1973
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)
Definition: HostPropertySet.h:1571
bool SetValueInt16(const GUID &in_guidPlatform, const char *in_pszPropertyName, int16_t in_propertyValue)
Modifies a property to a 16-bit signed integer value.
Definition: HostPropertySet.h:1431
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)
Definition: HostPropertySet.h:1855
PropertySet_()
Definition: HostPropertySet.h:2394
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.
Definition: HostPropertySet.h:1807
bool SetValueBool(const GUID &in_guidPlatform, const char *in_pszPropertyName, bool in_propertyValue)
Modifies a property to a boolean value.
Definition: HostPropertySet.h:1708
ak_wwise_plugin_host_property_set_v1()
Definition: HostPropertySet.h:88
Interface used to interact with property sets.
Definition: HostPropertySet.h:1053
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
bool PropertyPlatformIsLinked(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns whether the specified property's platform is linked.
Definition: HostPropertySet.h:1239
virtual ~PropertySet_()
Definition: HostPropertySet.h:2399
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)
Definition: HostPropertySet.h:1879
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)
Definition: HostPropertySet.h:913
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:117
bool SetValueInt64(const GUID &in_guidPlatform, const char *in_pszPropertyName, int64_t in_propertyValue)
Modifies a property to a 64-bit signed integer value.
Definition: HostPropertySet.h:1363
ak_wwise_plugin_notifications_property_set_v1 CPropertySet_
Definition: HostPropertySet.h:2331
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.
Definition: HostPropertySet.h:190
bool SetValueReal64(const GUID &in_guidPlatform, const char *in_pszPropertyName, double in_propertyValue)
Modifies a property to a 64-bit floating point value.
Definition: HostPropertySet.h:1640
Base host-provided instance type for ak_wwise_plugin_host_property_set_v1.
Definition: PluginDef.h:644
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.
Definition: HostPropertySet.h:303
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)
Definition: HostPropertySet.h:1606
CPropertySet_::Instance * GetInstancePointer()
Definition: HostPropertySet.h:2387
bool PropertyHasState(const char *in_pszPropertyName) const
Returns whether the specified property is bound to a state object.
Definition: HostPropertySet.h:1193
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)
Definition: HostPropertySet.h:570
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.
Definition: HostPropertySet.h:401
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)
Definition: HostPropertySet.h:468
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.
Definition: HostPropertySet.h:248
Base instance type for receiving notifications on property set's changes.
Definition: PluginDef.h:845
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.
Definition: HostPropertySet.h:703
#define AK_WWISE_PLUGIN_SPECIALIZE_HOST_INTERFACE(in_name, in_varname,...)
PluginInfoGenerator: Creates a C++ host specialization for interface class specified in in_name,...
Definition: PluginInfoGenerator.h:238
V1::Notifications::PropertySet_ PropertySet
Latest version of the C++ PropertySet notification interface.
Definition: HostPropertySet.h:2452
bool HasPropertyValue(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns true if the specified property exists.
Definition: HostPropertySet.h:1163
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.
Definition: HostPropertySet.h:670
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.
Definition: HostPropertySet.h:1950
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.
Definition: HostPropertySet.h:1101
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)
Definition: HostPropertySet.h:867
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)
Definition: HostPropertySet.h:1927
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)
Definition: HostPropertySet.h:890
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.
Definition: HostPropertySet.h:1784
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)
Definition: PluginHelpers.h:46
Definition: AudioPlugin.h:112