diff options
| author | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
|---|---|---|
| committer | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
| commit | 93adc6aec9ba4671884d9692308b239d3064e553 (patch) | |
| tree | a5906e560045c841577473a9118ef06a39950a73 /doc/html/classQXmppCall.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppCall.html')
| -rw-r--r-- | doc/html/classQXmppCall.html | 352 |
1 files changed, 352 insertions, 0 deletions
diff --git a/doc/html/classQXmppCall.html b/doc/html/classQXmppCall.html new file mode 100644 index 00000000..4c508871 --- /dev/null +++ b/doc/html/classQXmppCall.html @@ -0,0 +1,352 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!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"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<title>QXmpp: QXmppCall Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javaScript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css"/> +</head> +<body onload='searchBox.OnSelectItem(0);'> +<!-- Generated by Doxygen 1.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>QXmppCall Class Reference</h1><!-- doxytag: class="QXmppCall" --> +<p>The <a class="el" href="classQXmppCall.html" title="The QXmppCall class represents a Voice-Over-IP call to a remote party.">QXmppCall</a> class represents a Voice-Over-IP call to a remote party. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppCallManager_8h_source.html">QXmppCallManager.h</a>></code></p> + +<p><a href="classQXmppCall-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#a429a4f8065136068b6d936cb2c803175">Direction</a> { <a class="el" href="classQXmppCall.html#a429a4f8065136068b6d936cb2c803175afc8bc2f0c97899f7be845547046d1aa0">IncomingDirection</a>, +<a class="el" href="classQXmppCall.html#a429a4f8065136068b6d936cb2c803175a4959a53587ff3fe714b0c619dd8ba47d">OutgoingDirection</a> + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum is used to describe the direction of a call. </p> + <a href="classQXmppCall.html#a429a4f8065136068b6d936cb2c803175">More...</a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#a90205b5034613127d2c4adc6a0252759">State</a> { <br/> + <a class="el" href="classQXmppCall.html#a90205b5034613127d2c4adc6a0252759aa08f1be594451896121babcc32d5ed49">OfferState</a> = 0, +<a class="el" href="classQXmppCall.html#a90205b5034613127d2c4adc6a0252759ad7e30b8eff38aab65d8fedb68d9436fd">ConnectingState</a> = 1, +<a class="el" href="classQXmppCall.html#a90205b5034613127d2c4adc6a0252759ac43dd016f3eb2141b9ee044c255afcb8">ActiveState</a> = 2, +<a class="el" href="classQXmppCall.html#a90205b5034613127d2c4adc6a0252759ac703ddc035652668500e44376d38333d">DisconnectingState</a> = 3, +<br/> + <a class="el" href="classQXmppCall.html#a90205b5034613127d2c4adc6a0252759ace75b803223c076618b697a77320e491">FinishedState</a> = 4 +<br/> + }</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>This enum is used to describe the state of a call. </p> + <a href="classQXmppCall.html#a90205b5034613127d2c4adc6a0252759">More...</a><br/></td></tr> +<tr><td colspan="2"><h2>Public Slots</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#a0627637efc9efd57aada1ce783b94457">accept</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#a36e4892d706ae7035d5973f6e3b6a7cb">hangup</a> ()</td></tr> +<tr><td colspan="2"><h2>Signals</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#a384d69cd1bea31bbfaa8df9c3e99d478">connected</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#a4e2f8523540bcccc963e11401c666809">finished</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac661611e7d0bf5ebcdf56a28d60a95aa"></a><!-- doxytag: member="QXmppCall::ringing" ref="ac661611e7d0bf5ebcdf56a28d60a95aa" args="()" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#ac661611e7d0bf5ebcdf56a28d60a95aa">ringing</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is emitted when the remote party is ringing. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35c27fd7d70eb13f082e110a957d5dee"></a><!-- doxytag: member="QXmppCall::logMessage" ref="a35c27fd7d70eb13f082e110a957d5dee" args="(QXmppLogger::MessageType type, const QString &msg)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#a35c27fd7d70eb13f082e110a957d5dee">logMessage</a> (<a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8">QXmppLogger::MessageType</a> type, const QString &msg)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is emitted to send logging messages. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16dd6c41d04900e322ce522d010cd513"></a><!-- doxytag: member="QXmppCall::stateChanged" ref="a16dd6c41d04900e322ce522d010cd513" args="(QXmppCall::State state)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#a16dd6c41d04900e322ce522d010cd513">stateChanged</a> (<a class="el" href="classQXmppCall.html#a90205b5034613127d2c4adc6a0252759">QXmppCall::State</a> state)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is emitted when the call state changes. <br/></td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppCall.html#a429a4f8065136068b6d936cb2c803175">QXmppCall::Direction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#aecf66fe780e381ac81b63a46dd2263fd">direction</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#a87f1c5b4ace1c09e7f855cdf6ea7cfbc">jid</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#a1a47d872cb001717eb7644dd6f168926">sid</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppCall.html#a90205b5034613127d2c4adc6a0252759">QXmppCall::State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#a60fc74b6a088b96c1a6985def4d2f868">state</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppJinglePayloadType.html">QXmppJinglePayloadType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#ac5112101c81f30de6acec91111cc77c4">payloadType</a> () const </td></tr> +<tr><td colspan="2"><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe7743d93115ac855ef40ddd9158e74f"></a><!-- doxytag: member="QXmppCall::QXmppCallManager" ref="afe7743d93115ac855ef40ddd9158e74f" args="" --> +class </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppCall.html#afe7743d93115ac855ef40ddd9158e74f">QXmppCallManager</a></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppCall.html" title="The QXmppCall class represents a Voice-Over-IP call to a remote party.">QXmppCall</a> class represents a Voice-Over-IP call to a remote party. </p> +<p>It acts as a QIODevice so that you can read / write audio samples, for instance using a QAudioOutput and a QAudioInput.</p> +<dl class="note"><dt><b>Note:</b></dt><dd>THIS API IS NOT FINALIZED YET </dd></dl> +<hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="a429a4f8065136068b6d936cb2c803175"></a><!-- doxytag: member="QXmppCall::Direction" ref="a429a4f8065136068b6d936cb2c803175" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppCall.html#a429a4f8065136068b6d936cb2c803175">QXmppCall::Direction</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>This enum is used to describe the direction of a call. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a429a4f8065136068b6d936cb2c803175afc8bc2f0c97899f7be845547046d1aa0"></a><!-- doxytag: member="IncomingDirection" ref="a429a4f8065136068b6d936cb2c803175afc8bc2f0c97899f7be845547046d1aa0" args="" -->IncomingDirection</em> </td><td> +<p>The call is incoming. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a429a4f8065136068b6d936cb2c803175a4959a53587ff3fe714b0c619dd8ba47d"></a><!-- doxytag: member="OutgoingDirection" ref="a429a4f8065136068b6d936cb2c803175a4959a53587ff3fe714b0c619dd8ba47d" args="" -->OutgoingDirection</em> </td><td> +<p>The call is outgoing. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<a class="anchor" id="a90205b5034613127d2c4adc6a0252759"></a><!-- doxytag: member="QXmppCall::State" ref="a90205b5034613127d2c4adc6a0252759" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppCall.html#a90205b5034613127d2c4adc6a0252759">QXmppCall::State</a></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>This enum is used to describe the state of a call. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a90205b5034613127d2c4adc6a0252759aa08f1be594451896121babcc32d5ed49"></a><!-- doxytag: member="OfferState" ref="a90205b5034613127d2c4adc6a0252759aa08f1be594451896121babcc32d5ed49" args="" -->OfferState</em> </td><td> +<p>The remote part is being called. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a90205b5034613127d2c4adc6a0252759ad7e30b8eff38aab65d8fedb68d9436fd"></a><!-- doxytag: member="ConnectingState" ref="a90205b5034613127d2c4adc6a0252759ad7e30b8eff38aab65d8fedb68d9436fd" args="" -->ConnectingState</em> </td><td> +<p>The call is being connected. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a90205b5034613127d2c4adc6a0252759ac43dd016f3eb2141b9ee044c255afcb8"></a><!-- doxytag: member="ActiveState" ref="a90205b5034613127d2c4adc6a0252759ac43dd016f3eb2141b9ee044c255afcb8" args="" -->ActiveState</em> </td><td> +<p>The call is active. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a90205b5034613127d2c4adc6a0252759ac703ddc035652668500e44376d38333d"></a><!-- doxytag: member="DisconnectingState" ref="a90205b5034613127d2c4adc6a0252759ac703ddc035652668500e44376d38333d" args="" -->DisconnectingState</em> </td><td> +<p>The call is being disconnected. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a90205b5034613127d2c4adc6a0252759ace75b803223c076618b697a77320e491"></a><!-- doxytag: member="FinishedState" ref="a90205b5034613127d2c4adc6a0252759ace75b803223c076618b697a77320e491" args="" -->FinishedState</em> </td><td> +<p>The call is finished. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a0627637efc9efd57aada1ce783b94457"></a><!-- doxytag: member="QXmppCall::accept" ref="a0627637efc9efd57aada1ce783b94457" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppCall::accept </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Call this method if you wish to accept an incoming call. </p> + +</div> +</div> +<a class="anchor" id="a384d69cd1bea31bbfaa8df9c3e99d478"></a><!-- doxytag: member="QXmppCall::connected" ref="a384d69cd1bea31bbfaa8df9c3e99d478" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppCall::connected </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when a call is connected.</p> +<p>Once this signal is emitted, you can connect a QAudioOutput and QAudioInput to the call. You can determine the appropriate clockrate and the number of channels by calling <a class="el" href="classQXmppCall.html#ac5112101c81f30de6acec91111cc77c4">payloadType()</a>. </p> + +</div> +</div> +<a class="anchor" id="aecf66fe780e381ac81b63a46dd2263fd"></a><!-- doxytag: member="QXmppCall::direction" ref="aecf66fe780e381ac81b63a46dd2263fd" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppCall.html#a429a4f8065136068b6d936cb2c803175">QXmppCall::Direction</a> QXmppCall::direction </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the call's direction. </p> + +</div> +</div> +<a class="anchor" id="a4e2f8523540bcccc963e11401c666809"></a><!-- doxytag: member="QXmppCall::finished" ref="a4e2f8523540bcccc963e11401c666809" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppCall::finished </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when a call is finished.</p> +<p>Note: Do not delete the call in the slot connected to this signal, instead use deleteLater(). </p> + +</div> +</div> +<a class="anchor" id="a36e4892d706ae7035d5973f6e3b6a7cb"></a><!-- doxytag: member="QXmppCall::hangup" ref="a36e4892d706ae7035d5973f6e3b6a7cb" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppCall::hangup </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Hangs up the call. </p> + +</div> +</div> +<a class="anchor" id="a87f1c5b4ace1c09e7f855cdf6ea7cfbc"></a><!-- doxytag: member="QXmppCall::jid" ref="a87f1c5b4ace1c09e7f855cdf6ea7cfbc" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppCall::jid </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the remote party's JID. </p> + +</div> +</div> +<a class="anchor" id="ac5112101c81f30de6acec91111cc77c4"></a><!-- doxytag: member="QXmppCall::payloadType" ref="ac5112101c81f30de6acec91111cc77c4" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppJinglePayloadType.html">QXmppJinglePayloadType</a> QXmppCall::payloadType </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the negociated payload type.</p> +<p>You can use this to determine the QAudioFormat to use with your QAudioInput/QAudioOutput. </p> + +</div> +</div> +<a class="anchor" id="a1a47d872cb001717eb7644dd6f168926"></a><!-- doxytag: member="QXmppCall::sid" ref="a1a47d872cb001717eb7644dd6f168926" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppCall::sid </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the call's session identifier. </p> + +</div> +</div> +<a class="anchor" id="a60fc74b6a088b96c1a6985def4d2f868"></a><!-- doxytag: member="QXmppCall::state" ref="a60fc74b6a088b96c1a6985def4d2f868" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppCall.html#a90205b5034613127d2c4adc6a0252759">QXmppCall::State</a> QXmppCall::state </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the call's state.</p> +<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQXmppCall.html#a16dd6c41d04900e322ce522d010cd513" title="This signal is emitted when the call state changes.">stateChanged()</a> </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppCallManager_8h_source.html">QXmppCallManager.h</a></li> +<li>QXmppCallManager.cpp</li> +</ul> +</div> +<!--- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 22 00:44:23 2010 for QXmpp by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |