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/classQXmppJinglePayloadType.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppJinglePayloadType.html')
| -rw-r--r-- | doc/html/classQXmppJinglePayloadType.html | 350 |
1 files changed, 350 insertions, 0 deletions
diff --git a/doc/html/classQXmppJinglePayloadType.html b/doc/html/classQXmppJinglePayloadType.html new file mode 100644 index 00000000..df717d5f --- /dev/null +++ b/doc/html/classQXmppJinglePayloadType.html @@ -0,0 +1,350 @@ +<!-- 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: QXmppJinglePayloadType 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>QXmppJinglePayloadType Class Reference</h1><!-- doxytag: class="QXmppJinglePayloadType" --> +<p>The <a class="el" href="classQXmppJinglePayloadType.html" title="The QXmppJinglePayloadType class represents a payload type as specified by XEP-0167:...">QXmppJinglePayloadType</a> class represents a payload type as specified by XEP-0167: Jingle RTP Sessions and RFC 5245. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppJingleIq_8h_source.html">QXmppJingleIq.h</a>></code></p> + +<p><a href="classQXmppJinglePayloadType-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#a11c8291389457bfe986b8c738e0e49a3">channels</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#aae85a93d980283519b526b6078c7d7ba">setChannels</a> (unsigned char channels)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#ac6f8856d83334360d8766b473dba301a">clockrate</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#a25d8fa0e0a23e70e72b544f7cd073da6">setClockrate</a> (unsigned int clockrate)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#a7b2478ecef7063e99522f5a073275783">id</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#a54a81639dc575b99cf4a42a24b7de65b">setId</a> (unsigned char id)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#ab6971a4585334d2184c4a43cc65ca13f">maxptime</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#a78d6fd7ba582123bc1fdd35530bcbc46">setMaxptime</a> (unsigned int maxptime)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#ae683ecd2f8ea39e43ab739292d166cac">name</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#accafc5198b67b5f5069f54f2a941fc1f">setName</a> (const QString &name)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#a563e28e2153570ea936e1bf9c13cbbd7">ptime</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppJinglePayloadType.html#a55217b43a1ed57ef2fd03f9e9d000870">setPtime</a> (unsigned int ptime)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab368f65404568832f8cd861d2b307a94"></a><!-- doxytag: member="QXmppJinglePayloadType::operator==" ref="ab368f65404568832f8cd861d2b307a94" args="(const QXmppJinglePayloadType &other) const " --> +bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classQXmppJinglePayloadType.html">QXmppJinglePayloadType</a> &other) const </td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppJinglePayloadType.html" title="The QXmppJinglePayloadType class represents a payload type as specified by XEP-0167:...">QXmppJinglePayloadType</a> class represents a payload type as specified by XEP-0167: Jingle RTP Sessions and RFC 5245. </p> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a11c8291389457bfe986b8c738e0e49a3"></a><!-- doxytag: member="QXmppJinglePayloadType::channels" ref="a11c8291389457bfe986b8c738e0e49a3" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">unsigned char QXmppJinglePayloadType::channels </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the number of channels (e.g. 1 for mono, 2 for stereo). </p> + +</div> +</div> +<a class="anchor" id="ac6f8856d83334360d8766b473dba301a"></a><!-- doxytag: member="QXmppJinglePayloadType::clockrate" ref="ac6f8856d83334360d8766b473dba301a" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">unsigned int QXmppJinglePayloadType::clockrate </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the clockrate in Hz, i.e. the number of samples per second. </p> + +</div> +</div> +<a class="anchor" id="a7b2478ecef7063e99522f5a073275783"></a><!-- doxytag: member="QXmppJinglePayloadType::id" ref="a7b2478ecef7063e99522f5a073275783" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">unsigned char QXmppJinglePayloadType::id </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the payload type identifier. </p> + +</div> +</div> +<a class="anchor" id="ab6971a4585334d2184c4a43cc65ca13f"></a><!-- doxytag: member="QXmppJinglePayloadType::maxptime" ref="ab6971a4585334d2184c4a43cc65ca13f" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">unsigned int QXmppJinglePayloadType::maxptime </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the maximum packet time in milliseconds. </p> + +</div> +</div> +<a class="anchor" id="ae683ecd2f8ea39e43ab739292d166cac"></a><!-- doxytag: member="QXmppJinglePayloadType::name" ref="ae683ecd2f8ea39e43ab739292d166cac" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppJinglePayloadType::name </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the payload type name. </p> + +</div> +</div> +<a class="anchor" id="a563e28e2153570ea936e1bf9c13cbbd7"></a><!-- doxytag: member="QXmppJinglePayloadType::ptime" ref="a563e28e2153570ea936e1bf9c13cbbd7" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">unsigned int QXmppJinglePayloadType::ptime </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the packet time in milliseconds (20 by default). </p> + +</div> +</div> +<a class="anchor" id="aae85a93d980283519b526b6078c7d7ba"></a><!-- doxytag: member="QXmppJinglePayloadType::setChannels" ref="aae85a93d980283519b526b6078c7d7ba" args="(unsigned char channels)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppJinglePayloadType::setChannels </td> + <td>(</td> + <td class="paramtype">unsigned char </td> + <td class="paramname"> <em>channels</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the number of channels (e.g. 1 for mono, 2 for stereo).</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>channels</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a25d8fa0e0a23e70e72b544f7cd073da6"></a><!-- doxytag: member="QXmppJinglePayloadType::setClockrate" ref="a25d8fa0e0a23e70e72b544f7cd073da6" args="(unsigned int clockrate)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppJinglePayloadType::setClockrate </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>clockrate</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the clockrate in Hz, i.e. the number of samples per second.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>clockrate</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a54a81639dc575b99cf4a42a24b7de65b"></a><!-- doxytag: member="QXmppJinglePayloadType::setId" ref="a54a81639dc575b99cf4a42a24b7de65b" args="(unsigned char id)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppJinglePayloadType::setId </td> + <td>(</td> + <td class="paramtype">unsigned char </td> + <td class="paramname"> <em>id</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the payload type identifier. </p> + +</div> +</div> +<a class="anchor" id="a78d6fd7ba582123bc1fdd35530bcbc46"></a><!-- doxytag: member="QXmppJinglePayloadType::setMaxptime" ref="a78d6fd7ba582123bc1fdd35530bcbc46" args="(unsigned int maxptime)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppJinglePayloadType::setMaxptime </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>maxptime</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the maximum packet type in milliseconds.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>maxptime</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="accafc5198b67b5f5069f54f2a941fc1f"></a><!-- doxytag: member="QXmppJinglePayloadType::setName" ref="accafc5198b67b5f5069f54f2a941fc1f" args="(const QString &name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppJinglePayloadType::setName </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>name</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the payload type name.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a55217b43a1ed57ef2fd03f9e9d000870"></a><!-- doxytag: member="QXmppJinglePayloadType::setPtime" ref="a55217b43a1ed57ef2fd03f9e9d000870" args="(unsigned int ptime)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppJinglePayloadType::setPtime </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>ptime</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the packet time in milliseconds (20 by default).</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>ptime</em> </td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppJingleIq_8h_source.html">QXmppJingleIq.h</a></li> +<li>QXmppJingleIq.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:24 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> |