2D_Game_Engine
Loading...
Searching...
No Matches
Public Member Functions | List of all members
AudioPlayer Class Reference

#include <audio.hpp>

Public Member Functions

 AudioPlayer ()
 
int LoadAudio (const char *path)
 
int LoadAudioLong (const char *path)
 
void PlayAudio (int index)
 
void PlayAudioLong (int index)
 
void StopAudio (int index)
 
void StopAudioLong (int index)
 
void ClearAudio ()
 
void ClearAudioLong ()
 

Detailed Description

Definition at line 8 of file audio.hpp.

Constructor & Destructor Documentation

◆ AudioPlayer()

AudioPlayer::AudioPlayer ( )
inline

Definition at line 10 of file audio.hpp.

Member Function Documentation

◆ ClearAudio()

void AudioPlayer::ClearAudio ( )

Free all the audio files loaded with LoadAudio

Definition at line 58 of file audio.cpp.

◆ ClearAudioLong()

void AudioPlayer::ClearAudioLong ( )

Free all the audio files loaded with LoadAudioLong

Definition at line 65 of file audio.cpp.

◆ LoadAudio()

int AudioPlayer::LoadAudio ( const char * path)

Load an audio file in memory Suggested for short audio files.

Parameters
paththe path to the audio file

Definition at line 14 of file audio.cpp.

◆ LoadAudioLong()

int AudioPlayer::LoadAudioLong ( const char * path)

Load an audio file. The audio file is streamed from the disk. Suggested for long audio files.

Parameters
paththe path to the audio file

Definition at line 24 of file audio.cpp.

◆ PlayAudio()

void AudioPlayer::PlayAudio ( int index)

Play an audio loaded with LoadAudio

Parameters
indexthe index of the audio file returned by LoadAudio

Definition at line 34 of file audio.cpp.

◆ PlayAudioLong()

void AudioPlayer::PlayAudioLong ( int index)

Play an audio loaded with LoadAudioLong

Parameters
indexthe index of the audio file returned by LoadAudioLong

Definition at line 40 of file audio.cpp.

◆ StopAudio()

void AudioPlayer::StopAudio ( int index)

Stop an audio loaded with LoadAudio If the audio is playing multiple times, it will stop all the instances.

Parameters
indexthe index of the audio file returned by LoadAudio

Definition at line 46 of file audio.cpp.

◆ StopAudioLong()

void AudioPlayer::StopAudioLong ( int index)

Stop an audio loaded with LoadAudioLong If the audio is playing multiple times, it will stop all the instances.

Parameters
indexthe index of the audio file returned by LoadAudioLong

Definition at line 52 of file audio.cpp.


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