wxTTSSapiHandler Class Reference
[Text to speech classes]

#include <tts/tts_sapi.h>

Inheritance diagram for wxTTSSapiHandler:

List of all members.

Public Member Functions
	wxTTSSapiHandler ()
	~wxTTSSapiHandler ()
void	Init ()
	Member initialisation.
virtual bool	Initialize ()
	Initialize the engine. Can call multiple times.
virtual bool	Uninitialize ()
	Clean up the engine. Can call multiple times.
virtual bool	Speak (const wxString &text, int options=wxTTS_SPEAK_ASYNC)
	Speak the text.
virtual bool	SpeakFile (const wxString &filename, int options=wxTTS_SPEAK_ASYNC, const wxString &waveFilename=wxEmptyString)
	Speak the file.
virtual bool	DoSpeak (const wxString &textOrFilename, bool isFilename, int options=wxTTS_SPEAK_ASYNC, const wxString &waveFilename=wxEmptyString)
	Speak the text or file.
virtual bool	IsSpeaking () const
	Is it speaking?
virtual bool	IsPaused () const
	Is it paused?
virtual bool	Stop ()
	Stop speaking.
virtual bool	Pause ()
	Pause.
virtual bool	Resume ()
	Resume.
virtual bool	Skip (int toSkip, wxTTSSkipType itemType=wxTTS_SkipSentence)
	Skip forward or backward the given number of items.
virtual bool	CanSkip () const
	Can we skip right now?
virtual wxArrayString	GetAvailableVoices () const
	Get a list of the available voices.
virtual bool	VoicesAreCompatible (const wxString &voice1, const wxString &voice2) const
	Can these two voices be used together? Pass an empty string to the voice parameters to find out whether the engine in general supports simultaneous voices.
virtual wxArrayString	GetAvailableVoiceVariants () const
	Get a list of the available voice variants.
virtual bool	HasCapability (wxTTSCapability capability) const
	Does this handler have the specified capability?
virtual int	GetMinSpeed () const
virtual int	GetMaxSpeed () const
virtual int	GetMinVolume () const
virtual int	GetMaxVolume () const
virtual int	GetMinPitch () const
virtual int	GetMaxPitch () const
virtual wxString	GetDefaultVoice () const
	Get the default voice.
virtual wxString	GetDefaultVoiceVariant () const
	Get the default voice variant.
virtual int	CreateTransformerOptions (int mandatoryOptions=0) const
	Create transformation options from handler's properties.
wxTTSSapiData *	GetData () const
	Get data.
void	Callback ()
	Implementation: callback.
void	Yield ()
Static Public Member Functions
static wxArrayString	GetAvailableVoicesForDir (const wxString &voicesDir)
	Get a list of the available voices, given the voices directory.
static void	SetSimultaneousVoiceExclusions (const wxArrayString &exclusions)
	Call this to set an array of match strings that are used to determine whether voices can be used simultaneously (using VoicesAreCompatible).
static const wxArrayString &	GetSimultaneousVoiceExclusions ()
Protected Attributes
wxTTSSapiData *	m_data
Static Protected Attributes
static wxArrayString	sm_simultaneousVoiceExclusions

---

Constructor & Destructor Documentation

wxTTSSapiHandler::wxTTSSapiHandler

(

)

wxTTSSapiHandler::~wxTTSSapiHandler

(

)

---

Member Function Documentation

void wxTTSSapiHandler::Callback

(

)

Implementation: callback.

virtual bool wxTTSSapiHandler::CanSkip

(

)

const [virtual]

Can we skip right now?

Reimplemented from wxTTSHandler.

virtual int wxTTSSapiHandler::CreateTransformerOptions

(

int

mandatoryOptions = 0

)

const [virtual]

Create transformation options from handler's properties.

Reimplemented from wxTTSHandler.

virtual bool wxTTSSapiHandler::DoSpeak	(	const wxString &	textOrFilename,
		bool	isFilename,
		int	options = wxTTS_SPEAK_ASYNC,
		const wxString &	waveFilename = wxEmptyString
	)			[virtual]

Speak the text or file.

virtual wxArrayString wxTTSSapiHandler::GetAvailableVoices

(

)

const [virtual]

Get a list of the available voices.

Implements wxTTSHandler.

static wxArrayString wxTTSSapiHandler::GetAvailableVoicesForDir

(

const wxString &

voicesDir

)

[static]

Get a list of the available voices, given the voices directory.

virtual wxArrayString wxTTSSapiHandler::GetAvailableVoiceVariants

(

)

const [virtual]

Get a list of the available voice variants.

Reimplemented from wxTTSHandler.

wxTTSSapiData* wxTTSSapiHandler::GetData

(

)

const [inline]

Get data.

virtual wxString wxTTSSapiHandler::GetDefaultVoice

(

)

const [virtual]

Get the default voice.

Implements wxTTSHandler.

virtual wxString wxTTSSapiHandler::GetDefaultVoiceVariant

(

)

const [virtual]

Get the default voice variant.

Implements wxTTSHandler.

virtual int wxTTSSapiHandler::GetMaxPitch

(

)

const [inline, virtual]

Implements wxTTSHandler.

virtual int wxTTSSapiHandler::GetMaxSpeed

(

)

const [inline, virtual]

Implements wxTTSHandler.

virtual int wxTTSSapiHandler::GetMaxVolume

(

)

const [inline, virtual]

Implements wxTTSHandler.

virtual int wxTTSSapiHandler::GetMinPitch

(

)

const [inline, virtual]

Implements wxTTSHandler.

virtual int wxTTSSapiHandler::GetMinSpeed

(

)

const [inline, virtual]

Implements wxTTSHandler.

virtual int wxTTSSapiHandler::GetMinVolume

(

)

const [inline, virtual]

Implements wxTTSHandler.

static const wxArrayString& wxTTSSapiHandler::GetSimultaneousVoiceExclusions

(

)

[inline, static]

virtual bool wxTTSSapiHandler::HasCapability

(

wxTTSCapability

capability

)

const [virtual]

Does this handler have the specified capability?

Implements wxTTSHandler.

void wxTTSSapiHandler::Init

(

)

Member initialisation.

Reimplemented from wxTTSHandler.

virtual bool wxTTSSapiHandler::Initialize

(

)

[virtual]

Initialize the engine. Can call multiple times.

Reimplemented from wxTTSHandler.

virtual bool wxTTSSapiHandler::IsPaused

(

)

const [virtual]

Is it paused?

Reimplemented from wxTTSHandler.

virtual bool wxTTSSapiHandler::IsSpeaking

(

)

const [virtual]

Is it speaking?

Implements wxTTSHandler.

virtual bool wxTTSSapiHandler::Pause

(

)

[virtual]

Pause.

Reimplemented from wxTTSHandler.

virtual bool wxTTSSapiHandler::Resume

(

)

[virtual]

Resume.

Reimplemented from wxTTSHandler.

static void wxTTSSapiHandler::SetSimultaneousVoiceExclusions

(

const wxArrayString &

exclusions

)

[inline, static]

Call this to set an array of match strings that are used to determine whether voices can be used simultaneously (using VoicesAreCompatible).

Each string will be used to match against the actual voice name, so for example "eSpeak" will match against all eSpeak voices.

virtual bool wxTTSSapiHandler::Skip	(	int	toSkip,
		wxTTSSkipType	itemType = wxTTS_SkipSentence
	)			[virtual]

Skip forward or backward the given number of items.

A positive value skips forward, and a negative value skips back. A value of zero skips to the start of the item. itemType may be ignored by some or all engines.

virtual bool wxTTSSapiHandler::Speak	(	const wxString &	text,
		int	options = wxTTS_SPEAK_ASYNC
	)			[virtual]

Speak the text.

Implements wxTTSHandler.

virtual bool wxTTSSapiHandler::SpeakFile	(	const wxString &	filename,
		int	options = wxTTS_SPEAK_ASYNC,
		const wxString &	waveFilename = wxEmptyString
	)			[virtual]

Speak the file.

Implements wxTTSHandler.

virtual bool wxTTSSapiHandler::Stop

(

)

[virtual]

Stop speaking.

Implements wxTTSHandler.

virtual bool wxTTSSapiHandler::Uninitialize

(

)

[virtual]

Clean up the engine. Can call multiple times.

Reimplemented from wxTTSHandler.

virtual bool wxTTSSapiHandler::VoicesAreCompatible	(	const wxString &	voice1,
		const wxString &	voice2
	)			const [virtual]

Can these two voices be used together? Pass an empty string to the voice parameters to find out whether the engine in general supports simultaneous voices.

Pass voice names to find out if these voices can be used simultaneously, when using the given engine. The voice names can be the same.

void wxTTSSapiHandler::Yield

(

)

---

Member Data Documentation

wxTTSSapiData* wxTTSSapiHandler::m_data [protected]

wxArrayString wxTTSSapiHandler::sm_simultaneousVoiceExclusions [static, protected]

---

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

• include/tts/tts_sapi.h