Version
menu
|
Wwise SDK 2025.1.0
|
ak_wwise_plugin_host_property_set_v2 Struct Reference
#include <HostPropertySet.h>
Inheritance diagram for ak_wwise_plugin_host_property_set_v2:
Public Types | |
| using | Instance = ak_wwise_plugin_host_property_set_instance_v1 |
| This interface is compatible with the v1 instance. More... | |
 Public Types inherited from ak_wwise_plugin_host_property_set_v1 | |
| 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_v2 () | |
| Public Member Functions inherited from ak_wwise_plugin_host_property_set_v1 | |
| ak_wwise_plugin_host_property_set_v1 (int version=1) | |
| 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 | |
| void(* | OpenBraces )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, ak_wwise_plugin_property_set_braces in_bracesToOpen) |
| Open one or more brace that denotes the start of a change. More... | |
| void(* | CloseBraces )(struct ak_wwise_plugin_host_property_set_instance_v1 *in_this, ak_wwise_plugin_property_set_braces in_bracesToClose) |
| Close one or more brace that denotes the end of a change. More... | |
| ak_wwise_plugin_property_set_braces(* | GetOpenedBraces )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this) |
| Retrieve the currently open braces. More... | |
| Public Attributes inherited from ak_wwise_plugin_host_property_set_v1 | |
| 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
Definition at line 38 of file HostPropertySet.h.
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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