Wwise SDK
_host_property_set_8h_source
版本
menu_open
link
HostPropertySet.h
浏览该文件的文档.
40 * A property set is a dictionary of properties, as stored inside a user's Authoring project. Whenever a
44 * By default, Authoring will provide a property set, as defined in the XML definition file. It is
45 * possible to have more than one property set by requesting ak_wwise_plugin_host_object_store_v1, and
51 * You can also subscribe to notifications through ak_wwise_plugin_notifications_property_set_v1 in order to
55 * Most methods assume you acquired access to a platform as a GUID; either provided by the caller function,
64 * Finally, you can also provide GUID_NULL as a parameter, which will access data for all platforms at
112 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
157 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
173 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
186 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
201 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
215 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
224 * \brief Returns whether the specified property has at least some platforms that are not linked.
229 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
244 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
258 * For inner property sets, as defined in Object Stores, that value is dynamic and only valid for
282 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
299 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
330 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
363 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
396 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
429 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
463 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
497 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
531 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
565 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
599 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
632 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
665 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
698 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
726 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
749 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
771 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
793 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
816 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
839 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
862 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
885 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
908 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
930 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
952 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
974 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1036 AK_WWISE_PLUGIN_BASE_INTERFACE_FROM_ID(AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_PROPERTY_SET, 1)
1037 #define AK_WWISE_PLUGIN_NOTIFICATIONS_PROPERTY_SET_V1_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
1039 .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_NOTIFICATIONS_PROPERTY_SET_V1_ID(), in_pluginInfo, in_data) \
1065 };
1075 };
1096 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1106 return MKBOOL(g_cinterface->GetValue(this, &in_guidPlatform, in_pszPropertyName, &out_varProperty));
1142 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1152 return MKBOOL(g_cinterface->SetValue(this, &in_guidPlatform, in_pszPropertyName, &in_varProperty));
1159 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1173 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1189 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1204 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1215 * \brief Returns whether the specified property has at least some platforms that are not linked.
1219 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1235 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1243 return MKBOOL(g_cinterface->PropertyPlatformIsLinked(this, &in_guidPlatform, in_pszPropertyName));
1251 * For inner property sets, as defined in Object Stores, that value is dynamic and only valid for
1274 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1292 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1324 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1334 return MKBOOL(g_cinterface->SetValueString(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1358 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1368 return MKBOOL(g_cinterface->SetValueInt64(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1392 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1402 return MKBOOL(g_cinterface->SetValueInt32(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1426 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1436 return MKBOOL(g_cinterface->SetValueInt16(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1461 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1471 return MKBOOL(g_cinterface->SetValueInt8(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1496 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1506 return MKBOOL(g_cinterface->SetValueUInt64(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1531 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1541 return MKBOOL(g_cinterface->SetValueUInt32(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1566 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1576 return MKBOOL(g_cinterface->SetValueUInt16(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1601 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1611 return MKBOOL(g_cinterface->SetValueUInt8(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1635 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1645 return MKBOOL(g_cinterface->SetValueReal64(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1669 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1679 return MKBOOL(g_cinterface->SetValueReal32(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1703 * \param[in] in_pszPropertyName The name of the property to update, based on the XML definition file.
1713 return MKBOOL(g_cinterface->SetValueBool(this, &in_guidPlatform, in_pszPropertyName, in_propertyValue));
1732 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1743 return MKBOOL(g_cinterface->GetValueString(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1756 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1766 return MKBOOL(g_cinterface->GetValueInt64(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1779 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1789 return MKBOOL(g_cinterface->GetValueInt32(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1802 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1812 return MKBOOL(g_cinterface->GetValueInt16(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1826 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1836 return MKBOOL(g_cinterface->GetValueInt8(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1850 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1860 return MKBOOL(g_cinterface->GetValueUInt64(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1874 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1884 return MKBOOL(g_cinterface->GetValueUInt32(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1898 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1908 return MKBOOL(g_cinterface->GetValueUInt16(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1922 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1932 return MKBOOL(g_cinterface->GetValueUInt8(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1945 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1955 return MKBOOL(g_cinterface->GetValueReal64(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1968 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
1978 return MKBOOL(g_cinterface->GetValueReal32(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
1991 * \param[in] in_pszPropertyName The name of the queried property, based on the XML definition file.
2001 return MKBOOL(g_cinterface->GetValueBool(this, &in_guidPlatform, in_pszPropertyName, &out_propertyValue));
2005 * \brief Retrieves the string value of a specific property and returns the value as a temporary pointer.
2023 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2049 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2075 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2101 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2128 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2155 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2182 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2209 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2236 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2262 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2288 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2314 * \param in_pszPropertyName The name of the queried property, based on the XML definition file.
2350 };
2360 };
2424 * Deriving your plug-in class from RequestPropertySet will automatically request both PropertySet and
2425 * Notifications::PropertySet_ interfaces. From this point, you will be able to derive from the virtual
2426 * functions as defined in Notifications::PropertySet_, and access the host-provided functions in the
2429 * This is also useful when you want to access inner property sets from the ObjectStore interface.
2432 * \aknote The AK::Wwise::Plugin::RequestPropertySet and AK::Wwise::Plugin::RequestWrite classes are automatically
2454 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:1146
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:501
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:1830
@ k_interfaceVersion
The interface version, as provided by this plug-in.
Definition: HostPropertySet.h:2359
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:334
@ k_interfaceType
The interface type, as requested by this plug-in.
Definition: HostPropertySet.h:1064
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:2052
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_PROPERTY_SET
2021.1 Property Set host service. ak_wwise_plugin_host_property_set_v1
Definition: PluginBaseInterface.h:80
int GetType(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Retrieves the type of a specific property.
Definition: HostPropertySet.h:1277
bool SetValueString(const GUID &in_guidPlatform, const char *in_pszPropertyName, const char *in_propertyValue)
Modifies a property to a string value.
Definition: HostPropertySet.h:1328
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:603
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:176
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:2414
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:934
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:232
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:285
static GluedInterface * g_cinterface
The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host onc...
Definition: PluginInfoGenerator.h:89
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:1760
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:1535
const GUID * GetID() const
Returns the internal unique identifier of the corresponding object.
Definition: HostPropertySet.h:1262
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface
Definition: PluginInfoGenerator.h:50
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:1500
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:116
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:2131
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:956
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:2212
RequestedHostInterface< PropertySet > RequestPropertySet
Requests a PropertySet interface, provided as m_propertySet variable.
Definition: HostPropertySet.h:2435
const CPropertySet_::Instance * GetInstancePointer() const
Definition: HostPropertySet.h:2389
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:1465
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:218
bool PropertyHasUnlinked(const char *in_pszPropertyName) const
Returns whether the specified property has at least some platforms that are not linked.
Definition: HostPropertySet.h:1222
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:2026
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:2078
ak_wwise_plugin_notifications_property_set_instance_v1 Instance
Base instance type for receiving notifications on property set's changes.
Definition: HostPropertySet.h:998
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:204
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:843
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:636
The C interface, fulfilled by your plug-in.
Definition: HostPropertySet.h:2366
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:820
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:1396
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:2158
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:978
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:1020
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:2265
bool ClearValue(const GUID &in_guidPlatform, const char *in_pszPropertyName)
Resets a property value to its default.
Definition: HostPropertySet.h:1295
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:753
InterfacePtr GetInterfacePointer()
Definition: HostPropertySet.h:2382
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:1737
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:1673
bool GetBool(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns the boolean value of a specific property.
Definition: HostPropertySet.h:2317
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:270
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:367
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:1902
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:535
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:1995
PluginInfoGenerator: Associates an existing C Interface with a variable that can be used....
Definition: PluginInfoGenerator.h:104
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:433
ak_wwise_plugin_host_property_set_v1 CHostPropertySet
Definition: HostPropertySet.h:1048
@ k_interfaceVersion
The interface version, as requested by this plug-in.
Definition: HostPropertySet.h:1074
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:731
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:2104
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:797
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_PROPERTY_SET
2021.1 Property Set modification notification. ak_wwise_plugin_notifications_property_set_v1
Definition: PluginBaseInterface.h:67
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:161
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:775
bool PropertyHasLinked(const char *in_pszPropertyName) const
Returns whether the specified property has at least some linked platforms.
Definition: HostPropertySet.h:1207
bool PropertyHasRTPC(const char *in_pszPropertyName) const
Get the RTPC binding status for the specified property.
Definition: HostPropertySet.h:1176
ak_wwise_plugin_notifications_property_set_v1()
Definition: HostPropertySet.h:1000
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:2185
Interface used to interact with property sets.
Definition: HostPropertySet.h:79
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:2239
Interface()
Definition: HostPropertySet.h:2368
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:2291
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface
Definition: PluginInfoGenerator.h:49
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:1972
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:1570
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:1430
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:1854
PropertySet_()
Definition: HostPropertySet.h:2393
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:1806
bool SetValueBool(const GUID &in_guidPlatform, const char *in_pszPropertyName, bool in_propertyValue)
Modifies a property to a boolean value.
Definition: HostPropertySet.h:1707
ak_wwise_plugin_host_property_set_v1()
Definition: HostPropertySet.h:87
Interface used to interact with property sets.
Definition: HostPropertySet.h:1052
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:1238
virtual ~PropertySet_()
Definition: HostPropertySet.h:2398
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:1878
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:912
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:120
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:1362
ak_wwise_plugin_notifications_property_set_v1 CPropertySet_
Definition: HostPropertySet.h:2330
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:189
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:1639
Base host-provided instance type for ak_wwise_plugin_host_property_set_v1.
Definition: PluginDef.h:660
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:302
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:1605
CPropertySet_::Instance * GetInstancePointer()
Definition: HostPropertySet.h:2386
bool PropertyHasState(const char *in_pszPropertyName) const
Returns whether the specified property is bound to a state object.
Definition: HostPropertySet.h:1192
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:569
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:400
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:467
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:247
Base instance type for receiving notifications on property set's changes.
Definition: PluginDef.h:861
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:702
#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:237
V1::Notifications::PropertySet_ PropertySet
Latest version of the C++ PropertySet notification interface.
Definition: HostPropertySet.h:2451
bool HasPropertyValue(const GUID &in_guidPlatform, const char *in_pszPropertyName) const
Returns true if the specified property exists.
Definition: HostPropertySet.h:1162
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:669
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:1949
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:1100
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:866
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:1926
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:889
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:1783
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)
Definition: PluginHelpers.h:45
Definition: AudioPlugin.h:111