Wwise SDK 2021.1.14
バージョン
menu_open
link
Host.h
Go to the documentation of this file.
42 * If requested, this contains information on the current state of the host as well as generic operations.
47 * In order to be reactive to host's state, you should consider implementing ak_wwise_plugin_notifications_host_v1
70 * This can be passed to any function that has a parameter for a platform ID, such as GetValue() or
92 BasePlatformID(*GetDefaultNativeAuthoringPlaybackPlatform)(const struct ak_wwise_plugin_host_v1* in_this);
103 * \brief Use this function to tell Wwise that something other than properties has changed within the plug-in.
105 * This will set the plugin dirty (indicating there are unsaved changes) and GetPluginData will be called when
106 * the plug-in is about to play in Wwise. This will transfer the internal data to the Sound Engine part of
168 * \param[in] in_szArgs JSON string of arguments to pass to the procedure, or nullptr for no arguments.
169 * \param[in] in_szOptions JSON string of options to pass to the procedure, or nullptr for no options.
232 #define AK_WWISE_PLUGIN_NOTIFICATIONS_HOST_V1_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
234 .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_NOTIFICATIONS_HOST_V1_ID(), in_pluginInfo, in_data) \
261 };
271 };
276 * This can be passed to any function that has a parameter for a platform ID, such as GetValue() or
281 inline GUID GetCurrentPlatform() const { return g_cinterface->GetCurrentPlatform(g_cinterface); }
288 inline BasePlatformID GetCurrentBasePlatform() const { return g_cinterface->GetCurrentBasePlatform(g_cinterface); }
295 inline BasePlatformID GetDefaultNativeAuthoringPlaybackPlatform() const { return g_cinterface->GetDefaultNativeAuthoringPlaybackPlatform(g_cinterface); }
302 inline GUID GetAuthoringPlaybackPlatform() const { return g_cinterface->GetAuthoringPlaybackPlatform(g_cinterface); }
305 * \brief Use this function to tell Wwise that something other than properties has changed within the plug-in.
307 * This will set the plugin dirty (indicating there are unsaved changes) and GetPluginData will be called when
308 * the plug-in is about to play in Wwise. This will transfer the internal data to the Sound Engine part of
316 inline void NotifyInternalDataChanged(AkPluginParamID in_idData, bool in_bMakeProjectDirty) { g_cinterface->NotifyInternalDataChanged(this, in_idData, in_bMakeProjectDirty); }
335 g_cinterface->GetLicenseStatus(this, &in_guidPlatform, &out_eType, &out_eStatus, &out_uDaysToExpiry);
357 g_cinterface->GetAssetLicenseStatus(this, &in_guidPlatform, in_uAssetID, &out_eType, &out_eStatus, &out_uDaysToExpiry);
366 * \param[in] in_szArgs JSON string of arguments to pass to the procedure, or nullptr for no arguments.
367 * \param[in] in_szOptions JSON string of options to pass to the procedure, or nullptr for no options.
381 g_cinterface->WaapiCall(g_cinterface, in_szUri, in_szArgs, in_szOptions, &in_alloc, &out_szResults, &out_szError);
408 };
418 };
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.
Definition: Host.h:132
API to receive host's update notifications.
Definition: Host.h:193
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.
Definition: Host.h:316
BasePlatformID(* GetCurrentBasePlatform)(const struct ak_wwise_plugin_host_v1 *in_this)
Retrieves the current base platform identifier.
Definition: Host.h:84
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST
2021.1 Host services. ak_wwise_plugin_host_v1
Definition: PluginBaseInterface.h:77
void(* NotifyCurrentPlatformChanged)(struct ak_wwise_plugin_notifications_host_instance_v1 *in_this, const GUID *in_guidCurrentPlatform)
Received when the current platform changes.
Definition: Host.h:216
BasePlatformID GetCurrentBasePlatform() const
Retrieves the current base platform identifier.
Definition: Host.h:288
static GluedInterface * g_cinterface
The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host onc...
Definition: PluginInfoGenerator.h:90
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface.
Definition: PluginInfoGenerator.h:51
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.
Definition: Host.h:152
ak_wwise_plugin_notifications_host_v1()
Definition: Host.h:202
const CHost_::Instance * GetInstancePointer() const
Definition: Host.h:445
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.
Definition: Host.h:115
Definition: PlatformID.h:41
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.
Definition: Host.h:372
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_HOST
2021.1 Host modification notification. ak_wwise_plugin_notifications_host_v1
Definition: PluginBaseInterface.h:64
void GetLicenseStatus(const GUID &in_guidPlatform, LicenseType &out_eType, LicenseStatus &out_eStatus, uint32_t &out_uDaysToExpiry) const
Obtain licensing status for the plug-in.
Definition: Host.h:328
Definition: IAkPluginMemAlloc.h:44
CHost_::Instance * GetInstancePointer()
Definition: Host.h:442
Base host-provided instance type for ak_wwise_plugin_host_v1.
Definition: PluginDef.h:599
Wwise Authoring Plug-ins - C++ class helper to automatically determine the plug-in interfaces used in...
PluginInfoGenerator: Associates an existing C Interface with a variable that can be used....
Definition: PluginInfoGenerator.h:105
GUID GetAuthoringPlaybackPlatform() const
Retrieves the requested playback platform of the Authoring tool.
Definition: Host.h:302
GUID(* GetAuthoringPlaybackPlatform)(const struct ak_wwise_plugin_host_v1 *in_this)
Retrieves the requested playback platform of the Authoring tool.
Definition: Host.h:100
Base instance type for receiving notifications on host changes events.
Definition: PluginDef.h:798
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface.
Definition: PluginInfoGenerator.h:50
RequestedHostInterface< Host > RequestHost
Requests a Host interface, provided as m_host variable.
Definition: Host.h:474
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
BasePlatformID(* GetDefaultNativeAuthoringPlaybackPlatform)(const struct ak_wwise_plugin_host_v1 *in_this)
Retrieves the requested playback base platform of the Authoring tool.
Definition: Host.h:92
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.
Definition: Host.h:349
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.
Definition: Host.h:174
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:117
The C interface, fulfilled by your plug-in.
Definition: Host.h:424
GUID(* GetCurrentPlatform)(const struct ak_wwise_plugin_host_v1 *in_this)
Retrieves the current platform identifier.
Definition: Host.h:76
API to receive host's update notifications.
Definition: Host.h:392
InterfacePtr GetInterfacePointer()
Definition: Host.h:438
V1::Notifications::Host_ Host
Latest version of the C++ Host notification interface.
Definition: Host.h:490
ak_wwise_plugin_notifications_host_instance_v1 Instance
Base instance type for receiving notifications on host changes events.
Definition: Host.h:200
#define AK_WWISE_PLUGIN_SPECIALIZE_HOST_INTERFACE(in_name, in_varname,...)
PluginInfoGenerator: Creates a C++ host specialization for interface class specified in in_name,...
Definition: PluginInfoGenerator.h:238
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)
virtual void NotifyCurrentPlatformChanged(const GUID &in_guidCurrentPlatform)
Definition: Host.h:460
Definition: PluginHelpers.h:46
BasePlatformID GetDefaultNativeAuthoringPlaybackPlatform() const
Retrieves the requested playback base platform of the Authoring tool.
Definition: Host.h:295
Definition: AudioPlugin.h:112