speak_lib.h File Reference

#include <stdio.h>

Include dependency graph for speak_lib.h:

Go to the source code of this file.

Classes
struct	espeak_EVENT
struct	espeak_VOICE

Macros
#define	ESPEAK_API_REVISION   3
#define	espeakCHARS_8BIT   2
#define	espeakCHARS_AUTO   0
#define	espeakCHARS_UTF8   1
#define	espeakCHARS_WCHAR   3
#define	espeakENDPAUSE   0x1000
#define	espeakKEEP_NAMEDATA   0x2000
#define	espeakPHONEMES   0x100
#define	espeakSSML   0x10

Typedefs
typedef int(	t_espeak_callback )(short *, int, espeak_EVENT *)

Enumerations
enum	espeak_AUDIO_OUTPUT { AUDIO_OUTPUT_PLAYBACK, AUDIO_OUTPUT_RETRIEVAL, AUDIO_OUTPUT_SYNCHRONOUS, AUDIO_OUTPUT_SYNCH_PLAYBACK }
enum	espeak_ERROR { EE_OK = 0, EE_INTERNAL_ERROR = -1, EE_BUFFER_FULL = 1, EE_NOT_FOUND = 2 }
enum	espeak_EVENT_TYPE {   espeakEVENT_LIST_TERMINATED = 0, espeakEVENT_WORD = 1, espeakEVENT_SENTENCE, espeakEVENT_MARK,   espeakEVENT_PLAY, espeakEVENT_END, espeakEVENT_MSG_TERMINATED, espeakEVENT_PHONEME }
enum	espeak_PARAMETER {   espeakSILENCE = 0, espeakRATE = 1, espeakVOLUME = 2, espeakPITCH = 3,   espeakRANGE = 4, espeakPUNCTUATION = 5, espeakCAPITALS = 6, espeakWORDGAP = 7,   espeakOPTIONS = 8, espeakINTONATION = 9, espeakRESERVED1 = 10, espeakRESERVED2 = 11,   espeakEMPHASIS, espeakLINELENGTH, espeakVOICETYPE, N_SPEECH_PARAM }
enum	espeak_POSITION_TYPE { POS_CHARACTER = 1, POS_WORD, POS_SENTENCE }
enum	espeak_PUNCT_TYPE { espeakPUNCT_NONE = 0, espeakPUNCT_ALL = 1, espeakPUNCT_SOME = 2 }

Functions
espeak_ERROR	espeak_Cancel (void)
espeak_ERROR	espeak_Char (wchar_t character)
void	espeak_CompileDictionary (const char *path, FILE *log)
espeak_VOICE *	espeak_GetCurrentVoice (void)
int	espeak_GetParameter (espeak_PARAMETER parameter, int current)
const char *	espeak_Info (void *ptr)
int	espeak_Initialize (espeak_AUDIO_OUTPUT output, int buflength, const char *path, int options)
int	espeak_IsPlaying (void)
espeak_ERROR	espeak_Key (const char *key_name)
const espeak_VOICE **	espeak_ListVoices (espeak_VOICE *voice_spec)
espeak_ERROR	espeak_SetParameter (espeak_PARAMETER parameter, int value, int relative)
void	espeak_SetPhonemeTrace (int value, FILE *stream)
espeak_ERROR	espeak_SetPunctuationList (const wchar_t *punctlist)
void	espeak_SetSynthCallback (t_espeak_callback *SynthCallback)
void	espeak_SetUriCallback (int(*UriCallback)(int, const char *, const char *))
espeak_ERROR	espeak_SetVoiceByName (const char *name)
espeak_ERROR	espeak_SetVoiceByProperties (espeak_VOICE *voice_spec)
espeak_ERROR	espeak_Synchronize (void)
espeak_ERROR	espeak_Synth (const void *text, size_t size, unsigned int position, espeak_POSITION_TYPE position_type, unsigned int end_position, unsigned int flags, unsigned int *unique_identifier, void *user_data)
espeak_ERROR	espeak_Synth_Mark (const void *text, size_t size, const char *index_mark, unsigned int end_position, unsigned int flags, unsigned int *unique_identifier, void *user_data)
espeak_ERROR	espeak_Terminate (void)

---

Macro Definition Documentation

#define ESPEAK_API_REVISION   3

Definition at line 30 of file speak_lib.h.

#define espeakCHARS_8BIT   2

Definition at line 225 of file speak_lib.h.

#define espeakCHARS_AUTO   0

Definition at line 223 of file speak_lib.h.

#define espeakCHARS_UTF8   1

Definition at line 224 of file speak_lib.h.

#define espeakCHARS_WCHAR   3

Definition at line 226 of file speak_lib.h.

#define espeakENDPAUSE   0x1000

Definition at line 230 of file speak_lib.h.

#define espeakKEEP_NAMEDATA   0x2000

Definition at line 231 of file speak_lib.h.

#define espeakPHONEMES   0x100

Definition at line 229 of file speak_lib.h.

#define espeakSSML   0x10

Definition at line 228 of file speak_lib.h.

---

Typedef Documentation

typedef int( t_espeak_callback)(short *, int, espeak_EVENT *)

Definition at line 163 of file speak_lib.h.

---

Enumeration Type Documentation

enum espeak_AUDIO_OUTPUT

Enumerator:

AUDIO_OUTPUT_PLAYBACK
AUDIO_OUTPUT_RETRIEVAL
AUDIO_OUTPUT_SYNCHRONOUS
AUDIO_OUTPUT_SYNCH_PLAYBACK

Definition at line 122 of file speak_lib.h.

enum espeak_ERROR

Enumerator:

EE_OK
EE_INTERNAL_ERROR
EE_BUFFER_FULL
EE_NOT_FOUND

Definition at line 138 of file speak_lib.h.

enum espeak_EVENT_TYPE

Enumerator:

espeakEVENT_LIST_TERMINATED
espeakEVENT_WORD
espeakEVENT_SENTENCE
espeakEVENT_MARK
espeakEVENT_PLAY
espeakEVENT_END
espeakEVENT_MSG_TERMINATED
espeakEVENT_PHONEME

Definition at line 44 of file speak_lib.h.

enum espeak_PARAMETER

Enumerator:

espeakSILENCE
espeakRATE
espeakVOLUME
espeakPITCH
espeakRANGE
espeakPUNCTUATION
espeakCAPITALS
espeakWORDGAP
espeakOPTIONS
espeakINTONATION
espeakRESERVED1
espeakRESERVED2
espeakEMPHASIS
espeakLINELENGTH
espeakVOICETYPE
N_SPEECH_PARAM

Definition at line 345 of file speak_lib.h.

enum espeak_POSITION_TYPE

Enumerator:

POS_CHARACTER
POS_WORD
POS_SENTENCE

Definition at line 115 of file speak_lib.h.

enum espeak_PUNCT_TYPE

Enumerator:

espeakPUNCT_NONE
espeakPUNCT_ALL
espeakPUNCT_SOME

Definition at line 365 of file speak_lib.h.

---

Function Documentation

espeak_ERROR espeak_Cancel

(

void

)

Here is the caller graph for this function:

espeak_ERROR espeak_Char

(

wchar_t

character

)

void espeak_CompileDictionary	(	const char *	path,
		FILE *	log
	)

espeak_VOICE* espeak_GetCurrentVoice

(

void

)

Here is the caller graph for this function:

int espeak_GetParameter	(	espeak_PARAMETER	parameter,
		int	current
	)

const char* espeak_Info

(

void *

ptr

)

int espeak_Initialize	(	espeak_AUDIO_OUTPUT	output,
		int	buflength,
		const char *	path,
		int	options
	)

Here is the caller graph for this function:

int espeak_IsPlaying

(

void

)

Here is the caller graph for this function:

espeak_ERROR espeak_Key

(

const char *

key_name

)

const espeak_VOICE** espeak_ListVoices

(

espeak_VOICE *

voice_spec

)

espeak_ERROR espeak_SetParameter	(	espeak_PARAMETER	parameter,
		int	value,
		int	relative
	)

Here is the caller graph for this function:

void espeak_SetPhonemeTrace	(	int	value,
		FILE *	stream
	)

espeak_ERROR espeak_SetPunctuationList

(

const wchar_t *

punctlist

)

void espeak_SetSynthCallback

(

t_espeak_callback *

SynthCallback

)

void espeak_SetUriCallback

(

int(*)(int, const char *, const char *)

UriCallback

)

espeak_ERROR espeak_SetVoiceByName

(

const char *

name

)

Here is the caller graph for this function:

espeak_ERROR espeak_SetVoiceByProperties

(

espeak_VOICE *

voice_spec

)

Here is the caller graph for this function:

espeak_ERROR espeak_Synchronize

(

void

)

Here is the caller graph for this function:

espeak_ERROR espeak_Synth	(	const void *	text,
		size_t	size,
		unsigned int	position,
		espeak_POSITION_TYPE	position_type,
		unsigned int	end_position,
		unsigned int	flags,
		unsigned int *	unique_identifier,
		void *	user_data
	)

Here is the caller graph for this function:

espeak_ERROR espeak_Synth_Mark	(	const void *	text,
		size_t	size,
		const char *	index_mark,
		unsigned int	end_position,
		unsigned int	flags,
		unsigned int *	unique_identifier,
		void *	user_data
	)

espeak_ERROR espeak_Terminate

(

void

)

Here is the caller graph for this function: