Host

Wwise SDK 2022.1.9

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

#include <Host.h>

Inheritance diagram for AK.Wwise::Plugin::V1::Host:

Public Types
enum	: InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST }
	The interface type, as requested by this plug-in. More...

enum	: InterfaceVersion { k_interfaceVersion = 1 }
	The interface version, as requested by this plug-in. More...

using	Interface = CHost

using	Instance = CHost::Instance

Public Types inherited from AK.Wwise::Plugin::CBaseInstanceGlue< CHost >
using	Instance = typename CInterface::Instance

Public Types inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHost >
using	GluedInterface = CHost

Public Member Functions
GUID	GetCurrentPlatform () const
	Retrieves the current platform identifier. More...

BasePlatformID	GetCurrentBasePlatform () const
	Retrieves the current base platform identifier. More...

BasePlatformID	GetDefaultNativeAuthoringPlaybackPlatform () const
	Retrieves the requested playback base platform of the Authoring tool. More...

GUID	GetAuthoringPlaybackPlatform () const
	Retrieves the requested playback platform of the Authoring tool. More...

void	NotifyInternalDataChanged (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 GUID &in_guidPlatform, LicenseType &out_eType, LicenseStatus &out_eStatus, uint32_t &out_uDaysToExpiry) const
	Obtain licensing status for the plug-in. More...

void	GetAssetLicenseStatus (const GUID &in_guidPlatform, AkUInt32 in_uAssetID, LicenseType &out_eType, LicenseStatus &out_eStatus, uint32_t &out_uDaysToExpiry) const
	Obtain licensing status for a plug-in-specific asset ID. More...

void	WaapiCall (const char in_szUri, const char in_szArgs, const char in_szOptions, AK::IAkPluginMemAlloc &in_alloc, char &out_szResults, char *&out_szError) const
	Find and call the specified procedure. More...

Additional Inherited Members
Static Public Attributes inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHost >
static GluedInterface *	g_cinterface
	The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host once loaded. 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 245 of file Host.h.

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Get started with Wwise