/usr/share/qt5/doc/qtspeech/qtexttospeech.html is in qtspeech5-doc-html 5.9.5-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtexttospeech.cpp -->
<title>QTextToSpeech Class | Qt Speech 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtspeech-index.html">Qt Speech</a></td><td ><a href="qtspeech-module.html">C++ Classes</a></td><td >QTextToSpeech</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QTextToSpeech Class</h1>
<!-- $$$QTextToSpeech-brief -->
<p>The <a href="qtexttospeech.html">QTextToSpeech</a> class provides a convenient access to text-to-speech engines <a href="#details">More...</a></p>
<!-- @@@QTextToSpeech -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QTextToSpeech></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += texttospeech</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qobject.html">QObject</a></td></tr></table></div><ul>
<li><a href="qtexttospeech-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#State-enum">State</a></b> { Ready, Speaking, Paused, BackendError }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qtexttospeech.html#locale-prop">locale</a></b> : QLocale</li>
<li class="fn"><b><a href="qtexttospeech.html#pitch-prop">pitch</a></b> : double</li>
<li class="fn"><b><a href="qtexttospeech.html#rate-prop">rate</a></b> : double</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qtexttospeech.html#state-prop">state</a></b> : const State</li>
<li class="fn"><b><a href="qtexttospeech.html#voice-prop">voice</a></b> : QVoice</li>
<li class="fn"><b><a href="qtexttospeech.html#volume-prop">volume</a></b> : int</li>
</ul>
</td></tr>
</table></div>
<ul>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#QTextToSpeech">QTextToSpeech</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#QTextToSpeech-1">QTextToSpeech</a></b>(const QString &<i>engine</i>, QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVector<QLocale> </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#availableLocales">availableLocales</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVector<QVoice> </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#availableVoices">availableVoices</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLocale </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#locale-prop">locale</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> double </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#pitch-prop">pitch</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> double </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#rate-prop">rate</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> State </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#state-prop">state</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVoice </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#voice-prop">voice</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> double </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#volume-prop">volume</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">32 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#pause">pause</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#resume">resume</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#say">say</a></b>(const QString &<i>text</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#setLocale">setLocale</a></b>(const QLocale &<i>locale</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#pitch-prop">setPitch</a></b>(double <i>pitch</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#rate-prop">setRate</a></b>(double <i>rate</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#setVoice">setVoice</a></b>(const QVoice &<i>voice</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#volume-prop">setVolume</a></b>(double <i>volume</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#stop">stop</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#locale-prop">localeChanged</a></b>(const QLocale &<i>locale</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#pitch-prop">pitchChanged</a></b>(double <i>pitch</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#rate-prop">rateChanged</a></b>(double <i>rate</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#state-prop">stateChanged</a></b>(QTextToSpeech::State <i>state</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#voice-prop">voiceChanged</a></b>(const QVoice &<i>voice</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#volume-prop">volumeChanged</a></b>(int <i>volume</i>)</td></tr>
</table></div>
<ul>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
</ul>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeech.html#availableEngines">availableEngines</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QTextToSpeech-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qtexttospeech.html">QTextToSpeech</a> class provides a convenient access to text-to-speech engines</p>
<p>Use <a href="qtexttospeech.html#say">say</a>() to start synthesizing text. It is possible to specify the language with <a href="qtexttospeech.html#setLocale">setLocale</a>(). To select between the available voices use <a href="qtexttospeech.html#setVoice">setVoice</a>(). The languages and voices depend on the available synthesizers on each platform. On Linux, <code>speech-dispatcher</code> is used by default.</p>
</div>
<!-- @@@QTextToSpeech -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$State$$$Ready$$$Speaking$$$Paused$$$BackendError -->
<h3 class="fn" id="State-enum"><a name="State-enum"></a>enum QTextToSpeech::<span class="name">State</span></h3>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextToSpeech::Ready</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The synthesizer is ready to start a new text. This is also the state after a text was finished.</td></tr>
<tr><td class="topAlign"><code>QTextToSpeech::Speaking</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The current text is being spoken.</td></tr>
<tr><td class="topAlign"><code>QTextToSpeech::Paused</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The synthesis was paused and can be resumed with <a href="qtexttospeech.html#resume">resume</a>().</td></tr>
<tr><td class="topAlign"><code>QTextToSpeech::BackendError</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">The backend was unable to synthesize the current string.</td></tr>
</table></div>
<!-- @@@State -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$locale-prop$$$locale$$$setLocaleconstQLocale&$$$localeChangedconstQLocale& -->
<h3 class="fn" id="locale-prop"><a name="locale-prop"></a><span class="name">locale</span> : <span class="type"><a href="../qtcore/qlocale.html">QLocale</a></span></h3>
<p>This property holds the current locale in use. By default, the system locale is used.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QLocale </td><td class="memItemRight bottomAlign"><span class="name"><b>locale</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qtexttospeech.html#setLocale">setLocale</a></b></span>(const QLocale &<i>locale</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>localeChanged</b></span>(const QLocale &<i>locale</i>)</td></tr>
</table></div>
<!-- @@@locale -->
<!-- $$$pitch-prop$$$pitch$$$setPitchdouble$$$pitchChangeddouble -->
<h3 class="fn" id="pitch-prop"><a name="pitch-prop"></a><span class="name">pitch</span> : <span class="type">double</span></h3>
<p>This property holds the voice pitch, ranging from -1.0 to 1.0. The default of 0.0 is the normal speech pitch.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> double </td><td class="memItemRight bottomAlign"><span class="name"><b>pitch</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setPitch</b></span>(double <i>pitch</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>pitchChanged</b></span>(double <i>pitch</i>)</td></tr>
</table></div>
<!-- @@@pitch -->
<!-- $$$rate-prop$$$rate$$$setRatedouble$$$rateChangeddouble -->
<h3 class="fn" id="rate-prop"><a name="rate-prop"></a><span class="name">rate</span> : <span class="type">double</span></h3>
<p>This property holds the current voice rate, ranging from -1.0 to 1.0. The default value of 0.0 is normal speech flow.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> double </td><td class="memItemRight bottomAlign"><span class="name"><b>rate</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setRate</b></span>(double <i>rate</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>rateChanged</b></span>(double <i>rate</i>)</td></tr>
</table></div>
<!-- @@@rate -->
<!-- $$$state-prop$$$state$$$stateChangedQTextToSpeech::State -->
<h3 class="fn" id="state-prop"><a name="state-prop"></a><span class="name">state</span> : const <span class="type"><a href="qtexttospeech.html#State-enum">State</a></span></h3>
<p>This property holds the current state of the speech synthesizer. Use <a href="qtexttospeech.html#say">say</a>() to start synthesizing text with the current voice and locale.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> State </td><td class="memItemRight bottomAlign"><span class="name"><b>state</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>stateChanged</b></span>(QTextToSpeech::State <i>state</i>)</td></tr>
</table></div>
<!-- @@@state -->
<!-- $$$voice-prop$$$voice$$$setVoiceconstQVoice&$$$voiceChangedconstQVoice& -->
<h3 class="fn" id="voice-prop"><a name="voice-prop"></a><span class="name">voice</span> : <span class="type"><a href="qvoice.html">QVoice</a></span></h3>
<p>This property holds the current voice used for the speech.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QVoice </td><td class="memItemRight bottomAlign"><span class="name"><b>voice</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qtexttospeech.html#setVoice">setVoice</a></b></span>(const QVoice &<i>voice</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>voiceChanged</b></span>(const QVoice &<i>voice</i>)</td></tr>
</table></div>
<!-- @@@voice -->
<!-- $$$volume-prop$$$volume$$$setVolumedouble$$$volumeChangedint -->
<h3 class="fn" id="volume-prop"><a name="volume-prop"></a><span class="name">volume</span> : <span class="type">int</span></h3>
<p>This property holds the current volume, ranging from 0.0 to 1.0. The default value is the platform's default volume.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> double </td><td class="memItemRight bottomAlign"><span class="name"><b>volume</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setVolume</b></span>(double <i>volume</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>volumeChanged</b></span>(int <i>volume</i>)</td></tr>
</table></div>
<!-- @@@volume -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextToSpeech[overload1]$$$QTextToSpeechQObject* -->
<h3 class="fn" id="QTextToSpeech"><a name="QTextToSpeech"></a>QTextToSpeech::<span class="name">QTextToSpeech</span>(<span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>parent</i> = nullptr)</h3>
<p>Loads a text-to-speech engine from a plug-in that uses the default engine plug-in and constructs a <a href="qtexttospeech.html">QTextToSpeech</a> object as the child of <i>parent</i>.</p>
<p>The default engine may be platform-specific.</p>
<p>If the plugin fails to load, <a href="qtexttospeech.html#state-prop">QTextToSpeech::state</a>() returns <a href="qtexttospeech.html#State-enum">QTextToSpeech::BackendError</a>.</p>
<p><b>See also </b><a href="qtexttospeech.html#availableEngines">availableEngines</a>().</p>
<!-- @@@QTextToSpeech -->
<!-- $$$QTextToSpeech$$$QTextToSpeechconstQString&QObject* -->
<h3 class="fn" id="QTextToSpeech-1"><a name="QTextToSpeech-1"></a>QTextToSpeech::<span class="name">QTextToSpeech</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>engine</i>, <span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>parent</i> = nullptr)</h3>
<p>Loads a text-to-speech engine from a plug-in that matches parameter <i>engine</i> and constructs a <a href="qtexttospeech.html">QTextToSpeech</a> object as the child of <i>parent</i>.</p>
<p>If <i>engine</i> is empty, the default engine plug-in is used. The default engine may be platform-specific.</p>
<p>If the plugin fails to load, <a href="qtexttospeech.html#state-prop">QTextToSpeech::state</a>() returns <a href="qtexttospeech.html#State-enum">QTextToSpeech::BackendError</a>.</p>
<p><b>See also </b><a href="qtexttospeech.html#availableEngines">availableEngines</a>().</p>
<!-- @@@QTextToSpeech -->
<!-- $$$availableEngines[overload1]$$$availableEngines -->
<h3 class="fn" id="availableEngines"><a name="availableEngines"></a><code>[static] </code><span class="type"><a href="../qtcore/qstringlist.html">QStringList</a></span> QTextToSpeech::<span class="name">availableEngines</span>()</h3>
<p>Gets the list of supported text-to-speech engine plug-ins.</p>
<!-- @@@availableEngines -->
<!-- $$$availableLocales[overload1]$$$availableLocales -->
<h3 class="fn" id="availableLocales"><a name="availableLocales"></a><span class="type"><a href="../qtcore/qvector.html">QVector</a></span><<span class="type"><a href="../qtcore/qlocale.html">QLocale</a></span>> QTextToSpeech::<span class="name">availableLocales</span>() const</h3>
<p>Gets a vector of locales that are currently supported.</p>
<p><b>Note: </b>On some platforms these can change, for example, when the backend changes synthesizers.</p><!-- @@@availableLocales -->
<!-- $$$availableVoices[overload1]$$$availableVoices -->
<h3 class="fn" id="availableVoices"><a name="availableVoices"></a><span class="type"><a href="../qtcore/qvector.html">QVector</a></span><<span class="type"><a href="qvoice.html">QVoice</a></span>> QTextToSpeech::<span class="name">availableVoices</span>() const</h3>
<p>Gets a vector of voices available for the current locale.</p>
<p><b>Note: </b>if no locale has been set, the system locale is used.</p><!-- @@@availableVoices -->
<!-- $$$pause[overload1]$$$pause -->
<h3 class="fn" id="pause"><a name="pause"></a><code>[slot] </code><span class="type">void</span> QTextToSpeech::<span class="name">pause</span>()</h3>
<p>Pauses the current speech.</p>
<p>Note:</p>
<ul>
<li>This function depends on the platform and the backend. It may not work at all, it may take several seconds before it takes effect, or it may pause instantly. Some synthesizers will look for a break that they can later resume from, such as a sentence end.</li>
<li>Due to Android platform limitations, pause() stops what is presently being said, while <a href="qtexttospeech.html#resume">resume</a>() starts the previously queued sentence from the beginning.</li>
</ul>
<p><b>See also </b><a href="qtexttospeech.html#resume">resume</a>().</p>
<!-- @@@pause -->
<!-- $$$resume[overload1]$$$resume -->
<h3 class="fn" id="resume"><a name="resume"></a><code>[slot] </code><span class="type">void</span> QTextToSpeech::<span class="name">resume</span>()</h3>
<p>Resume speaking after <a href="qtexttospeech.html#pause">pause</a>() has been called.</p>
<p><b>See also </b><a href="qtexttospeech.html#pause">pause</a>().</p>
<!-- @@@resume -->
<!-- $$$say[overload1]$$$sayconstQString& -->
<h3 class="fn" id="say"><a name="say"></a><code>[slot] </code><span class="type">void</span> QTextToSpeech::<span class="name">say</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>text</i>)</h3>
<p>Start synthesizing the <i>text</i>. This function will start the asynchronous reading of the text. The current state is available using the <a href="qtexttospeech.html#state-prop">state</a> property. Once the synthesis is done, a <a href="qtexttospeech.html#state-prop">stateChanged</a>() signal with the <a href="qtexttospeech.html#State-enum">Ready</a> state is emitted.</p>
<!-- @@@say -->
<!-- $$$setLocale -->
<h3 class="fn" id="setLocale"><a name="setLocale"></a><code>[slot] </code><span class="type">void</span> QTextToSpeech::<span class="name">setLocale</span>(const <span class="type"><a href="../qtcore/qlocale.html">QLocale</a></span> &<i>locale</i>)</h3>
<p>Sets the <i>locale</i> to a given locale if possible. The default is the system locale.</p>
<p><b>Note:</b> Setter function for property <a href="qtexttospeech.html#locale-prop">locale</a>. </p><p><b>See also </b><a href="qtexttospeech.html#locale-prop">locale</a>().</p>
<!-- @@@setLocale -->
<!-- $$$setVoice -->
<h3 class="fn" id="setVoice"><a name="setVoice"></a><code>[slot] </code><span class="type">void</span> QTextToSpeech::<span class="name">setVoice</span>(const <span class="type"><a href="qvoice.html">QVoice</a></span> &<i>voice</i>)</h3>
<p>Sets the <i>voice</i> to use.</p>
<p><b>Note: </b>On some platforms, setting the voice changes other voice attributes such as locale, pitch, and so on. These changes trigger the emission of signals.</p><p><b>Note:</b> Setter function for property <a href="qtexttospeech.html#voice-prop">voice</a>. </p><p><b>See also </b><a href="qtexttospeech.html#voice-prop">voice</a>().</p>
<!-- @@@setVoice -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn" id="stop"><a name="stop"></a><code>[slot] </code><span class="type">void</span> QTextToSpeech::<span class="name">stop</span>()</h3>
<p>Stop the text that is being read.</p>
<!-- @@@stop -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|