Version

menu_open
Wwise SDK 2023.1.3
AK.Wwise::Plugin::V2::Host Class Reference

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

#include <Host.h>

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

Public Types

using Interface = CHost
 
using Instance = CHost::Instance
 

Public Member Functions

LicenseID GetProjectLicenseID () const
 Obtain the project license ID. More...
 
GUID GetCurrentPlatform () const
 
BasePlatformID GetCurrentBasePlatform () const
 
BasePlatformID GetDefaultNativeAuthoringPlaybackPlatform () const
 
GUID GetAuthoringPlaybackPlatform () const
 
void NotifyInternalDataChanged (AkPluginParamID in_idData, bool in_bMakeProjectDirty)
 
void GetLicenseStatus (const GUID &in_guidPlatform, LicenseType &out_eType, LicenseStatus &out_eStatus, uint32_t &out_uDaysToExpiry) const
 
void GetAssetLicenseStatus (const GUID &in_guidPlatform, AkUInt32 in_uAssetID, LicenseType &out_eType, LicenseStatus &out_eStatus, uint32_t &out_uDaysToExpiry) const
 
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
 

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 94 of file Host.h.


Was this page helpful?

Need Support?

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

Visit our Support page

Tell 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