Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.TranslationEngine.html	Fri Oct 27 14:09:40 2023 +0200
@@ -74,7 +74,7 @@
 </tr>
 <tr>
 <td><a href="#TranslationEngine.getTextToSpeechData">getTextToSpeechData</a></td>
-<td></td>
+<td>Public method to pronounce the given text.</td>
 </tr>
 <tr>
 <td><a href="#TranslationEngine.getTranslation">getTranslation</a></td>
@@ -140,6 +140,36 @@
 <h4>TranslationEngine.getTextToSpeechData</h4>
 <b>getTextToSpeechData</b>(<i>requestObject, text, language</i>)
 
+<p>
+        Public method to pronounce the given text.
+</p>
+<dl>
+
+<dt><i>requestObject</i> (TranslatorRequest)</dt>
+<dd>
+reference to the request object
+</dd>
+<dt><i>text</i> (str)</dt>
+<dd>
+text to be pronounced
+</dd>
+<dt><i>language</i> (str)</dt>
+<dd>
+language code of the text
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple with pronounce data or an error string and a success flag
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (QByteArray or str, bool)
+</dd>
+</dl>
 <a NAME="TranslationEngine.getTranslation" ID="TranslationEngine.getTranslation"></a>
 <h4>TranslationEngine.getTranslation</h4>
 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>)