版本

menu_open
Wwise SDK 2023.1.3
ak_wwise_plugin_host_property_set_v1结构体 参考

Interface used to interact with property sets. 更多...

#include <HostPropertySet.h>

类 ak_wwise_plugin_host_property_set_v1 继承关系图:
ak_wwise_plugin_interface_ptr

Public 类型

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

Public 成员函数

 ak_wwise_plugin_host_property_set_v1 ()
 
- Public 成员函数 继承自 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 属性

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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
const GUID *(* GetID )(const struct ak_wwise_plugin_host_property_set_instance_v1 *in_this)
 Returns the internal unique identifier of the corresponding object. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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) 更多...
 
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) 更多...
 
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) 更多...
 
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) 更多...
 
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) 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
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) 更多...
 
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) 更多...
 
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) 更多...
 
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) 更多...
 
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) 更多...
 
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. 更多...
 
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. 更多...
 
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. 更多...
 
- Public 属性 继承自 ak_wwise_plugin_interface_ptr
ak_wwise_plugin_interface_type m_interface: 32
 Interface type (see ak_wwise_plugin_interface_type) 更多...
 
uint32_t m_version: 32
 Version of the interface 更多...
 

详细描述

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.

备注: 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. 
参见

在文件 HostPropertySet.h75 行定义.


此页面对您是否有帮助?

需要技术支持?

仍有疑问?或者问题?需要更多信息?欢迎联系我们,我们可以提供帮助!

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目,我们帮您快速入门,不带任何附加条件!

开始 Wwise 之旅