Mochi::Audio::DummyAudioManager Class Reference

Inheritance diagram for Mochi::Audio::DummyAudioManager:

Public Member Functions
virtual void	Update (const float &dt) override
	Update internal audio subsystems.
virtual void	LoadAudio (const std::string &path) override
	Preloads an audio file.
virtual void	UnloadAudio (const std::string &path) override
	Unloads a loaded audio.
virtual void	PlayBGM (const std::string &audioName) override
	Plays an audio as BGM.
virtual void	PauseBGM () override
	Pauses current playing BGM (can resume at the same point).
virtual void	StopBGM () override
	Stops current playing BGM (can't resume).
virtual void	ResumeBGM () override
	Resume current playing BGM.
virtual void	SkipToTimelinePosition (const int &ms) override
	Skip current playing BGM to a certain position.
virtual void	PlayOneShot (const std::string &audioName) override
	Plays an audio once and then stops it.
virtual void	SetParameter (const std::string &parameterName, const float &value) override
	Sets a parameter used by the audio system. This can vary between implementations. Check specific implementations of this class to check what you can do with this.
virtual void	SetMixerVolume (const std::string &mixerGroupName, const float &value) override
	Changes the volume of a specific mixer/group.

Member Function Documentation

LoadAudio()

virtual void Mochi::Audio::DummyAudioManager::LoadAudio ( const std::string & path )

inlineoverridevirtual

Preloads an audio file.

Parameters

path	The path to the file in the catalog

Implements Mochi::Audio::IAudioManager.

PauseBGM()

virtual void Mochi::Audio::DummyAudioManager::PauseBGM ( )

inlineoverridevirtual

Pauses current playing BGM (can resume at the same point).

Implements Mochi::Audio::IAudioManager.

PlayBGM()

virtual void Mochi::Audio::DummyAudioManager::PlayBGM ( const std::string & audioName )

inlineoverridevirtual

Plays an audio as BGM.

Parameters

audioName

Identifier of the audio

Implements Mochi::Audio::IAudioManager.

PlayOneShot()

virtual void Mochi::Audio::DummyAudioManager::PlayOneShot ( const std::string & audioName )

inlineoverridevirtual

Plays an audio once and then stops it.

Parameters

audioName

Identifier of the audio

Implements Mochi::Audio::IAudioManager.

ResumeBGM()

virtual void Mochi::Audio::DummyAudioManager::ResumeBGM ( )

inlineoverridevirtual

Resume current playing BGM.

Implements Mochi::Audio::IAudioManager.

SetMixerVolume()

virtual void Mochi::Audio::DummyAudioManager::SetMixerVolume ( const std::string & mixerGroupName, const float & value )

inlineoverridevirtual

Changes the volume of a specific mixer/group.

Parameters

mixerGroupName	The name of the mixer/group.
value	The new volume (between 0 and 1)

Implements Mochi::Audio::IAudioManager.

SetParameter()

virtual void Mochi::Audio::DummyAudioManager::SetParameter ( const std::string & parameterName, const float & value )

inlineoverridevirtual

Sets a parameter used by the audio system. This can vary between implementations. Check specific implementations of this class to check what you can do with this.

Parameters

parameterName	The name or identifier of the parameter.
value	The value of the parameter.

Implements Mochi::Audio::IAudioManager.

SkipToTimelinePosition()

virtual void Mochi::Audio::DummyAudioManager::SkipToTimelinePosition ( const int & ms )

inlineoverridevirtual

Skip current playing BGM to a certain position.

Parameters

ms	Point of the song in milliseconds

Implements Mochi::Audio::IAudioManager.

StopBGM()

virtual void Mochi::Audio::DummyAudioManager::StopBGM ( )

inlineoverridevirtual

Stops current playing BGM (can't resume).

Implements Mochi::Audio::IAudioManager.

UnloadAudio()

virtual void Mochi::Audio::DummyAudioManager::UnloadAudio ( const std::string & path )

inlineoverridevirtual

Unloads a loaded audio.

Parameters

path	The path to the file in the catalog

Implements Mochi::Audio::IAudioManager.

Update()

virtual void Mochi::Audio::DummyAudioManager::Update ( const float & dt )

inlineoverridevirtual

Update internal audio subsystems.

Parameters

dt	Delta time

Implements Mochi::Audio::IAudioManager.

---

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

• Engine/src/Audio/DummyAudioManager.h