turbo::MusicStream Class Reference

A music track streamed (decoded on the fly) from a file, for audio too long to keep fully in memory. For short effects, use Sound. More...

#include <MusicStream.hpp>

Inheritance diagram for turbo::MusicStream:

Collaboration diagram for turbo::MusicStream:

Public Member Functions
	MusicStream (Path *path)
	Open an audio file as a stream.
	~MusicStream ()
void	play () override
	Start, or resume, playback.
void	pause () override
	Pause playback, keeping the current position.
void	reset () override
	Stop playback and rewind to the beginning.
bool	is_playing () const override
	Whether the audio is currently playing.

Protected Attributes
ALLEGRO_AUDIO_STREAM *	stream = nullptr

Detailed Description

A music track streamed (decoded on the fly) from a file, for audio too long to keep fully in memory. For short effects, use Sound.

Constructor & Destructor Documentation

MusicStream()

turbo::MusicStream::MusicStream ( Path * path )

explicit

Open an audio file as a stream.

Parameters

path	path to the audio file

~MusicStream()

turbo::MusicStream::~MusicStream

(

)

Member Function Documentation

is_playing()

bool turbo::MusicStream::is_playing ( ) const

nodiscardoverridevirtual

Whether the audio is currently playing.

Implements turbo::Audio.

pause()

void turbo::MusicStream::pause ( )

overridevirtual

Pause playback, keeping the current position.

Implements turbo::Audio.

play()

void turbo::MusicStream::play ( )

overridevirtual

Start, or resume, playback.

Implements turbo::Audio.

reset()

void turbo::MusicStream::reset ( )

overridevirtual

Stop playback and rewind to the beginning.

Implements turbo::Audio.

Member Data Documentation

stream

ALLEGRO_AUDIO_STREAM* turbo::MusicStream::stream = nullptr

protected

---

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

• include/turbo/sound/MusicStream.hpp
• src/sound/MusicStream.cpp