Overload  1.1
Game engine with editor
Public Member Functions | List of all members
OvAudio::Core::AudioEngine Class Reference

#include <AudioEngine.h>

Public Member Functions

 AudioEngine (const std::string &p_workingDirectory)
 ~AudioEngine ()
void Update ()
void Suspend ()
void Unsuspend ()
bool IsSuspended () const
const std::string & GetWorkingDirectory () const
irrklang::ISoundEngine * GetIrrklangEngine () const
std::optional< std::pair< OvMaths::FVector3, OvMaths::FVector3 > > GetListenerInformation (bool p_considerDisabled=false) const

Detailed Description

Handle the creation of the Audio context Will take care of the consideration of AudioSources and AudioListeners

Constructor & Destructor Documentation

◆ AudioEngine()

OvAudio::Core::AudioEngine::AudioEngine ( const std::string &  p_workingDirectory)

Constructor of the AudioEngine

@project: Overload

: Overload Tech. @restrictions: This software may not be resold, redistributed or otherwise conveyed to a third party.

◆ ~AudioEngine()

OvAudio::Core::AudioEngine::~AudioEngine ( )

Destructor of the AudioEngine

Member Function Documentation

◆ GetIrrklangEngine()

irrklang::ISoundEngine * OvAudio::Core::AudioEngine::GetIrrklangEngine ( ) const

Returns the IrrKlang engine

◆ GetListenerInformation()

std::optional< std::pair< OvMaths::FVector3, OvMaths::FVector3 > > OvAudio::Core::AudioEngine::GetListenerInformation ( bool  p_considerDisabled = false) const

Returns the current listener informations : Format: std::tuple<Active, Position, Direction> @parma p_considerDisabled

◆ GetWorkingDirectory()

const std::string & OvAudio::Core::AudioEngine::GetWorkingDirectory ( ) const

Returns the working directory

◆ IsSuspended()

bool OvAudio::Core::AudioEngine::IsSuspended ( ) const

Returns true if the AudioEngine is currently suspended

◆ Suspend()

void OvAudio::Core::AudioEngine::Suspend ( )

Suspend every sounds. Keeps every sound state (Pause and play) to Unsuspend them correctly

◆ Unsuspend()

void OvAudio::Core::AudioEngine::Unsuspend ( )

Suspend every sounds. Resume previously played sounds

◆ Update()

void OvAudio::Core::AudioEngine::Update ( )

Update AudioSources and AudioListeners

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