CVoicePlayer Class Reference
The class used for playing synchronous voice data.
More...
#include <SoundModule.h>
List of all members.
|
Public Member Functions |
| void | Start (ALenum format, ALfloat freq) |
| void | PushVoiceData (const ALbyte *data, int len) |
|
void | Stop () |
| | Stops the voice playing,.
|
| void | SetVolume (float v) |
|
float | GetVolume () |
| | Returns the volume of the voice player.
|
Detailed Description
The class used for playing synchronous voice data.
Member Function Documentation
| void CVoicePlayer::Start |
( |
ALenum |
format, |
|
|
ALfloat |
freq | |
|
) |
| | |
Starts the voice playing on this voice player.
- Parameters:
-
| format | One of AL_FORMAT_* values denoting the sound format of the played voice. |
| freq | A floating point value denoting the frequency of the played voice. |
| void CVoicePlayer::PushVoiceData |
( |
const ALbyte * |
data, |
|
|
int |
len | |
|
) |
| | |
Pushes voice data to the voice player so that this data is played. Start must be called before calling this.
- Parameters:
-
| data | The address of the voice data. |
| len | The length of the voice data. |
| void CVoicePlayer::SetVolume |
( |
float |
v |
) |
|
Sets the volume of the voice player.
- Parameters:
-
| v | The amount of volume. It should be between 0.0 and 1.0 inclusively. |
The documentation for this class was generated from the following file:
