Public Member Functions | Static Public Member Functions

# USpeedGameEngine::Audio Class Reference

Classe de traitement de la couche sonore
Gestion du son "Wave" et "Module"
Elle est multi-instanciable. More...

List of all members.

## Public Member Functions

| Audio ()
| Constructeur par défaut.
| ~Audio ()
| Destructeur par défaut.
bool | loadWave (const char *filename)
| Permet de charger le fichier son WAVE (supprime le précédent).
bool | loadWaveFromBuffer (const char *myDatas, unsigned int dataSize)
| Permet de charger le fichier son WAVE depuis un tampon mémoire (supprime le précédent).
bool | loadModule (const char *filename, bool stopPrevious)
| Permet de charger le fichier son MODULE.
bool | loadModule (const char *filename)
| Permet de charger le fichier son MODULE (supprime la lecture du module précédente).
bool | loadModuleFromBuffer (const char *myDatas, unsigned int dataSize, bool stopPrevious)
| Permet de charger le son MODULE depuis un tampon mémoire.
bool | loadModuleFromBuffer (const char *myDatas, unsigned int dataSize)
| Permet de charger le son MODULE depuis un tampon mémoire (écrase le précédent).
void | play ()
| Permet de lancer la lecture du son (en boucle ou non) et de revenir au début.
void | stop ()
| Permet d'arrêter la lecture des pistes.
void | wait ()
| Permet de mettre la lecture en pause ("play" pour relancer).
void | volume (unsigned int percent)
| Permet de définir le volume audio (en pourcentage).
void | restart ()
| Permet de revenir au début de la piste.
void | loop (bool looping)
| Permet de lire la piste en boucle ou non.
void | reset ()
| Remet à zéro l'état de l'instance.

## Static Public Member Functions

static bool | init ()
| Initialise le son.

## Detailed Description

Classe de traitement de la couche sonore
Gestion du son "Wave" et "Module"
Elle est multi-instanciable.

Author:
  U.Speed

## Constructor & Destructor Documentation

Audio::Audio | ( |  | ) |

Constructeur par défaut.

Author:
  U.Speed

Audio::~Audio | ( |  | ) |

Destructeur par défaut.

Author:
  U.Speed

## Member Function Documentation

bool Audio::init | ( |  | ) | `[static]`

Initialise le son.

Author:
  U.Speed

Returns:
  bool : état de l'initialisation
  - true : initialisé
  - false : non initialisé

bool Audio::loadModule | ( | const char * | filename,
|  | bool | stopPrevious |
| ) |  |  |

Permet de charger le fichier son MODULE.

Author:
  U.Speed

See also:
  bool USpeedGameEngine::Audio::loadModuleFromBuffer(const char *myDatas, unsigned int dataSize, bool stopPrevious)

Parameters:

  | filename | const char* : le nom du fichier à charger
  | stopPrevious | bool : pour savoir si on arrête l'éventuelle lecture précédente
  - true : si une lecture de module a lieu, on l'arrête pour charger le nouveau module
  - false : si une lecture de module a lieu, on sort en erreur

Returns:
  bool : état du chargement
  - true : chargement réussi
  - false : chargement échoué

bool USpeedGameEngine::Audio::loadModule | ( | const char * | filename | ) |

Permet de charger le fichier son MODULE (supprime la lecture du module précédente).

Author:
  U.Speed

See also:
  bool USpeedGameEngine::Audio::loadModule(const char *filename, bool stopPrevious)

Parameters:

  | filename | const char* : le nom du fichier à charger

Returns:
  bool : état du chargement
  - true : chargement réussi
  - false : chargement échoué

bool USpeedGameEngine::Audio::loadModuleFromBuffer | ( | const char * | myDatas,
|  | unsigned int | dataSize,
|  | bool | stopPrevious |
| ) |  |  |

Permet de charger le son MODULE depuis un tampon mémoire.

Author:
  U.Speed

Parameters:

  | myDatas | const char* : les données à charger
  | dataSize | unsigned int : la taille des données
  | stopPrevious | bool : pour savoir si on arrête l'éventuelle lecture précédente
  - true : si une lecture de module a lieu, on l'arrête pour charger le nouveau module
  - false : si une lecture de module a lieu, on sort en erreur

Returns:
  bool : état du chargement
  - true : chargement réussi
  - false : chargement échoué

bool USpeedGameEngine::Audio::loadModuleFromBuffer | ( | const char * | myDatas,
|  | unsigned int | dataSize |
| ) |  |  |

Permet de charger le son MODULE depuis un tampon mémoire (écrase le précédent).

Author:
  U.Speed

See also:
  bool USpeedGameEngine::Audio::loadModuleFromBuffer(const char *myDatas, unsigned int dataSize, bool stopPrevious)

Parameters:

  | myDatas | const char* : les données à charger
  | dataSize | unsigned int : la taille des données

Returns:
  bool : état du chargement
  - true : chargement réussi
  - false : chargement échoué

bool Audio::loadWave | ( | const char * | filename | ) |

Permet de charger le fichier son WAVE (supprime le précédent).

Author:
  U.Speed

See also:
  bool Audio::loadWaveFromBuffer(const char *myDatas, unsigned int dataSize)

Parameters:

  | filename | const char* : le nom du fichier à charger

Returns:
  bool : état du chargement
  - true : chargement réussi
  - false : chargement échoué

bool Audio::loadWaveFromBuffer | ( | const char * | myDatas,
|  | unsigned int | dataSize |
| ) |  |  |

Permet de charger le fichier son WAVE depuis un tampon mémoire (supprime le précédent).

Author:
  U.Speed

Parameters:

  | myDatas | const char* : les données à charger
  | dataSize | unsigned int : la taille des données

Returns:
  bool : état du chargement
  - true : chargement réussi
  - false : chargement échoué

void Audio::loop | ( | bool | looping | ) |

Permet de lire la piste en boucle ou non.

Author:
  U.Speed

Parameters:

  | looping | bool : état de la boucle
  - true : lecture en boucle
  - false : lecture une seule fois

void Audio::play | ( |  | ) |

Permet de lancer la lecture du son (en boucle ou non) et de revenir au début.

Author:
  U.Speed

void Audio::reset | ( |  | ) |

Remet à zéro l'état de l'instance.

Author:
  U.Speed

void Audio::restart | ( |  | ) |

Permet de revenir au début de la piste.

Author:
  U.Speed

void Audio::stop | ( |  | ) |

Permet d'arrêter la lecture des pistes.

Author:
  U.Speed

void Audio::volume | ( | unsigned int | percent | ) |

Permet de définir le volume audio (en pourcentage).

Author:
  U.Speed

Parameters:

  | percent | unsigned int : le pourcentage du volume sonore

void Audio::wait | ( |  | ) |

Permet de mettre la lecture en pause ("play" pour relancer).

Author:
  U.Speed

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

- src/Audio/Audio.hpp
- src/Audio/Audio.cpp
- src/Audio/Audio_init.cpp
- src/Audio/Audio_loadModule.cpp
- src/Audio/Audio_loadModuleFromBuffer.cpp
- src/Audio/Audio_loadWave.cpp
- src/Audio/Audio_loadWaveFromBuffer.cpp
- src/Audio/Audio_loop.cpp
- src/Audio/Audio_play.cpp
- src/Audio/Audio_reset.cpp
- src/Audio/Audio_restart.cpp
- src/Audio/Audio_stop.cpp
- src/Audio/Audio_volume.cpp
- src/Audio/Audio_wait.cpp