RAY::Audio::Music Class Reference

A manager for music stream. More...

#include <Music.hpp>

Inheritance diagram for RAY::Audio::Music:

Collaboration diagram for RAY::Audio::Music:

Public Member Functions
	Music (const std::string &path, bool lonely=false)
	Load Music stream from file. More...
	~Music ()=default
	Default destructor. More...
	Music (const Music &Music)=default
	A copy constructor constructor. More...
Music &	operator= (const Music &Music)=default
	A Music is assignable. More...
bool	isPlaying (void) override
	Check if Music is playing. More...
Music &	play (void) override
	Start Music. More...
Music &	stop (void) override
	Stop Music playing. More...
Music &	pause (void) override
	Pause Music playing. More...
Music &	resume (void) override
	Resume playing paused Music. More...
Music &	setVolume (float volume) override
	Set volume for Music (1.0 is max level) More...
Music &	setPitch (float pitch) override
Music &	updateMusicStream (void)
Public Member Functions inherited from RAY::Audio::IAudio
virtual	~IAudio ()=default

Private Attributes
std::shared_ptr<::Music >	_music

Static Private Attributes
static RAY::Cache<::Music >	_musicsCache

Detailed Description

A manager for music stream.

Constructor & Destructor Documentation

Music() [1/2]

RAY::Audio::Music::Music	(	const std::string &	path,
		bool	lonely = false
	)

Load Music stream from file.

Parameters

lonely

should be set to true if the entity's loaded data must be independant from others

~Music()

RAY::Audio::Music::~Music ( )

default

Default destructor.

Music() [2/2]

RAY::Audio::Music::Music ( const Music &  Music )

default

A copy constructor constructor.

Member Function Documentation

isPlaying()

bool RAY::Audio::Music::isPlaying ( void  )

overridevirtual

Check if Music is playing.

Implements RAY::Audio::IAudio.

operator=()

Music& RAY::Audio::Music::operator= ( const Music &  Music )

default

A Music is assignable.

pause()

RAY::Audio::Music & RAY::Audio::Music::pause ( void  )

overridevirtual

Pause Music playing.

Implements RAY::Audio::IAudio.

play()

RAY::Audio::Music & RAY::Audio::Music::play ( void  )

overridevirtual

Start Music.

Implements RAY::Audio::IAudio.

resume()

RAY::Audio::Music & RAY::Audio::Music::resume ( void  )

overridevirtual

Resume playing paused Music.

Implements RAY::Audio::IAudio.

setPitch()

RAY::Audio::Music & RAY::Audio::Music::setPitch ( float  pitch )

overridevirtual

Implements RAY::Audio::IAudio.

setVolume()

RAY::Audio::Music & RAY::Audio::Music::setVolume ( float  volume )

overridevirtual

Set volume for Music (1.0 is max level)

Implements RAY::Audio::IAudio.

stop()

RAY::Audio::Music & RAY::Audio::Music::stop ( void  )

overridevirtual

Stop Music playing.

Implements RAY::Audio::IAudio.

updateMusicStream()

RAY::Audio::Music & RAY::Audio::Music::updateMusicStream

(

void

)

Member Data Documentation

_music

std::shared_ptr<::Music> RAY::Audio::Music::_music

private

_musicsCache

RAY::Cache<::Music > RAY::Audio::Music::_musicsCache

staticprivate

---

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

• lib/Ray/sources/Audio/Music.hpp
• lib/Ray/sources/Audio/Music.cpp