ESpeakFiles Class Reference

Simple Arduino C++ class API for ESpeak using files. More...

#include <espeak.h>

Inheritance diagram for ESpeakFiles:

Public Member Functions
	ESpeakFiles (Print &out, const char *path="../../../espeak-ng-data")
audio_info	audioInfo ()
	Provides information about the sample rate, channels .... More...
bool	begin (int buflength=5)
	Starts the processing. Optionally add all relevant configuration files be fore calling this method. More...
bool	setVoice (const char *voiceName)
	Defines the voice by i'ts name. More...
bool	setVoice (espeak_VOICE *voice_spec)
	Defines the voice by it's properties. More...
espeak_VOICE *	voice ()
	Determiens the current voice. More...
void	end ()
	Stops the processing. More...
bool	say (const char *str)
	Outputs the string as sound. More...
bool	setRate (int rate)
	speaking speed in word per minute. Values 80 to 450. More...
bool	setVolume (int vol)
	volume in range 0-200 or more. 0=silence, 100=normal full volume, greater values may produce amplitude compression or distortion More...
bool	setPitch (int pitch)
	PITCH: base pitch, range 0-100. 50=normal. More...
bool	setPitchRange (int range)
	RANGE: pitch range, range 0-100. 0-monotone, 50=normal. More...
bool	setPunctuation (espeak_PUNCT_TYPE punct)
	PUNCTUATION: which punctuation characters to announce: value in espeak_PUNCT_TYPE (none, all, some), see espeak_GetParameter() to specify which characters are announced. More...
bool	setAnnounceCapitals (int caps)
	CAPITALS: announce capital letters by: 0=none, 1=sound icon, 2=spelling, 3 or higher, by raising pitch. This values gives the amount in Hz by which the pitch of a word raised to indicate it has a capital letter. More...
bool	setWordGap (int gap)
	WORDGAP: pause between words, units of 10mS (at the default speed) More...
bool	setParameter (espeak_PARAMETER parameter, int value, int relative=0)
	Sets Parameter: espeakRATE, espeakVOLUME etc. More...

Protected Attributes
const short	memory_guard = 23
const espeak_AUDIO_OUTPUT	output = AUDIO_OUTPUT_SYNCH_PLAYBACK
const char *	path = "../../../espeak-ng-data-min"
void *	user_data = nullptr
int	options = 0
unsigned int *	identifier = nullptr
unsigned int	position = 0
unsigned int	end_position = 0
unsigned int	flags = espeakCHARS_AUTO
espeak_POSITION_TYPE	position_type = POS_CHARACTER

Detailed Description

Simple Arduino C++ class API for ESpeak using files.

Constructor & Destructor Documentation

ESpeakFiles()

ESpeakFiles::ESpeakFiles ( Print &  out, const char *  path = "../../../espeak-ng-data"  )

inline

Member Function Documentation

audioInfo()

audio_info ESpeakFiles::audioInfo ( )

inline

Provides information about the sample rate, channels ....

begin()

bool ESpeakFiles::begin ( int  buflength = 5 )

inline

Starts the processing. Optionally add all relevant configuration files be fore calling this method.

end()

void ESpeakFiles::end ( )

inline

Stops the processing.

say()

bool ESpeakFiles::say ( const char *  str )

inline

Outputs the string as sound.

setAnnounceCapitals()

bool ESpeakFiles::setAnnounceCapitals ( int  caps )

inline

CAPITALS: announce capital letters by: 0=none, 1=sound icon, 2=spelling, 3 or higher, by raising pitch. This values gives the amount in Hz by which the pitch of a word raised to indicate it has a capital letter.

setParameter()

bool ESpeakFiles::setParameter ( espeak_PARAMETER  parameter, int  value, int  relative = 0  )

inline

Sets Parameter: espeakRATE, espeakVOLUME etc.

setPitch()

bool ESpeakFiles::setPitch ( int  pitch )

inline

PITCH: base pitch, range 0-100. 50=normal.

setPitchRange()

bool ESpeakFiles::setPitchRange ( int  range )

inline

RANGE: pitch range, range 0-100. 0-monotone, 50=normal.

setPunctuation()

bool ESpeakFiles::setPunctuation ( espeak_PUNCT_TYPE  punct )

inline

PUNCTUATION: which punctuation characters to announce: value in espeak_PUNCT_TYPE (none, all, some), see espeak_GetParameter() to specify which characters are announced.

setRate()

bool ESpeakFiles::setRate ( int  rate )

inline

speaking speed in word per minute. Values 80 to 450.

setVoice() [1/2]

bool ESpeakFiles::setVoice ( const char *  voiceName )

inline

Defines the voice by i'ts name.

setVoice() [2/2]

bool ESpeakFiles::setVoice ( espeak_VOICE *  voice_spec )

inline

Defines the voice by it's properties.

setVolume()

bool ESpeakFiles::setVolume ( int  vol )

inline

volume in range 0-200 or more. 0=silence, 100=normal full volume, greater values may produce amplitude compression or distortion

setWordGap()

bool ESpeakFiles::setWordGap ( int  gap )

inline

WORDGAP: pause between words, units of 10mS (at the default speed)

voice()

espeak_VOICE * ESpeakFiles::voice ( )

inline

Determiens the current voice.

Field Documentation

end_position

unsigned int ESpeakFiles::end_position = 0

protected

flags

unsigned int ESpeakFiles::flags = espeakCHARS_AUTO

protected

identifier

unsigned int* ESpeakFiles::identifier = nullptr

protected

memory_guard

const short ESpeakFiles::memory_guard = 23

protected

options

int ESpeakFiles::options = 0

protected

output

const espeak_AUDIO_OUTPUT ESpeakFiles::output = AUDIO_OUTPUT_SYNCH_PLAYBACK

protected

path

const char* ESpeakFiles::path = "../../../espeak-ng-data-min"

protected

position

unsigned int ESpeakFiles::position = 0

protected

position_type

espeak_POSITION_TYPE ESpeakFiles::position_type = POS_CHARACTER

protected

user_data

void* ESpeakFiles::user_data = nullptr

protected

---

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

• Arduino/espeak.h