Version
menu_open
Wwise SDK 2024.1.4
License.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2025 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 /**
28  * \brief Wwise Authoring Plug-ins - Plug-in API for licensing.
29  * \file AK/Wwise/Plugin/License.h
30  */
31 
32 #pragma once
33 
34 #include "PluginInfoGenerator.h"
35 
36 /**
37  * \brief Backend API to specify licensing requirements
38  */
39 struct ak_wwise_plugin_license_v1
40 #ifdef __cplusplus
41  : public ak_wwise_plugin_base_interface
42 #endif
43 {
44 #ifndef __cplusplus
45  ak_wwise_plugin_base_interface m_baseInterface;
46 #endif
47 
48 #ifdef __cplusplus
49  /// Base instance type for providing licensing information.
50  using Instance = ak_wwise_plugin_license_instance_v1;
51 
52  ak_wwise_plugin_license_v1() :
53  ak_wwise_plugin_base_interface(AK_WWISE_PLUGIN_INTERFACE_TYPE_LICENSE, 1)
54  {}
55 #endif
56 
57  /**
58  * \brief Retrieve the licensing status of the plug-in for the given platform.
59  *
60  * \param[in] in_this Current instance of this interface.
61  * \param[in] in_guidPlatform GUID of the platform.
62  * \param[out] out_eSeverity (Optional) If set, the string placed in out_pszMessage will be shown
63  * in the log with the corresponding severity.
64  * \param[out] out_pszMessage Pointer to the buffer of size in_uiBufferSize that will hold the
65  * message string.
66  * \param[in] in_uiBufferSize Null-terminated size of the buffer pointed by out_pszMessage.
67 
68  * \return Licensing status of the plug-in; LicenseStatus_Unlicensed or LicenseStatus_Expired
69  * will prevent the plug-in from being included in a SoundBank.
70  *
71  * \sa
72  * - \ref AK::Wwise::Plugin::Host::GetLicenseStatus
73  * - \ref AK::Wwise::Plugin::Host::GetAssetLicenseStatus
74  * - \ref wwiseplugin_dll_license
75  */
76  AK::Wwise::Plugin::LicenseStatus(*GetLicenseStatus)(
77  const struct ak_wwise_plugin_license_instance_v1* in_this,
78  const GUID* in_guidPlatform, ///< GUID of the platform
79  AK::Wwise::Plugin::Severity* out_eSeverity, ///< (Optional) If set, the string placed in out_pszMessage will be shown in the log with the corresponding severity.
80  char * out_pszMessage, ///< Pointer to the buffer that will hold the message string
81  unsigned int in_uiBufferSize ///< Size of the buffer pointed by out_pszMessage (in number of WCHAR, including null terminator)
82  );
83 
84 };
85 #define AK_WWISE_PLUGIN_LICENSE_V1_ID() \
86  AK_WWISE_PLUGIN_BASE_INTERFACE_FROM_ID(AK_WWISE_PLUGIN_INTERFACE_TYPE_LICENSE, 1)
87 #define AK_WWISE_PLUGIN_LICENSE_V1_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
88 { \
89  .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_LICENSE_V1_ID(), in_pluginInfo, in_data) \
90 }
91 
92 #ifdef __cplusplus
93 namespace AK::Wwise::Plugin
94 {
95  namespace V1
96  {
97  using CLicense = ak_wwise_plugin_license_v1;
98  class License : public CLicense::Instance
99  {
100  public:
101  /**
102  * \brief The interface type, as provided by this plug-in.
103  */
104  enum : InterfaceTypeValue
105  {
106  /**
107  * \brief The interface type, as provided by this plug-in.
108  */
109  k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_LICENSE
110  };
111  /**
112  * \brief The interface version, as provided by this plug-in.
113  */
114  enum : InterfaceVersion
115  {
116  /**
117  * \brief The interface version, as provided by this plug-in.
118  */
119  k_interfaceVersion = 1
120  };
121 
122  /**
123  * \brief The C interface, fulfilled by your plug-in.
124  */
125  struct Interface : public CLicense
126  {
127  using Instance = License;
128  Interface()
129  {
130  CLicense::GetLicenseStatus = [](
131  const struct ak_wwise_plugin_license_instance_v1* in_this,
132  const GUID* in_guidPlatform,
133  Severity* out_eSeverity,
134  char * out_pszMessage,
135  unsigned int in_uiBufferSize)
136  {
137  return (LicenseStatus)static_cast<const Instance*>(in_this)->GetLicenseStatus(
138  *in_guidPlatform,
139  *out_eSeverity,
140  out_pszMessage,
141  in_uiBufferSize);
142  };
143  }
144  };
145 
146  InterfacePtr GetInterfacePointer() {
147  static Interface g_interface;
148  return &g_interface;
149  }
150  CLicense::Instance* GetInstancePointer() {
151  return this;
152  }
153  const CLicense::Instance* GetInstancePointer() const {
154  return this;
155  }
156 
157  License() :
158  CLicense::Instance()
159  {
160  }
161 
162  virtual ~License() {}
163 
164  /**
165  * \brief Retrieve the licensing status of the plug-in for the given platform.
166  *
167  * \param[in] in_guidPlatform GUID of the platform.
168  * \param[out] out_eSeverity (Optional) If set, the string placed in out_pszMessage will be shown
169  * in the log with the corresponding severity.
170  * \param[out] out_pszMessage Pointer to the buffer of size in_uiBufferSize that will hold the
171  * message string.
172  * \param[in] in_uiBufferSize Null-terminated size of the buffer pointed by out_pszMessage.
173 
174  * \return Licensing status of the plug-in; LicenseStatus_Unlicensed or LicenseStatus_Expired
175  * will prevent the plug-in from being included in a SoundBank.
176  *
177  * \sa
178  * - \ref AK::Wwise::Plugin::Host::GetLicenseStatus
179  * - \ref AK::Wwise::Plugin::Host::GetAssetLicenseStatus
180  * - \ref wwiseplugin_dll_license
181  */
182  virtual LicenseStatus GetLicenseStatus(
183  const GUID & in_guidPlatform,
184  Severity & out_eSeverity,
185  char * out_pszMessage,
186  unsigned int in_uiBufferSize
187  ) const { return LicenseStatus::LicenseStatus_Valid; }
188  };
189  } // of namespace V1
190 
191  /// Latest version of the C License interface.
192  using CLicense = V1::CLicense;
193  /// Latest version of the C++ License interface.
194  using License = V1::License;
195 
196  AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(License);
197  AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(License);
198 } // of namespace AK::Wwise::Plugin
199 
200 #endif
AK.Wwise::Plugin::V1::License::GetInterfacePointer
InterfacePtr GetInterfacePointer()
Definition: License.h:146
AK.Wwise::Plugin::V1::License::k_interfaceType
@ k_interfaceType
The interface type, as provided by this plug-in.
Definition: License.h:109
AK.Wwise::Plugin::V1::License::GetLicenseStatus
virtual LicenseStatus GetLicenseStatus(const GUID &in_guidPlatform, Severity &out_eSeverity, char *out_pszMessage, unsigned int in_uiBufferSize) const
Retrieve the licensing status of the plug-in for the given platform.
Definition: License.h:182
AK.Wwise::Plugin::InterfaceVersion
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface.
Definition: PluginInfoGenerator.h:50
AK.Wwise::Plugin::V1::License::GetInstancePointer
const CLicense::Instance * GetInstancePointer() const
Definition: License.h:153
PluginInfoGenerator.h
Wwise Authoring Plug-ins - C++ class helper to automatically determine the plug-in interfaces used in...
AK.Wwise::Plugin::V1::License::Interface
The C interface, fulfilled by your plug-in.
Definition: License.h:126
AK.Wwise::Plugin::InterfacePtr
CInterfacePtr InterfacePtr
Definition: PluginDef.h:1057
ak_wwise_plugin_license_instance_v1
Base instance type for providing licensing information, through ak_wwise_plugin_license_v1.
Definition: PluginDef.h:915
AK.Wwise::Plugin::LicenseStatus_Valid
@ LicenseStatus_Valid
A license is found and is valid.
Definition: PluginDef.h:70
AK.Wwise::Plugin::InterfaceTypeValue
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface.
Definition: PluginInfoGenerator.h:49
ak_wwise_plugin_license_v1::GetLicenseStatus
AK::Wwise::Plugin::LicenseStatus(* GetLicenseStatus)(const struct ak_wwise_plugin_license_instance_v1 *in_this, const GUID *in_guidPlatform, AK::Wwise::Plugin::Severity *out_eSeverity, char *out_pszMessage, unsigned int in_uiBufferSize)
Retrieve the licensing status of the plug-in for the given platform.
Definition: License.h:76
AK.Wwise::Plugin::Severity
Severity
Log message severity.
Definition: PluginDef.h:109
AK.Wwise::Plugin::AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
AK.Wwise::Plugin::V1::CLicense
ak_wwise_plugin_license_v1 CLicense
Definition: License.h:97
AK.Wwise::Plugin::V1::License::GetInstancePointer
CLicense::Instance * GetInstancePointer()
Definition: License.h:150
AK_WWISE_PLUGIN_INTERFACE_TYPE_LICENSE
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_LICENSE
2021.1 Licensing. ak_wwise_plugin_license_v1
Definition: PluginBaseInterface.h:61
ak_wwise_plugin_license_v1::ak_wwise_plugin_license_v1
ak_wwise_plugin_license_v1()
Definition: License.h:52
ak_wwise_plugin_base_interface
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:120
AK.Wwise::Plugin::License
V1::License License
Latest version of the C++ License interface.
Definition: License.h:194
AK.Wwise::Plugin::LicenseStatus
LicenseStatus
License status.
Definition: PluginDef.h:67
ak_wwise_plugin_license_v1
Backend API to specify licensing requirements.
Definition: License.h:43
AK.Wwise::Plugin::V1::License::k_interfaceVersion
@ k_interfaceVersion
The interface version, as provided by this plug-in.
Definition: License.h:119
AK.Wwise::Plugin::AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)

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