UGDK  0.5.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
ugdk::audio::Manager Class Reference

#include <ugdk/audio/manager.h>

Public Member Functions

 Manager ()
 
 ~Manager ()
 
bool Initialize ()
 Initializes audio channels. More...
 
void Release ()
 Frees all audio samples and music, and closes the audio channels. More...
 
void Update ()
 Logical update. Currently does nothing. More...
 
SampleLoadSample (const std::string &filepath)
 Loads an audio sample. More...
 
MusicLoadMusic (const std::string &filepath)
 Loads a music. More...
 
MusicCurrentMusic () const
 Getter for the music that is currently playing. More...
 

Constructor & Destructor Documentation

ugdk::audio::Manager::Manager ( )
ugdk::audio::Manager::~Manager ( )

Member Function Documentation

Music* ugdk::audio::Manager::CurrentMusic ( ) const

Getter for the music that is currently playing.

Returns
nullptr is no music is currently playing, a Music* otherwise.
bool ugdk::audio::Manager::Initialize ( )

Initializes audio channels.

Returns
True if successful, false otherwise.
Music* ugdk::audio::Manager::LoadMusic ( const std::string &  filepath)

Loads a music.

Parameters
filepathThe path to the music file.
Sample* ugdk::audio::Manager::LoadSample ( const std::string &  filepath)

Loads an audio sample.

Parameters
filepathThe path to the audio sample.
void ugdk::audio::Manager::Release ( )

Frees all audio samples and music, and closes the audio channels.

void ugdk::audio::Manager::Update ( )

Logical update. Currently does nothing.


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