Wwise Version
arrow_right Table of Contents
Wwise SDK 2021.1.5
ak_wwise_plugin_host_v1 Struct Reference

API to request host's current state and services. More...

#include <Host.h>

Inheritance diagram for ak_wwise_plugin_host_v1:
ak_wwise_plugin_interface_ptr

Public Types

using  Instance = ak_wwise_plugin_host_instance_v1
  Base host-provided instance type. More...
 

Public Member Functions

  ak_wwise_plugin_host_v1 ()
 
- 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(*  GetCurrentPlatform )(const struct ak_wwise_plugin_host_v1 *in_this)
  Retrieves the current platform identifier. More...
 
BasePlatformID(*  GetCurrentBasePlatform )(const struct ak_wwise_plugin_host_v1 *in_this)
  Retrieves the current base platform identifier. More...
 
BasePlatformID(*  GetDefaultNativeAuthoringPlaybackPlatform )(const struct ak_wwise_plugin_host_v1 *in_this)
  Retrieves the requested playback base platform of the Authoring tool. More...
 
GUID(*  GetAuthoringPlaybackPlatform )(const struct ak_wwise_plugin_host_v1 *in_this)
  Retrieves the requested playback platform of the Authoring tool. More...
 
void(*  NotifyInternalDataChanged )(struct ak_wwise_plugin_host_instance_v1 *in_this, AkPluginParamID in_idData, bool in_bMakeProjectDirty)
  Use this function to tell Wwise that something other than properties has changed within the plug-in. More...
 
void(*  GetLicenseStatus )(const struct ak_wwise_plugin_host_instance_v1 *in_this, const GUID *in_guidPlatform, AK::Wwise::Plugin::LicenseType *out_eType, AK::Wwise::Plugin::LicenseStatus *out_eStatus, uint32_t *out_uDaysToExpiry)
  Obtain licensing status for the plug-in. More...
 
void(*  GetAssetLicenseStatus )(const struct ak_wwise_plugin_host_instance_v1 *in_this, const GUID *in_guidPlatform, AkUInt32 in_uAssetID, AK::Wwise::Plugin::LicenseType *out_eType, AK::Wwise::Plugin::LicenseStatus *out_eStatus, uint32_t *out_uDaysToExpiry)
  Obtain licensing status for a plug-in-specific asset ID. More...
 
void(*  WaapiCall )(const struct ak_wwise_plugin_host_v1 *in_this, const char *in_szUri, const char *in_szArgs, const char *in_szOptions, AK::IAkPluginMemAlloc *in_pAlloc, char **out_szResults, char **out_szError)
  Find and call the specified procedure. 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

API to request host's current state and services.

If requested, this contains information on the current state of the host as well as generic operations.

For example, the currently selected platform, tools to post when internal plug-in data changed, or a way to make Waapi calls.

In order to be reactive to host's state, you should consider implementing ak_wwise_plugin_notifications_host_v1 notifications.

Definition at line 50 of file Host.h.