AudioMiddleware.h

#pragma once
 
#include <AudioSystemPlugin/AudioSystemPluginDLL.h>
 
#include <AudioSystemPlugin/Core/AudioSystemData.h>
 
#include <Foundation/IO/OpenDdlReader.h>
#include <Foundation/IO/OpenDdlUtils.h>
#include <Foundation/Time/Time.h>
 
class PL_AUDIOSYSTEMPLUGIN_DLL plAudioMiddleware
{
public:
  // Audio Middleware Interface
 
  virtual ~plAudioMiddleware() = default;
 
  virtual plResult LoadConfiguration(const plOpenDdlReaderElement& reader) = 0;
 
  virtual plResult Startup() = 0;
 
  virtual void Update(plTime delta) = 0;
 
  virtual plResult Shutdown() = 0;
 
  virtual plResult Release() = 0;
 
  virtual plResult StopAllSounds() = 0;
 
  virtual plResult AddEntity(plAudioSystemEntityData* pEntityData, const char* szEntityName) = 0;
 
  virtual plResult ResetEntity(plAudioSystemEntityData* pEntityData) = 0;
 
  virtual plResult UpdateEntity(plAudioSystemEntityData* pEntityData) = 0;
 
  virtual plResult RemoveEntity(plAudioSystemEntityData* pEntityData) = 0;
 
  virtual plResult SetEntityTransform(plAudioSystemEntityData* pEntityData, const plAudioSystemTransform& Transform) = 0;
 
  virtual plResult LoadTrigger(plAudioSystemEntityData* pEntityData, const plAudioSystemTriggerData* pTriggerData, plAudioSystemEventData* pEventData) = 0;
 
  virtual plResult ActivateTrigger(plAudioSystemEntityData* pEntityData, const plAudioSystemTriggerData* pTriggerData, plAudioSystemEventData* pEventData) = 0;
 
  virtual plResult UnloadTrigger(plAudioSystemEntityData* pEntityData, const plAudioSystemTriggerData* pTriggerData) = 0;
 
  virtual plResult StopEvent(plAudioSystemEntityData* pEntityData, const plAudioSystemEventData* pEventData) = 0;
 
  virtual plResult StopAllEvents(plAudioSystemEntityData* pEntityData) = 0;
 
  virtual plResult SetRtpc(plAudioSystemEntityData* pEntityData, const plAudioSystemRtpcData* pRtpcData, float fValue) = 0;
 
  virtual plResult ResetRtpc(plAudioSystemEntityData* pEntityData, const plAudioSystemRtpcData* pRtpcData) = 0;
 
  virtual plResult SetSwitchState(plAudioSystemEntityData* pEntityData, const plAudioSystemSwitchStateData* pSwitchStateData) = 0;
 
  virtual plResult SetObstructionAndOcclusion(plAudioSystemEntityData* pEntityData, float fObstruction, float fOcclusion) = 0;
 
  virtual plResult SetEnvironmentAmount(plAudioSystemEntityData* pEntityData, const plAudioSystemEnvironmentData* pEnvironmentData, float fAmount) = 0;
 
  virtual plResult AddListener(plAudioSystemListenerData* pListenerData, const char* szListenerName) = 0;
 
  virtual plResult ResetListener(plAudioSystemListenerData* pListenerData) = 0;
 
  virtual plResult RemoveListener(plAudioSystemListenerData* pListenerData) = 0;
 
  virtual plResult SetListenerTransform(plAudioSystemListenerData* pListenerData, const plAudioSystemTransform& Transform) = 0;
 
  virtual plResult LoadBank(plAudioSystemBankData* pBankData) = 0;
 
  virtual plResult UnloadBank(plAudioSystemBankData* pBankData) = 0;
 
  virtual plAudioSystemEntityData* CreateWorldEntity(plAudioSystemDataID uiEntityId) = 0;
 
  virtual plAudioSystemEntityData* CreateEntityData(plAudioSystemDataID uiEntityId) = 0;
 
  virtual plResult DestroyEntityData(plAudioSystemEntityData* pEntityData) = 0;
 
  virtual plAudioSystemListenerData* CreateListenerData(plAudioSystemDataID uiListenerId) = 0;
 
  virtual plResult DestroyListenerData(plAudioSystemListenerData* pListenerData) = 0;
 
  virtual plAudioSystemEventData* CreateEventData(plAudioSystemDataID uiEventId) = 0;
 
  virtual plResult ResetEventData(plAudioSystemEventData* pEventData) = 0;
 
  virtual plResult DestroyEventData(plAudioSystemEventData* pEventData) = 0;
 
  virtual plResult DestroyBank(plAudioSystemBankData* pBankData) = 0;
 
  virtual plResult DestroyTriggerData(plAudioSystemTriggerData* pTriggerData) = 0;
 
  virtual plResult DestroyRtpcData(plAudioSystemRtpcData* pRtpcData) = 0;
 
  virtual plResult DestroySwitchStateData(plAudioSystemSwitchStateData* pSwitchStateData) = 0;
 
  virtual plResult DestroyEnvironmentData(plAudioSystemEnvironmentData* pEnvironmentData) = 0;
 
  virtual plResult SetLanguage(const char* szLanguage) = 0;
 
  [[nodiscard]] virtual const char* GetMiddlewareName() const = 0;
 
  [[nodiscard]] virtual float GetMasterGain() const = 0;
 
  [[nodiscard]] virtual bool GetMute() const = 0;
 
  virtual void OnMasterGainChange(float fGain) = 0;
 
  virtual void OnMuteChange(bool bMute) = 0;
 
  virtual void OnLoseFocus() = 0;
 
  virtual void OnGainFocus() = 0;
};