Engine::Audio::Music Class Reference

An Audio file that queues itself into the music player of the engine. More...

#include <Music.hpp>

Inheritance diagram for Engine::Audio::Music:

Public Member Functions
	Music (const char *filename)
SoundState	playing ()
	Returns if the sound is playing or not.
void	Pause ()
	Pauses the music.
void	setLoop (bool shouldLoop)
	Sets if the song should loop.
Public Member Functions inherited from Engine::Audio::Audio
	Audio (const char *filename)
	Default constructor.
void	Play ()
	Plays the audio file.

Additional Inherited Members
Protected Attributes inherited from Engine::Audio::Audio
const char *	m_filename

Detailed Description

An Audio file that queues itself into the music player of the engine.

Author

Roberto Selles

Member Function Documentation

Pause()

void Engine::Audio::Music::Pause

(

)

Pauses the music.

This will pause the whole queue, but we can assume that the song will be playing when this song is playing

playing()

Engine::Audio::SoundState Engine::Audio::Music::playing

(

)

Returns if the sound is playing or not.

Returns

SoundState if sound is playing or not

setLoop()

void Engine::Audio::Music::setLoop

(

bool

shouldLoop

)

Sets if the song should loop.

Parameters

{shouldLoop}

the value set to the song

---

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

• src/engine/Audio/Music.hpp
• src/engine/Audio/Music.cpp