<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>interfaces/kspeech: KSpeechSink Interface Reference (interfaces/kspeech)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../../.."><img id="nav_header_logo" alt="Home" align="left" src="../../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../../..">API Reference</a>
/ <a href="../../html/index.html">interfaces</a> / <a href=".">kspeech</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.4.4 -->
<h1>KSpeechSink Interface Reference</h1><!-- doxytag: class="KSpeechSink" --><!-- doxytag: inherits="DCOPObject" --><code>#include <<a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>></code>
<p>
<p>Inheritance diagram for KSpeechSink:
<p><center><img src="classKSpeechSink.png" usemap="#KSpeechSink_map" border="0" alt=""></center>
<map name="KSpeechSink_map">
<area doxygen="dcop.tag:../../../dcop/html/" href="../../../dcop/html/classDCOPObject.html" alt="DCOPObject" shape="rect" coords="0,0,87,24">
</map>
<a href="classKSpeechSink-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
KTTSD DCOP Signal Sink.
<p>
<dl compact><dt><b>Since:</b></dt><dd><a class="elRef" doxygen="kdecore.tag:../../../kdecore/html/" href="../../../kdecore/html/namespaceKDE.html">KDE</a> 3.4</dd></dl>
This defines the interface to sink signals emitted by KTTSD, the <a class="elRef" doxygen="kdecore.tag:../../../kdecore/html/" href="../../../kdecore/html/namespaceKDE.html">KDE</a> Text-to-speech Deamon. The DCOP IDL Compiler generates a skeleton file from this interface definition that will marshal the arguments for you.<h2><a class="anchor" name="Usage">
Usage</a></h2>
See the Signals section of <a class="el" href="kspeech_8h-source.html">kspeech.h</a> for instructions.<p>
<dl compact><dt><b>Warning:</b></dt><dd>The KSpeechSink interface is still being developed and is likely to change in the future.</dd></dl>
<p>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00042">42</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#w9">kttsdJobState</a> { <br>
<a class="el" href="classKSpeechSink.html#w9w0">jsQueued</a> = 0,
<a class="el" href="classKSpeechSink.html#w9w1">jsSpeakable</a> = 1,
<a class="el" href="classKSpeechSink.html#w9w2">jsSpeaking</a> = 2,
<a class="el" href="classKSpeechSink.html#w9w3">jsPaused</a> = 3,
<br>
<a class="el" href="classKSpeechSink.html#w9w4">jsFinished</a> = 4
<br>
}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#w10">kttsdMarkupType</a> { <a class="el" href="classKSpeechSink.html#w10w5">mtPlain</a> = 0,
<a class="el" href="classKSpeechSink.html#w10w6">mtJsml</a> = 1,
<a class="el" href="classKSpeechSink.html#w10w7">mtSmml</a> = 2,
<a class="el" href="classKSpeechSink.html#w10w8">mtSable</a> = 3
}</td></tr>
<tr><td colspan="2"><br><h2>DCOP Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z0">kttsdStarted</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z1">kttsdExiting</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z2">markerSeen</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &appId, const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &markerName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z3">sentenceStarted</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &appId, uint jobNum, uint seq)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z4">sentenceFinished</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &appId, uint jobNum, uint seq)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z5">textSet</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &appId, uint jobNum)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z6">textAppended</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &appId, uint jobNum, int partNum)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z7">textStarted</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &appId, uint jobNum)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z8">textFinished</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &appId, uint jobNum)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z9">textStopped</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &appId, uint jobNum)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z10">textPaused</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &appId, uint jobNum)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z11">textResumed</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &appId, uint jobNum)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpeechSink.html#z12">textRemoved</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &appId, uint jobNum)</td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="w9"></a><!-- doxytag: member="KSpeechSink::kttsdJobState" ref="w9" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">enum <a class="el" href="classKSpeechSink.html#w9">KSpeechSink::kttsdJobState</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Job states returned by method getTextJobState.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="w9w0"></a><!-- doxytag: member="jsQueued" ref="w9w0" args="" -->jsQueued</em> </td><td>
Job has been queued but is not yet speakable. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w1"></a><!-- doxytag: member="jsSpeakable" ref="w9w1" args="" -->jsSpeakable</em> </td><td>
Job is speakable, but is not speaking. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w2"></a><!-- doxytag: member="jsSpeaking" ref="w9w2" args="" -->jsSpeaking</em> </td><td>
Job is currently speaking. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w3"></a><!-- doxytag: member="jsPaused" ref="w9w3" args="" -->jsPaused</em> </td><td>
Job has been paused. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w4"></a><!-- doxytag: member="jsFinished" ref="w9w4" args="" -->jsFinished</em> </td><td>
Job is finished and is deleteable. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00050">50</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="w10"></a><!-- doxytag: member="KSpeechSink::kttsdMarkupType" ref="w10" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">enum <a class="el" href="classKSpeechSink.html#w10">KSpeechSink::kttsdMarkupType</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Speech markup language types.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="w10w5"></a><!-- doxytag: member="mtPlain" ref="w10w5" args="" -->mtPlain</em> </td><td>
Plain text. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="w10w6"></a><!-- doxytag: member="mtJsml" ref="w10w6" args="" -->mtJsml</em> </td><td>
Java Speech Markup Language. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="w10w7"></a><!-- doxytag: member="mtSmml" ref="w10w7" args="" -->mtSmml</em> </td><td>
Speech Markup Meta-language </td></tr>
<tr><td valign="top"><em><a class="anchor" name="w10w8"></a><!-- doxytag: member="mtSable" ref="w10w8" args="" -->mtSable</em> </td><td>
Sable 2.0. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00063">63</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z1"></a><!-- doxytag: member="KSpeechSink::kttsdExiting" ref="z1" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::kttsdExiting </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted just before KTTSD exits.
<p>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00079">79</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z0"></a><!-- doxytag: member="KSpeechSink::kttsdStarted" ref="z0" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::kttsdStarted </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted when KTTSD starts or restarts after a call to reinit.
<p>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00075">75</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z2"></a><!-- doxytag: member="KSpeechSink::markerSeen" ref="z2" args="(const QCString &appId, const QString &markerName)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::markerSeen </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname" nowrap> <em>appId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> & </td>
<td class="mdname" nowrap> <em>markerName</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted when the speech engine/plugin encounters a marker in the text.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appId</em> </td><td>DCOP application ID of the application that queued the text. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>markerName</em> </td><td>The name of the marker seen. </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd>markers</dd></dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00087">87</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z4"></a><!-- doxytag: member="KSpeechSink::sentenceFinished" ref="z4" args="(const QCString &appId, uint jobNum, uint seq)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::sentenceFinished </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname" nowrap> <em>appId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>jobNum</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>seq</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted when a sentence has finished speaking.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appId</em> </td><td>DCOP application ID of the application that queued the text. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>jobNum</em> </td><td>Job number of the text job. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>seq</em> </td><td>Sequence number of the text. </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd>getTextCount</dd></dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00103">103</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z3"></a><!-- doxytag: member="KSpeechSink::sentenceStarted" ref="z3" args="(const QCString &appId, uint jobNum, uint seq)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::sentenceStarted </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname" nowrap> <em>appId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>jobNum</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>seq</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted whenever a sentence begins speaking.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appId</em> </td><td>DCOP application ID of the application that queued the text. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>jobNum</em> </td><td>Job number of the text job. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>seq</em> </td><td>Sequence number of the text. </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd>getTextCount</dd></dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00095">95</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z6"></a><!-- doxytag: member="KSpeechSink::textAppended" ref="z6" args="(const QCString &appId, uint jobNum, int partNum)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::textAppended </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname" nowrap> <em>appId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>jobNum</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>partNum</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted whenever a new part is appended to a text job.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appId</em> </td><td>The DCOP senderId of the application that created the job. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>jobNum</em> </td><td>Job number of the text job. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>partNum</em> </td><td>Part number of the new part. Parts are numbered starting at 1.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00119">119</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z8"></a><!-- doxytag: member="KSpeechSink::textFinished" ref="z8" args="(const QCString &appId, uint jobNum)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::textFinished </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname" nowrap> <em>appId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>jobNum</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted whenever a text job is finished.
<p>
The job has been marked for deletion from the queue and will be deleted when another job reaches the Finished state. (Only one job in the text queue may be in state Finished at one time.) If startText or resumeText is called before the job is deleted, it will remain in the queue for speaking. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appId</em> </td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>jobNum</em> </td><td>Job number of the text job.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00136">136</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z10"></a><!-- doxytag: member="KSpeechSink::textPaused" ref="z10" args="(const QCString &appId, uint jobNum)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::textPaused </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname" nowrap> <em>appId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>jobNum</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted whenever a speaking text job is paused.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appId</em> </td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>jobNum</em> </td><td>Job number of the text job.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00148">148</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z12"></a><!-- doxytag: member="KSpeechSink::textRemoved" ref="z12" args="(const QCString &appId, uint jobNum)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::textRemoved </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname" nowrap> <em>appId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>jobNum</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted whenever a text job is deleted from the queue.
<p>
The job is no longer in the queue when this signal is emitted. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appId</em> </td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>jobNum</em> </td><td>Job number of the text job.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00161">161</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z11"></a><!-- doxytag: member="KSpeechSink::textResumed" ref="z11" args="(const QCString &appId, uint jobNum)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::textResumed </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname" nowrap> <em>appId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>jobNum</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted when a text job, that was previously paused, resumes speaking.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appId</em> </td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>jobNum</em> </td><td>Job number of the text job.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00154">154</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z5"></a><!-- doxytag: member="KSpeechSink::textSet" ref="z5" args="(const QCString &appId, uint jobNum)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::textSet </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname" nowrap> <em>appId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>jobNum</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted whenever a new text job is added to the queue.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appId</em> </td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>jobNum</em> </td><td>Job number of the text job.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00110">110</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z7"></a><!-- doxytag: member="KSpeechSink::textStarted" ref="z7" args="(const QCString &appId, uint jobNum)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::textStarted </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname" nowrap> <em>appId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>jobNum</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted whenever speaking of a text job begins.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appId</em> </td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>jobNum</em> </td><td>Job number of the text job.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00126">126</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<a class="anchor" name="z9"></a><!-- doxytag: member="KSpeechSink::textStopped" ref="z9" args="(const QCString &appId, uint jobNum)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ASYNC KSpeechSink::textStopped </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname" nowrap> <em>appId</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>jobNum</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted whenever a speaking text job stops speaking.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appId</em> </td><td>The DCOP senderId of the application that created the job. NULL if kttsd. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>jobNum</em> </td><td>Job number of the text job.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kspeechsink_8h-source.html#l00142">142</a> of file <a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a>. </td>
</tr>
</table>
<hr>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="kspeechsink_8h-source.html">kspeechsink.h</a></ul>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>interfaces/kspeech</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="dirs.html">Directories</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKSpeech.html">kspeech</option>, <option value="classKSpeechSink.html">kspeechsink</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../../arts/html/index.html">arts</a></li><li><a href="../../../dcop/html/index.html">dcop</a></li><li><a href="../../../dnssd/html/index.html">dnssd</a></li><li><a href="../../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../../kabc/html/index.html">kabc</a></li><li><a href="../../../kate/html/index.html">kate</a></li><li><a href="../../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../../kdecore/html/index.html">kdecore</a></li><li><a href="../../../kded/html/index.html">kded</a></li><li><a href="../../../kdefx/html/index.html">kdefx</a></li><li><a href="../../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../../kdesu/html/index.html">kdesu</a></li><li><a href="../../../kdeui/html/index.html">kdeui</a></li><li><a href="../../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../../khtml/html/index.html">khtml</a></li><li><a href="../../../kimgio/html/index.html">kimgio</a></li><li><a href="../../../kinit/html/index.html">kinit</a></li><li><a href="../../../kio/html/index.html">kio</a></li><li> <a href="../../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../../kio/kio/html/index.html">kio</a></li><li> <a href="../../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../../kioslave/http/html/index.html">http</a></li><li><a href="../../../kjs/html/index.html">kjs</a></li><li><a href="../../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../../kparts/html/index.html">kparts</a></li><li><a href="../../../kresources/html/index.html">kresources</a></li><li><a href="../../../kspell2/html/index.html">kspell2</a></li><li><a href="../../../kunittest/html/index.html">kunittest</a></li><li><a href="../../../kutils/html/index.html">kutils</a></li><li><a href="../../../kwallet/html/index.html">kwallet</a></li><li><a href="../../../libkmid/html/index.html">libkmid</a></li><li><a href="../../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
distrib
>
PLD
>
ac
>
amd64
>
media
>
dist
>
by-pkgid
>
90467ea6a387df728f7218a11e972208
>
files
>
854
