_frontend_8h

Warning: you were redirected to the latest documentation corresponding to your major release ( 2024.1.1.8691 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

Wwise SDK 2024.1.1

Go to the documentation of this file.

 /*******************************************************************************
 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
 released in source code form as part of the SDK installer package.
  
 Commercial License Usage
  
 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
 may use this file in accordance with the end user license agreement provided
 with the software or, alternatively, in accordance with the terms contained in a
 written agreement between you and Audiokinetic Inc.
  
 Apache License Usage
  
 Alternatively, this file may be used under the Apache License, Version 2.0 (the
 "Apache License"); you may not use this file except in compliance with the
 Apache License. You may obtain a copy of the Apache License at
 http://www.apache.org/licenses/LICENSE-2.0.
  
 Unless required by applicable law or agreed to in writing, software distributed
 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
 the specific language governing permissions and limitations under the License.
  
   Copyright (c) 2024 Audiokinetic Inc.
 *******************************************************************************/
  
 /**
  * \brief Wwise Authoring Plug-ins - Frontend plug-in API for Audio plug-ins.
  * \file AK/Wwise/Plugin/Frontend.h
  */
  
 #pragma once
  
 #include "AudioPlugin.h"
 #include "HostFrontendModel.h"
  
 /**
  * \brief Frontend plug-in API for Audio plug-ins.
  *
  * You must create this interface in order to support the frontend part of the user interface.
  */
 struct ak_wwise_plugin_frontend_v1
 #ifdef __cplusplus
     : public ak_wwise_plugin_base_interface
 #endif
 {
 #ifndef __cplusplus
     ak_wwise_plugin_base_interface m_baseInterface;
 #endif
  
 #ifdef __cplusplus
     /// Base instance type for providing a frontend for an audio plug-in.
     using Instance = ak_wwise_plugin_frontend_instance_v1;
  
     ak_wwise_plugin_frontend_v1() :
         ak_wwise_plugin_base_interface(AK_WWISE_PLUGIN_INTERFACE_TYPE_FRONTEND, 1)
     {}
 #endif
  
 };
 #define AK_WWISE_PLUGIN_FRONTEND_ID() \
     AK_WWISE_PLUGIN_BASE_INTERFACE_FROM_ID(AK_WWISE_PLUGIN_INTERFACE_TYPE_FRONTEND, 1)
 #define AK_WWISE_PLUGIN_FRONTEND_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
 { \
     .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_FRONTEND_ID(), in_pluginInfo, in_data) \
 }
  
  
 #ifdef __cplusplus
 namespace AK::Wwise::Plugin
 {
     namespace V1
     {
         using CFrontend = ak_wwise_plugin_frontend_v1;
  
         /// \copydoc ak_wwise_plugin_frontend_v1
         class Frontend
             : public CFrontend::Instance
             , public AK::Wwise::Plugin::RequestFrontendModel
         {
         public:
             /**
              * \brief The interface type, as provided by this plug-in.
              */
             enum : InterfaceTypeValue
             {
                 /**
                  * \brief The interface type, as provided by this plug-in.
                  */
                 k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_FRONTEND
             };
             /**
              * \brief The interface version, as provided by this plug-in.
              */
             enum : InterfaceVersion
             {
                 /**
                  * \brief The interface version, as provided by this plug-in.
                  */
                 k_interfaceVersion = 1
             };
  
             /**
              * \brief The C interface, fulfilled by your plug-in.
              */
             struct Interface : public CFrontend
             {
                 using Instance = Frontend;
                 Interface()
                 {
                 }
             };
  
             InterfacePtr GetInterfacePointer() {
                 static Interface g_interface;
                 return &g_interface;
             }
             CFrontend::Instance* GetInstancePointer() {
                 return this;
             }
             const CFrontend::Instance* GetInstancePointer() const {
                 return this;
             }
  
             Frontend() :
                 CFrontend::Instance()
             {
             }
  
             virtual ~Frontend() {}
  
         };
     } // of namespace V1
  
     /// Latest version of the C Frontend interface.
     using CFrontend = V1::CFrontend;
     /// Latest version of the C++ Frontend interface.
     using Frontend = V1::Frontend;
  
     AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(Frontend);
     AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(Frontend);
 } // of namespace AK::Wwise::Plugin
 #endif // of __cplusplus
  
 #ifndef WM_AK_PRIVATE_SHOW_HELP_TOPIC
 #define WM_AK_PRIVATE_SHOW_HELP_TOPIC 0x4981
 #endif