KSpeech Class Reference

Inheritance diagram for KSpeech:

List of all members.

Public Types
enum	JobPriority {   jpAll = 0, jpScreenReaderOutput = 1, jpWarning = 2, jpMessage = 3,   jpText = 4 }
enum	JobState {   jsQueued = 0, jsFiltering = 1, jsSpeakable = 2, jsSpeaking = 3,   jsPaused = 4, jsInterrupted = 5, jsFinished = 6, jsDeleted = 7 }
enum	MarkerType {   mtSentenceBegin = 0, mtSentenceEnd = 1, mtWordBegin = 2, mtPhonemeBegin = 3,   mtCustom = 4 }
enum	SayOptions {   soNone = 0x0000, soPlainText = 0x0001, soHtml = 0x0002, soSsml = 0x0004,   soChar = 0x0008, soKey = 0x0010, soSoundIcon = 0x0020 }
enum	TalkerCapabilities1 {   tcCanListVoices = 0x00000001, tcCanSetVoiceByProperties = 0x00000002, tcCanGetCurrentVoice = 0x00000004, tcCanSetRateRelative = 0x00000008,   tcCanSetRateAbsolute = 0x00000010, tcCanGetRateDefault = 0x00000020, tcCanSetPitchRelative = 0x00000040, tcCanSetPitchAbsolute = 0x00000080,   tcCanGetPitchDefault = 0x00000100, tcCanSetPitchRangeRelative = 0x00000200, tcCanSetPitchRangeAbsolute = 0x00000400, tcCanGetPitchRangeDefault = 0x00000800,   tcCanSetVolumeRelative = 0x00001000, tcCanSetVolumeAbsolute = 0x00002000, tcCanGetVolumeDefault = 0x00004000, tcCanSetPunctuationModeAll = 0x00008000,   tcCanSetPunctuationModeNone = 0x00010000, tcCanSetPunctuationModeSome = 0x00020000, tcCanSetPunctuationDetail = 0x00040000, tcCanSetCapitalLettersModeSpelling = 0x00080000,   tcCanSetCapitalLettersModeIcon = 0x00100000, tcCanSetCapitalLettersModePitch = 0x00200000, tcCanSetNumberGrouping = 0x00400000, tcCanSayTextFromPosition = 0x00800000,   tcCanSayChar = 0x01000000, tcCanSayKey = 0x02000000, tcCanSayIcon = 0x04000000, tcCanSetDictionary = 0x08000000,   tcCanRetrieveAudio = 0x10000000, tcCanPlayAudio = 0x20000000 }
enum	TalkerCapabilities2 {   tcCanReportEventsBySentences = 0x00000001, tcCanReportEventsByWords = 0x00000002, tcCanReportCustomIndexMarks = 0x00000004, tcHonorsPerformanceGuidelines1 = 0x00000008,   tcHonorsPerformanceGuidelines2 = 0x00000010, tcHonorsPerformanceGuidelines = 0x00000018, tcCanDeferMessage = 0x00000020, tcCanParseSsml = 0x00000040,   tcSupportsMultilingualUtterances = 0x00000080, tcCanParseHtml = 0x00000100 }

---

Detailed Description

Constants and Enums for the KSpeech D-Bus interface.

#include "kspeech.h"

Note: Applications do not use this class directly. Instead, use the OrgKdeKSpeechInterface object as described in Calling KTTSD from a Program.

See also Introduction to the KSpeech D-Bus Interface

---

Member Enumeration Documentation

enum KSpeech::JobPriority

The priority of jobs submitted by OrgKdeKSpeechInterface::say.

Enumerator:

jpAll	All priorities. Used for information retrieval only.
jpScreenReaderOutput	Screen Reader job.
jpWarning	Warning job.
jpMessage	Message job.
jpText	Text job.

Definition at line 660 of file Mainpage.dox.

enum KSpeech::JobState

Job states returned by method OrgKdeKSpeechInterface::getJobState.

Enumerator:

jsQueued	Job has been queued but is not yet speakable.
jsFiltering	Job is being filtered.
jsSpeakable	Job is speakable, but is not speaking.
jsSpeaking	Job is currently speaking.
jsPaused	Job is paused.
jsInterrupted	Job is paused because it has been interrupted by another job.
jsFinished	Job is finished and is deleteable.
jsDeleted	Job is deleted from the queue.

Definition at line 673 of file Mainpage.dox.

enum KSpeech::MarkerType

Types of markers emitted by OrgKdeKSpeechInterface::marker signal.

Enumerator:

mtSentenceBegin
mtSentenceEnd
mtWordBegin
mtPhonemeBegin
mtCustom

Definition at line 763 of file Mainpage.dox.

enum KSpeech::SayOptions

Hints about text content when sending via OrgKdeKSpeechInterface::say.

Enumerator:

soNone	No options specified. Autodetected.
soPlainText	The text contains plain text.
soHtml	The text contains HTML markup.
soSsml	The text contains SSML markup.
soChar	The text should be spoken as individual characters.
soKey	The text contains a keyboard symbolic key name.
soSoundIcon	The text is the name of a sound icon.

Definition at line 689 of file Mainpage.dox.

enum KSpeech::TalkerCapabilities1

Flags for synthesizer/talker capabilities returned by OrgKdeKSpeechInterface::getTalkerCapabilities1.

All items marked FALSE are hard-coded off at this time.

Enumerator:

tcCanListVoices
tcCanSetVoiceByProperties
tcCanGetCurrentVoice
tcCanSetRateRelative	FALSE.
tcCanSetRateAbsolute
tcCanGetRateDefault
tcCanSetPitchRelative	FALSE.
tcCanSetPitchAbsolute
tcCanGetPitchDefault
tcCanSetPitchRangeRelative	FALSE.
tcCanSetPitchRangeAbsolute	FALSE.
tcCanGetPitchRangeDefault	FALSE.
tcCanSetVolumeRelative	FALSE.
tcCanSetVolumeAbsolute
tcCanGetVolumeDefault
tcCanSetPunctuationModeAll	FALSE.
tcCanSetPunctuationModeNone	FALSE.
tcCanSetPunctuationModeSome	FALSE.
tcCanSetPunctuationDetail	FALSE.
tcCanSetCapitalLettersModeSpelling	FALSE.
tcCanSetCapitalLettersModeIcon	FALSE.
tcCanSetCapitalLettersModePitch	FALSE.
tcCanSetNumberGrouping	FALSE.
tcCanSayTextFromPosition	FALSE.
tcCanSayChar	FALSE.
tcCanSayKey	FALSE.
tcCanSayIcon	FALSE.
tcCanSetDictionary	FALSE.
tcCanRetrieveAudio	FALSE.
tcCanPlayAudio	FALSE.

Definition at line 707 of file Mainpage.dox.

enum KSpeech::TalkerCapabilities2

All items marked FALSE are hard-coded off at this time.

Enumerator:

tcCanReportEventsBySentences
tcCanReportEventsByWords	FALSE.
tcCanReportCustomIndexMarks	FALSE.
tcHonorsPerformanceGuidelines1	FALSE.
tcHonorsPerformanceGuidelines2	FALSE.
tcHonorsPerformanceGuidelines	FALSE.
tcCanDeferMessage	FALSE.
tcCanParseSsml
tcSupportsMultilingualUtterances	FALSE.
tcCanParseHtml

Definition at line 745 of file Mainpage.dox.

---

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

• Mainpage.dox