CEncodedVoicePlayer Class Reference

This class combines CVoicePlayer and CSoundCodec to playback encoded voice data. More...

#include <SoundModule.h>

List of all members.

Public Member Functions
	CEncodedVoicePlayer ()
	Constructor. This does not initiate sound playing.
void	Start (const char *options)
void	PushVoiceData (const ALbyte *data, int len)
void	Stop ()
	Stops the voice playing,.
	~CEncodedVoicePlayer ()
	Destructor.
void	SetVolume (float v)
float	GetVolume ()
	Returns the amount of current volume.
Protected Attributes
char *	options
	Holds the sound options string.
CVoicePlayer	vp
	The voice player used.
CSoundCodec	codec
	The sound codec used.

---

Detailed Description

This class combines CVoicePlayer and CSoundCodec to playback encoded voice data.

---

Member Function Documentation

void CEncodedVoicePlayer::Start

(

const char *

options

)

Initiates the encoded sound playing if it is not playing.

Parameters:

options

The sound options string. Refer to the design report.

void CEncodedVoicePlayer::PushVoiceData	(	const ALbyte *	data,
		int	len
	)

Pushes encoded voice data to the encoded voice player so that this data is played. Start must be called before calling this.

Parameters:

	data	The address of the encoded voice data.
	len	The length of the encoded voice data.

void CEncodedVoicePlayer::SetVolume

(

float

v

)

Sets the volume of the encoded voice player. param 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:

• SoundModule.h