<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qtexttospeechplugin.cpp --> <title>QTextToSpeechPlugin 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 >QTextToSpeechPlugin</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 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-functions">Public Functions</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">QTextToSpeechPlugin Class</h1> <!-- $$$QTextToSpeechPlugin-brief --> <p>The <a href="qtexttospeechplugin.html">QTextToSpeechPlugin</a> class is the base for all text-to-speech plug-ins. <a href="#details">More...</a></p> <!-- @@@QTextToSpeechPlugin --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QTextToSpeechPlugin></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += texttospeech</td></tr></table></div><ul> <li><a href="qtexttospeechplugin-members.html">List of all members, including inherited members</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"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qtexttospeechplugin.html#dtor.QTextToSpeechPlugin">~QTextToSpeechPlugin</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QTextToSpeechEngine *</td><td class="memItemRight bottomAlign"><b><a href="qtexttospeechplugin.html#createTextToSpeechEngine">createTextToSpeechEngine</a></b>(const QVariantMap &<i>parameters</i>, QObject *<i>parent</i>, QString *<i>errorString</i>) const</td></tr> </table></div> <a name="details"></a> <!-- $$$QTextToSpeechPlugin-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qtexttospeechplugin.html">QTextToSpeechPlugin</a> class is the base for all text-to-speech plug-ins.</p> <p>A plug-in implementation should derive from <a href="qtexttospeechplugin.html">QTextToSpeechPlugin</a> and re-implement <a href="qtexttospeechplugin.html#createTextToSpeechEngine">createTextToSpeechEngine</a>().</p> </div> <!-- @@@QTextToSpeechPlugin --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$~QTextToSpeechPlugin[overload1]$$$~QTextToSpeechPlugin --> <h3 class="fn" id="dtor.QTextToSpeechPlugin"><a name="dtor.QTextToSpeechPlugin"></a><code>[virtual] </code>QTextToSpeechPlugin::<span class="name">~QTextToSpeechPlugin</span>()</h3> <p>Destroys the instance of QTextToSpeechPlugin. The destructor is virtual.</p><!-- @@@~QTextToSpeechPlugin --> <!-- $$$createTextToSpeechEngine[overload1]$$$createTextToSpeechEngineconstQVariantMap&QObject*QString* --> <h3 class="fn" id="createTextToSpeechEngine"><a name="createTextToSpeechEngine"></a><code>[virtual] </code><span class="type">QTextToSpeechEngine</span> *QTextToSpeechPlugin::<span class="name">createTextToSpeechEngine</span>(const <span class="type">QVariantMap</span> &<i>parameters</i>, <span class="type">QObject</span> *<i>parent</i>, <span class="type">QString</span> *<i>errorString</i>) const</h3> <p>Factory method that is triggered by a call to <a href="qtexttospeech.html#QTextToSpeech">QTextToSpeech::QTextToSpeech</a>() when a provider name is given in the constructor and a text-to-speech plug-in matching the provider name was successfully loaded.</p> <p>Value of <i>parameters</i> is currently always empty.</p> <p>If an error occurs, the method should return 0 and (optionally) give a description of the error in <i>errorString</i>. In this case, <a href="qtexttospeech.html#state-prop">QTextToSpeech::state</a>() will return <a href="qtexttospeech.html#State-enum">QTextToSpeech::BackendError</a>.</p> <p>If <i>parent</i> is 0, the caller takes the ownership of the returned engine instance.</p> <!-- @@@createTextToSpeechEngine --> </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>