|
Wwise SDK 2025.1.0
|
Interface used to interact with reference sets. More...
#include <HostReferenceSet.h>
Public Types | |
| using | Instance = ak_wwise_plugin_host_reference_set_instance_v1 |
| Base host-provided instance type for ak_wwise_plugin_host_reference_set_v1. More... | |
Public Member Functions | |
| ak_wwise_plugin_host_reference_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 | |
| GUID(* | GetReferenceGuid )(const struct ak_wwise_plugin_host_reference_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszReferenceName) |
| Retrieves the value of a specific reference as a GUID. More... | |
| AkUniqueID(* | GetReferenceShortId )(const struct ak_wwise_plugin_host_reference_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszReferenceName) |
| Returns the Unique ID (or "ShortID") of the corresponding object. More... | |
| bool(* | SetReferenceByGuid )(struct ak_wwise_plugin_host_reference_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszReferenceName, const GUID *in_guidReference) |
| Updates the value of a specific reference to the provided GUID. More... | |
| bool(* | ReferenceHasLinked )(const struct ak_wwise_plugin_host_reference_set_instance_v1 *in_this, const char *in_pszReferenceName) |
| Returns whether the specified reference has at least some linked platforms. More... | |
| bool(* | ReferenceHasUnlinked )(const struct ak_wwise_plugin_host_reference_set_instance_v1 *in_this, const char *in_pszReferenceName) |
| Returns whether the specified reference has one or more platforms that are not linked. More... | |
| bool(* | ReferencePlatformIsLinked )(const struct ak_wwise_plugin_host_reference_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszReferenceName) |
| Returns whether the specified reference's platform is linked. More... | |
| const char *(* | GetReferenceName )(const struct ak_wwise_plugin_host_reference_set_instance_v1 *in_this, const GUID *in_guidPlatform, const char *in_pszReferenceName) |
| Retrieves the name of a referenced object. More... | |
| Public Attributes inherited from ak_wwise_plugin_interface_ptr | |
| ak_wwise_plugin_interface_type | m_interface: 32 |
| Interface type (see ak_wwise_plugin_interface_type) More... | |
| uint32_t | m_version: 32 |
| Version of the interface. More... | |
Detailed Description
Interface used to interact with reference sets.
A reference set is a dictionary of references to other Objects that exist in a user's Authoring project. Whenever a reference name is specified, it corresponds to the reference name set in the plug-in's XML. These Object references can be resolved to GUIDs for use in the Authoring project, or to Short IDs for use in the Wwise Runtime.
The methods in this interface which use in_guidPlatform as an input parameter assume that you have access to a Platform defined as a GUID, either provided by the caller function or retrieved through the Host interface.
You can retrieve GUIDs in the following ways:
- Use the in_guidPlatform provided as an input parameter in ak_wwise_plugin_audio_plugin_v1::GetBankParameters or ak_wwise_plugin_custom_data_v1::GetPluginData
- Poll the currently-active platform from ak_wwise_plugin_host_v1::GetCurrentPlatform or ak_wwise_plugin_host_v1::GetAuthoringPlaybackPlatform
You can also provide GUID_NULL as a parameter, which accesses data for all platforms at once as a linked value. However, GUID_NULL only works when no platform-specific data is possible for a value. Using the current platform is always the preferred access method.
- See also
Definition at line 65 of file HostReferenceSet.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