le::IAudioMixer Class Reference

Opaque audio mixer interface. More...

#include <le2d/audio_mixer.hpp>

Inheritance diagram for le::IAudioMixer:

Public Member Functions
virtual auto	get_sfx_gain () const -> float=0
virtual void	set_sfx_gain (float gain)=0
virtual void	play_sfx (gsl::not_null< IAudioBuffer const * > buffer)=0
virtual void	stop_sfx ()=0
virtual auto	get_music_gain () const -> float=0
virtual void	set_music_gain (float gain)=0
virtual void	loop_music (gsl::not_null< IAudioBuffer const * > buffer, kvf::Seconds fade=1s)=0
virtual void	pause_music ()=0
virtual void	resume_music ()=0
virtual void	stop_music ()=0
virtual auto	create_source () const -> std::unique_ptr< capo::ISource >=0
	Create a custom audio source managed outide the mixer.
virtual auto	is_playing () const -> bool=0
virtual void	wait_idle ()=0
	Waits for playing SFX to finish, stops music.
virtual void	stop_all ()=0
	Stops all SFX and music.

Detailed Description

Opaque audio mixer interface.

The concrete type is not publicly accesssible. Passed IAudioBuffers must outlive playback. Use stop_*() or wait_idle() to unbind buffers from audio sources.

Member Function Documentation

create_source()

virtual auto le::IAudioMixer::create_source ( ) const -> std::unique_ptr< capo::ISource >

pure virtual

Create a custom audio source managed outide the mixer.

get_music_gain()

virtual auto le::IAudioMixer::get_music_gain ( ) const -> float

pure virtual

get_sfx_gain()

virtual auto le::IAudioMixer::get_sfx_gain ( ) const -> float

pure virtual

is_playing()

virtual auto le::IAudioMixer::is_playing ( ) const -> bool

pure virtual

Returns

true if any SFX or music is playing.

loop_music()

virtual void le::IAudioMixer::loop_music ( gsl::not_null< IAudioBuffer const * >  buffer, kvf::Seconds  fade = 1s  )

pure virtual

pause_music()

virtual void le::IAudioMixer::pause_music ( )

pure virtual

play_sfx()

virtual void le::IAudioMixer::play_sfx ( gsl::not_null< IAudioBuffer const * >  buffer )

pure virtual

resume_music()

virtual void le::IAudioMixer::resume_music ( )

pure virtual

set_music_gain()

virtual void le::IAudioMixer::set_music_gain ( float  gain )

pure virtual

set_sfx_gain()

virtual void le::IAudioMixer::set_sfx_gain ( float  gain )

pure virtual

stop_all()

virtual void le::IAudioMixer::stop_all ( )

pure virtual

Stops all SFX and music.

stop_music()

virtual void le::IAudioMixer::stop_music ( )

pure virtual

stop_sfx()

virtual void le::IAudioMixer::stop_sfx ( )

pure virtual

wait_idle()

virtual void le::IAudioMixer::wait_idle ( )

pure virtual

Waits for playing SFX to finish, stops music.

---

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

• audio_mixer.hpp