Common::TTSVoice Class Reference

#include <text-to-speech.h>

Public Types
enum	Gender { MALE, FEMALE, UNKNOWN_GENDER }
enum	Age { CHILD, ADULT, UNKNOWN_AGE }

Public Member Functions
	TTSVoice (Gender gender, Age age, void *data, String description)
	TTSVoice (const TTSVoice &voice)
TTSVoice &	operator= (const TTSVoice &voice)
Gender	getGender ()
void	setGender (Gender gender)
Age	getAge ()
void	setAge (Age age)
void *	getData ()
void	setData (void *data)
String	getDescription ()

Protected Attributes
Gender	_gender
	Gender of the voice.
Age	_age
	Age of the voice.
void *	_data
	Pointer to tts engine specific data about the voice.
String	_description
	Description of the voice (gets displayed in GUI)
int *	_refCount
	Reference count (serves for proper feeing of _data)

Detailed Description

Text to speech voice class.

Member Function Documentation

getGender()

Gender Common::TTSVoice::getGender ( )

inline

Returns the gender of the used voice.

Note

The gender information is really platform specific, it may not be possible to find it out on some platforms. Sometimes it can be set by the user in the TTS engine configuration and so the information might be wrong

setGender()

void Common::TTSVoice::setGender ( Gender  gender )

inline

Sets the voice gender, should probably be used only by the backends that are directly communicating with the TTS engine.

getAge()

Age Common::TTSVoice::getAge ( )

inline

Returns the age of the used voice.

Note

The age information is really platform specific, it may not be possible to find it out on some platforms. Sometimes it can be set by the user in the TTS engine configuration and so the information might be wrong

setAge()

void Common::TTSVoice::setAge ( Age  age )

inline

Sets the voice age, should probably be used only by the backends that are directly communicating with the TTS engine.

getData()

void* Common::TTSVoice::getData ( )

inline

Returns the data about the voice, this is engine specific variable, it has close to no value for anything else then communicating directly with the TTS engine, which should probably be done only by the backends.

setData()

void Common::TTSVoice::setData ( void *  data )

inline

Sets the voice data, should probably be used only by the backends that are directly communicating with the TTS engine.

getDescription()

String Common::TTSVoice::getDescription ( )

inline

Returns the voice description. This description is really tts engine specific and might be not be available with some tts engines.

---

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

• common/text-to-speech.h