shkyera::AudioSystem Class Reference

System that manages audio playback and spatial audio. More...

#include <AudioSystem.hpp>

Inheritance diagram for shkyera::AudioSystem:

Public Member Functions
	AudioSystem (std::shared_ptr< Registry > registry)
	~AudioSystem ()
void	update ()
	Updates audio playback state and spatial audio.
Public Member Functions inherited from shkyera::RegistryViewer
template<typename... Resources>
	RegistryViewer (std::shared_ptr< Registry > registry, ReadAccess< Resources... > read)
template<typename... Resources>
	RegistryViewer (std::shared_ptr< Registry > registry, WriteAccess< Resources... > read)
template<typename... ReadResources, typename... WriteResources>
	RegistryViewer (std::shared_ptr< Registry > registry, ReadAccess< ReadResources... > read, WriteAccess< WriteResources... > write)
const Policy &	getPolicy () const
template<typename Component , typename... Args>
Component &	add (Entity entity, Args &&... args)
template<typename Component >
void	clear ()
template<typename Component >
bool	has (Entity entity) const
template<typename Component >
Component &	write (Entity entity)
template<typename Component >
const Component &	read (Entity entity) const
template<NonSingletonComponentType Component>
const auto &	read () const
template<SingletonComponentType Component>
const auto *	read () const
template<NonSingletonComponentType Component>
auto &	write ()
template<SingletonComponentType Component>
auto *	write ()
template<SingletonComponentType Component>
std::optional< Entity >	getEntity () const
const std::optional< Entity >	getParent (Entity entity) const
template<typename Component >
SparseSet< Component > &	writeAll ()
template<typename Component >
const SparseSet< Component > &	readAll () const

Private Member Functions
bool	ensureLoaded (AudioSourceComponent &audioSource)
void	handlePlayback (AudioSourceComponent &audioSource)
void	handleVolume ()
	Updates volume for all audio sources.
void	handleSpatiality ()
	Updates spatial audio based on camera position.

Private Attributes
std::unique_ptr< ma_engine >	_engine
	Miniaudio engine instance.

Detailed Description

System that manages audio playback and spatial audio.

Constructor & Destructor Documentation

AudioSystem()

shkyera::AudioSystem::AudioSystem ( std::shared_ptr< Registry >  registry )

explicit

Parameters

registry

Registry to read audio components from

~AudioSystem()

shkyera::AudioSystem::~AudioSystem

(

)

Member Function Documentation

ensureLoaded()

bool shkyera::AudioSystem::ensureLoaded ( AudioSourceComponent &  audioSource )

private

Parameters

audioSource

Audio source to check

Returns

Whether the audio source is properly loaded

handlePlayback()

void shkyera::AudioSystem::handlePlayback ( AudioSourceComponent &  audioSource )

private

Parameters

audioSource

Audio source to update playback for

handleSpatiality()

void shkyera::AudioSystem::handleSpatiality ( )

private

Updates spatial audio based on camera position.

handleVolume()

void shkyera::AudioSystem::handleVolume ( )

private

Updates volume for all audio sources.

update()

void shkyera::AudioSystem::update

(

)

Updates audio playback state and spatial audio.

Member Data Documentation

_engine

std::unique_ptr<ma_engine> shkyera::AudioSystem::_engine

private

Miniaudio engine instance.

---

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

• src/Systems/AudioSystem.hpp
• src/Systems/AudioSystem.cpp