audioUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file audioUpdater.h
//! \brief Defines the audio updater component for the spectator role
//! \ingroup vreSpectatorFrontend
 
#pragma once
 
#include "vreSpectatorFrontend/export.h"
 
#include "vrePlayerStation/playerComponent.h"
 
//! \brief Forward declaration of the sound player class
class DtSoundPlayer;
 
//! \brief Forward declaration of the looping sound source class
class DtLoopingSource;
 
//! \brief Forward declaration of the transient sound source class
class DtTransientSource;
 
namespace makVrv
{
//! \brief Forward declaration of the display element class
class DtDe;
} // namespace makVrv
 
namespace makVre
{
 
//! \brief Type identifier constant for DtSpectatorAudioUpdater components
//!
//! This constant defines the string identifier used to identify DtSpectatorAudioUpdater
//! component types within the VR-Engage framework. It is used for component
//! registration, type checking, and serialization operations.
constexpr const char* DtSpectatorAudioUpdaterType = "DtSpectatorAudioUpdater";
 
//! \brief Audio management component for the spectator role
//!
//! This component manages audio feedback for the spectator role,
//! including handling sound effects, ambient audio, and event-based
//! audio cues. It responds to simulation events and updates audio
//! sources accordingly.
class SPECTATOR_DLL DtSpectatorAudioUpdater : public makVre::DtPlayerComponent
{
public:
   //! \brief Default constructor
   DtSpectatorAudioUpdater();
 
   //! \brief Virtual destructor
   virtual ~DtSpectatorAudioUpdater() override;
 
   //! \brief Initializes the audio updater component
   //! \param player Pointer to the player station
   //! \param config Reference to the initialization configuration
   //! \return True if initialization was successful, false otherwise
   //!
   //! Sets up audio sources and registers message handlers for audio events
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   //! \brief Updates audio state each frame
   //! \param dt Delta time since the last update in seconds
   //!
   //! Updates audio sources and manages sound playback based on simulation state
   virtual void tick(double dt) override;
 
   //! \brief Performs cleanup when the component is shut down
   //!
   //! Releases audio resources and unregisters message handlers
   virtual void shutdown() override;
 
   //! \brief Returns the component type identifier
   //! \return String identifier for this component type
   //!
   //! Returns the type identifier string for this component, which is used
   //! by the VR-Engage framework for component identification and management.
   //! The returned value matches DtSpectatorAudioUpdaterType.
   virtual const char* type() const override;
 
protected:
};
} // namespace makVre