20 lines
10 KiB
HTML
20 lines
10 KiB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Other events</title><link rel="stylesheet" href="ts3doc.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="index.html" title="TeamSpeak 3 Client SDK Developer Manual"><link rel="up" href="index.html" title="TeamSpeak 3 Client SDK Developer Manual"><link rel="prev" href="ar01s26.html" title="Custom passwords"><link rel="next" href="ar01s28.html" title="Miscellaneous functions"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><img id="logo" src="images/logo.png"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Other events</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s26.html"><img src="images/prev.png" alt="Prev"></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s28.html"><img src="images/next.png" alt="Next"></a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="otherevents"></a>Other events</h2></div></div></div><p>When a client starts or stops talking, a talk status change event is sent by the server:
|
||
</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">onTalkStatusChangeEvent</b>(</code></td><td><var class="pdparam">serverConnectionHandlerID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">status</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">isReceivedWhisper</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">clientID</var><code>)</code>;</td><td> </td></tr></table><div class="paramdef-list"><code>uint64 <var class="pdparam">serverConnectionHandlerID</var></code>;<br><code>int <var class="pdparam">status</var></code>;<br><code>int <var class="pdparam">isReceivedWhisper</var></code>;<br><code>anyID <var class="pdparam">clientID</var></code>;</div><div class="funcprototype-spacer"> </div></div><p>
|
||
<a class="indexterm" name="idm44835433114912"></a></p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>serverConnectionHandlerID</code></em></p><p>ID of the server connection handler on which the event occured.</p></li><li><p><em class="parameter"><code>status</code></em></p><p>Possible return values are defined by the enum <span class="structname">TalkStatus</span>:</p><pre class="programlisting">enum TalkStatus {
|
||
STATUS_NOT_TALKING = 0,
|
||
STATUS_TALKING = 1,
|
||
STATUS_TALKING_WHILE_DISABLED = 2,
|
||
};</pre><p><em class="structfield"><code>STATUS_TALKING</code></em> and <em class="structfield"><code>STATUS_NOT_TALKING</code></em> are triggered everytime a client starts or stops talking. <em class="structfield"><code>STATUS_TALKING_WHILE_DISABLED</code></em> is triggered only if the microphone is muted. A client application might use this to implement a mechanism warning the user he is talking while not sending to the server or just ignore this value.</p></li><li><p><em class="parameter"><code>isReceivedWhisper</code></em></p><p>1 if the talk event was caused by whispering, 0 if caused by normal talking.</p></li><li><p><em class="parameter"><code>clientID</code></em></p><p>ID of the client who started or stopped talking.</p></li></ul></div><div class="literallayout"><p><br>
|
||
</p></div><p>If a client drops his connection, a timeout event is announced by the server:
|
||
</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">onClientMoveTimeoutEvent</b>(</code></td><td><var class="pdparam">serverConnectionHandlerID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">clientID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">oldChannelID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">newChannelID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">visibility</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">timeoutMessage</var><code>)</code>;</td><td> </td></tr></table><div class="paramdef-list"><code>uint64 <var class="pdparam">serverConnectionHandlerID</var></code>;<br><code>anyID <var class="pdparam">clientID</var></code>;<br><code>uint64 <var class="pdparam">oldChannelID</var></code>;<br><code>uint64 <var class="pdparam">newChannelID</var></code>;<br><code>int <var class="pdparam">visibility</var></code>;<br><code>const char* <var class="pdparam">timeoutMessage</var></code>;</div><div class="funcprototype-spacer"> </div></div><p>
|
||
<a class="indexterm" name="idm44835433097808"></a></p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>serverConnectionHandlerID</code></em></p><p>ID of the server connection handler on which the event occured.</p></li><li><p><em class="parameter"><code>clientID</code></em></p><p>ID of the moved client.</p></li><li><p><em class="parameter"><code>oldChannelID</code></em></p><p>ID of the channel the leaving client was previously member of.</p></li><li><p><em class="parameter"><code>newChannelID</code></em></p><p><span class="returnvalue">0</span>, as client is leaving.</p></li><li><p><em class="parameter"><code>visibility</code></em></p><p>Always <em class="structfield"><code>LEAVE_VISIBILITY</code></em>.</p></li><li><p><em class="parameter"><code>timeoutMessage</code></em></p><p>Optional message giving the reason for the timeout. UTF-8 encoded.</p></li></ul></div><div class="literallayout"><p><br>
|
||
</p></div><p>When the description of a channel was edited, the following event is called:
|
||
</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">onChannelDescriptionUpdateEvent</b>(</code></td><td><var class="pdparam">serverConnectionHandlerID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">channelID</var><code>)</code>;</td><td> </td></tr></table><div class="paramdef-list"><code>uint64 <var class="pdparam">serverConnectionHandlerID</var></code>;<br><code>uint64 <var class="pdparam">channelID</var></code>;</div><div class="funcprototype-spacer"> </div></div><p>
|
||
<a class="indexterm" name="idm44835433082400"></a></p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>serverConnectionHandlerID</code></em></p><p>ID of the server connection handler on which the event occured.</p></li><li><p><em class="parameter"><code>shutdownMessage</code></em></p><p>ID of the channel with the edited description.</p></li></ul></div><p>The new description can be queried with <a class="link" href="ar01s22s02.html" title="Channel information"><code class="function">ts3client_getChannelVariableAsString(channelID, CHANNEL_DESCRIPTION)</code></a>.</p><div class="literallayout"><p><br>
|
||
</p></div><p>The following event tells the client that the specified channel has been modified. The GUI should fetch the channel data with <a class="link" href="ar01s22s02.html" title="Channel information"><code class="function">ts3client_getChannelVariableAsInt</code></a> and <a class="link" href="ar01s22s02.html" title="Channel information"><code class="function">ts3client_getChannelVariableAsString</code></a> and update the channel display.
|
||
</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">onUpdateChannelEvent</b>(</code></td><td><var class="pdparam">serverConnectionHandlerID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">channelID</var><code>)</code>;</td><td> </td></tr></table><div class="paramdef-list"><code>uint64 <var class="pdparam">serverConnectionHandlerID</var></code>;<br><code>uint64 <var class="pdparam">channelID</var></code>;</div><div class="funcprototype-spacer"> </div></div><p>
|
||
<a class="indexterm" name="idm44835433071104"></a></p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>serverConnectionHandlerID</code></em></p><p>ID of the server connection handler on which the event occured.</p></li><li><p><em class="parameter"><code>channelID</code></em></p><p>ID of the updated channel.</p></li></ul></div><div class="literallayout"><p><br>
|
||
</p></div><p>The following event is called when a channel password was modified. The GUI might remember previously entered channel passwords, so this callback announces the stored password might be invalid.
|
||
</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">onChannelPasswordChangedEvent</b>(</code></td><td><var class="pdparam">serverConnectionHandlerID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">channelID</var><code>)</code>;</td><td> </td></tr></table><div class="paramdef-list"><code>uint64 <var class="pdparam">serverConnectionHandlerID</var></code>;<br><code>uint64 <var class="pdparam">channelID</var></code>;</div><div class="funcprototype-spacer"> </div></div><p>
|
||
<a class="indexterm" name="idm44835433062816"></a></p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>serverConnectionHandlerID</code></em></p><p>ID of the server connection handler on which the event occured.</p></li><li><p><em class="parameter"><code>channelID</code></em></p><p>ID of the channel with the changed password.</p></li></ul></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s26.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s28.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">Custom passwords </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a></td><td width="40%" align="right" valign="top"> Miscellaneous functions</td></tr></table></div></body></html>
|