• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

KSpeech

Public Types | List of all members
KSpeech Class Reference
Inheritance diagram for KSpeech:
Inheritance graph
[legend]

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
}
 

Additional Inherited Members

- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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

Definition at line 651 of file Mainpage.dox.

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
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:27:13 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KSpeech

Skip menu "KSpeech"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal