Audio::ISoundEffectService Class Reference

Interface for sound effect management in menus. More...

#include <ISoundEffectService.hpp>

Inheritance diagram for Audio::ISoundEffectService:

Collaboration diagram for Audio::ISoundEffectService:

Public Member Functions
virtual	~ISoundEffectService ()=default
virtual void	PlayClickSound ()=0
	Play the button click sound effect.
virtual void	PlayMainMenuOpenSound ()=0
	Play the main menu open sound effect.
virtual void	PlayRoomMenuOpenSound ()=0
	Play the room menu open sound effect.
virtual void	SetVolume (float volume)=0
	Set the master volume for all sound effects.
virtual float	GetVolume () const =0
	Get the current master volume.

Detailed Description

Interface for sound effect management in menus.

This interface provides a high-level abstraction for playing sound effects in the UI layer. Implementations should handle loading, caching, and playing sounds.

Follows the Interface Segregation Principle by providing only the methods needed for menu sound effects.

Definition at line 21 of file ISoundEffectService.hpp.

Constructor & Destructor Documentation

~ISoundEffectService()

virtual Audio::ISoundEffectService::~ISoundEffectService ( )

virtualdefault

Member Function Documentation

GetVolume()

virtual float Audio::ISoundEffectService::GetVolume ( ) const

pure virtual

Get the current master volume.

Returns

Current volume level (0.0 to 1.0)

Implemented in Audio::SoundEffectManager.

PlayClickSound()

virtual void Audio::ISoundEffectService::PlayClickSound ( )

pure virtual

Play the button click sound effect.

Implemented in Audio::SoundEffectManager.

Referenced by Game::BaseMenu::WrapWithClickSound().

PlayMainMenuOpenSound()

virtual void Audio::ISoundEffectService::PlayMainMenuOpenSound ( )

pure virtual

Play the main menu open sound effect.

Implemented in Audio::SoundEffectManager.

Referenced by Game::MainMenu::Show().

PlayRoomMenuOpenSound()

virtual void Audio::ISoundEffectService::PlayRoomMenuOpenSound ( )

pure virtual

Play the room menu open sound effect.

Implemented in Audio::SoundEffectManager.

Referenced by Game::RoomListMenu::Show().

SetVolume()

virtual void Audio::ISoundEffectService::SetVolume ( float  volume )

pure virtual

Set the master volume for all sound effects.

Parameters

volume

Volume level (0.0 to 1.0)

Implemented in Audio::SoundEffectManager.

---

The documentation for this class was generated from the following file:

• client/Audio/ISoundEffectService.hpp