Single playable audio clip backed by a decoded miniaudio stream. More...

#include <Audio.h>

Public Member Functions
	~Audio ()

void	SetPosition (const glm::vec3 &position)
	Place the emitter at a world-space position (3D spatialisation).

void	Play (bool loop=false)
	Start playback. Pass `true` to loop forever.

void	Stop ()
	Halt playback if currently playing; no-op otherwise.

bool	IsPlaying () const
	True between Play() and natural end / Stop().

void	SetVolume (float volume)
	Linear gain in [0, 1]. Values above 1 amplify but may clip.

float	GetVolume () const

Static Public Member Functions
static std::shared_ptr< Audio >	Load (const std::string &path)
	Decode an audio file from disk and return a shared instance.

Detailed Description

Single playable audio clip backed by a decoded miniaudio stream.

Definition at line 34 of file Audio.h.

Constructor & Destructor Documentation

◆ ~Audio()

mnd::Audio::~Audio ( )

Definition at line 9 of file Audio.cpp.

Member Function Documentation

◆ GetVolume()

float mnd::Audio::GetVolume ( ) const

Definition at line 65 of file Audio.cpp.

◆ IsPlaying()

bool mnd::Audio::IsPlaying ( ) const

True between Play() and natural end / Stop().

Definition at line 48 of file Audio.cpp.

◆ Load()

std::shared_ptr< Audio > mnd::Audio::Load ( const std::string & path )

static

Decode an audio file from disk and return a shared instance.

Parameters

path	Path under the assets directory; resolved by FileSystem.

Returns: Non-null shared pointer on success, null on decode failure.

Definition at line 74 of file Audio.cpp.

References mnd::Engine::GetAudioManager(), mnd::AudioManager::GetEngine(), mnd::Engine::GetFileSystem(), mnd::Engine::GetInstance(), and mnd::FileSystem::LoadAssetFile().

Referenced by mnd::AudioComponent::LoadProperties().

◆ Play()

void mnd::Audio::Play ( bool loop = false )

Start playback. Pass true to loop forever.

Definition at line 29 of file Audio.cpp.

◆ SetPosition()

void mnd::Audio::SetPosition ( const glm::vec3 & position )

Place the emitter at a world-space position (3D spatialisation).

Definition at line 21 of file Audio.cpp.

◆ SetVolume()

void mnd::Audio::SetVolume ( float volume )

Linear gain in [0, 1]. Values above 1 amplify but may clip.

Definition at line 57 of file Audio.cpp.

◆ Stop()

void mnd::Audio::Stop ( )

Halt playback if currently playing; no-op otherwise.

Definition at line 39 of file Audio.cpp.

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

engine/source/audio/Audio.h
engine/source/audio/Audio.cpp

Public Member Functions

Static Public Member Functions