<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Yate: JGAudio Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.7.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</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> </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 class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1JGAudio.html">JGAudio</a> </div> </div> <div class="contents"> <h1>JGAudio Class Reference</h1><!-- doxytag: class="TelEngine::JGAudio" --><!-- doxytag: inherits="TelEngine::GenObject" -->A Jingle data payload. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="yatejingle_8h-source.html">yatejingle.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for JGAudio:</div> <div class="dynsection"> <p><center><img src="classTelEngine_1_1JGAudio.png" usemap="#JGAudio_map" border="0" alt=""></center> <map name="JGAudio_map"> <area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,72,24"> </map> </div> <p> <a href="classTelEngine_1_1JGAudio-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#4d1ad11be60e72cca592783fbb776eed">JGAudio</a> (const char *_id, const char *_name, const char *_clockrate, const char *_bitrate, const char *_synonym)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#4c540042c1e24ecc59cabc88f6147786">JGAudio</a> (<a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *xml)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#f5ff705a73bbff2fc0297a31bf395d4d">JGAudio</a> (const <a class="el" href="classTelEngine_1_1JGAudio.html">JGAudio</a> &src)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#f2dbd658fffad392339de6eede1c923f">set</a> (const char *_id, const char *_name, const char *_clockrate, const char *_bitrate, const char *_synonym)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#4a7bd56fb99593ace9379ed699f2719c">toString</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#0d90793cb15e05c2e9e10fc84b2953c5">toXML</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#5cd7f02fd2fa558b6cc20f533bc03add">fromXML</a> (<a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *xml)</td></tr> <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#76010eef1edc0406cc2375c25d2a433d">id</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#9a2326f35466e54c36c070829245c557">name</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#94bc83bcc93239074a48ae1e8da8e59e">clockrate</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#cf162452cf1e2c604a9ef5d7870d6ece">bitrate</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classTelEngine_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudio.html#73ef99fb1f39432a5baed5d8c264ec34">synonym</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A Jingle data payload. <p> This class holds a Jingle data payload description <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="4d1ad11be60e72cca592783fbb776eed"></a><!-- doxytag: member="TelEngine::JGAudio::JGAudio" ref="4d1ad11be60e72cca592783fbb776eed" args="(const char *_id, const char *_name, const char *_clockrate, const char *_bitrate, const char *_synonym)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1JGAudio.html">JGAudio</a> </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>_id</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>_name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>_clockrate</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>_bitrate</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>_synonym</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor. Fill this object from the given attributes <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>_id</em> </td><td>The 'id' attribute </td></tr> <tr><td valign="top"></td><td valign="top"><em>_name</em> </td><td>The 'name' attribute </td></tr> <tr><td valign="top"></td><td valign="top"><em>_clockrate</em> </td><td>The 'clockrate' attribute </td></tr> <tr><td valign="top"></td><td valign="top"><em>_bitrate</em> </td><td>The 'bitrate' attribute </td></tr> <tr><td valign="top"></td><td valign="top"><em>_synonym</em> </td><td>The 'synonym' attribute </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="4c540042c1e24ecc59cabc88f6147786"></a><!-- doxytag: member="TelEngine::JGAudio::JGAudio" ref="4c540042c1e24ecc59cabc88f6147786" args="(XMLElement *xml)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1JGAudio.html">JGAudio</a> </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> * </td> <td class="paramname"> <em>xml</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor. Fill this object from an XML element <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>xml</em> </td><td>The element to fill from </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="f5ff705a73bbff2fc0297a31bf395d4d"></a><!-- doxytag: member="TelEngine::JGAudio::JGAudio" ref="f5ff705a73bbff2fc0297a31bf395d4d" args="(const JGAudio &src)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1JGAudio.html">JGAudio</a> </td> <td>(</td> <td class="paramtype">const <a class="el" href="classTelEngine_1_1JGAudio.html">JGAudio</a> & </td> <td class="paramname"> <em>src</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Copy constructor <p>References <a class="el" href="yatejingle_8h-source.html#l00130">JGAudio::bitrate</a>, <a class="el" href="yatejingle_8h-source.html#l00125">JGAudio::clockrate</a>, <a class="el" href="yatejingle_8h-source.html#l00115">JGAudio::id</a>, <a class="el" href="yatejingle_8h-source.html#l00120">JGAudio::name</a>, and <a class="el" href="yatejingle_8h-source.html#l00135">JGAudio::synonym</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="5cd7f02fd2fa558b6cc20f533bc03add"></a><!-- doxytag: member="TelEngine::JGAudio::fromXML" ref="5cd7f02fd2fa558b6cc20f533bc03add" args="(XMLElement *xml)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void fromXML </td> <td>(</td> <td class="paramtype"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> * </td> <td class="paramname"> <em>xml</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Fill this object from a given element <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>xml</em> </td><td>The element </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="f2dbd658fffad392339de6eede1c923f"></a><!-- doxytag: member="TelEngine::JGAudio::set" ref="f2dbd658fffad392339de6eede1c923f" args="(const char *_id, const char *_name, const char *_clockrate, const char *_bitrate, const char *_synonym)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void set </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>_id</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>_name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>_clockrate</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>_bitrate</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>_synonym</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the data <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>_id</em> </td><td>The 'id' attribute </td></tr> <tr><td valign="top"></td><td valign="top"><em>_name</em> </td><td>The 'name' attribute </td></tr> <tr><td valign="top"></td><td valign="top"><em>_clockrate</em> </td><td>The 'clockrate' attribute </td></tr> <tr><td valign="top"></td><td valign="top"><em>_bitrate</em> </td><td>The 'bitrate' attribute </td></tr> <tr><td valign="top"></td><td valign="top"><em>_synonym</em> </td><td>The 'synonym' attribute </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="4a7bd56fb99593ace9379ed699f2719c"></a><!-- doxytag: member="TelEngine::JGAudio::toString" ref="4a7bd56fb99593ace9379ed699f2719c" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const <a class="el" href="classTelEngine_1_1String.html">String</a>& toString </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the string repreasentation (id) of this payload <dl class="return" compact><dt><b>Returns:</b></dt><dd>The string repreasentation (id) of this payload </dd></dl> <p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#4a7bd56fb99593ace9379ed699f2719c">GenObject</a>.</p> </div> </div><p> <a class="anchor" name="0d90793cb15e05c2e9e10fc84b2953c5"></a><!-- doxytag: member="TelEngine::JGAudio::toXML" ref="0d90793cb15e05c2e9e10fc84b2953c5" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a>* toXML </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Create a 'payload-type' element from this object <dl class="return" compact><dt><b>Returns:</b></dt><dd>Valid <a class="el" href="classTelEngine_1_1XMLElement.html" title="An XML element.">XMLElement</a> pointer </dd></dl> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="cf162452cf1e2c604a9ef5d7870d6ece"></a><!-- doxytag: member="TelEngine::JGAudio::bitrate" ref="cf162452cf1e2c604a9ef5d7870d6ece" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1String.html">String</a> <a class="el" href="classTelEngine_1_1JGAudio.html#cf162452cf1e2c604a9ef5d7870d6ece">bitrate</a> </td> </tr> </table> </div> <div class="memdoc"> <p> The bitrate of this payload <p>Referenced by <a class="el" href="yatejingle_8h-source.html#l00073">JGAudio::JGAudio()</a>.</p> </div> </div><p> <a class="anchor" name="94bc83bcc93239074a48ae1e8da8e59e"></a><!-- doxytag: member="TelEngine::JGAudio::clockrate" ref="94bc83bcc93239074a48ae1e8da8e59e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1String.html">String</a> <a class="el" href="classTelEngine_1_1JGAudio.html#94bc83bcc93239074a48ae1e8da8e59e">clockrate</a> </td> </tr> </table> </div> <div class="memdoc"> <p> The clockrate of this payload <p>Referenced by <a class="el" href="yatejingle_8h-source.html#l00073">JGAudio::JGAudio()</a>.</p> </div> </div><p> <a class="anchor" name="76010eef1edc0406cc2375c25d2a433d"></a><!-- doxytag: member="TelEngine::JGAudio::id" ref="76010eef1edc0406cc2375c25d2a433d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1String.html">String</a> <a class="el" href="classTelEngine_1_1JGAudio.html#76010eef1edc0406cc2375c25d2a433d">id</a> </td> </tr> </table> </div> <div class="memdoc"> <p> The numeric id of this payload <p>Referenced by <a class="el" href="yatejingle_8h-source.html#l00073">JGAudio::JGAudio()</a>.</p> </div> </div><p> <a class="anchor" name="9a2326f35466e54c36c070829245c557"></a><!-- doxytag: member="TelEngine::JGAudio::name" ref="9a2326f35466e54c36c070829245c557" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1String.html">String</a> <a class="el" href="classTelEngine_1_1JGAudio.html#9a2326f35466e54c36c070829245c557">name</a> </td> </tr> </table> </div> <div class="memdoc"> <p> The Jingle name of this payload <p>Referenced by <a class="el" href="yatejingle_8h-source.html#l00073">JGAudio::JGAudio()</a>.</p> </div> </div><p> <a class="anchor" name="73ef99fb1f39432a5baed5d8c264ec34"></a><!-- doxytag: member="TelEngine::JGAudio::synonym" ref="73ef99fb1f39432a5baed5d8c264ec34" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTelEngine_1_1String.html">String</a> <a class="el" href="classTelEngine_1_1JGAudio.html#73ef99fb1f39432a5baed5d8c264ec34">synonym</a> </td> </tr> </table> </div> <div class="memdoc"> <p> A synonym of this payload's name <p>Referenced by <a class="el" href="yatejingle_8h-source.html#l00073">JGAudio::JGAudio()</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="yatejingle_8h-source.html">yatejingle.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 2008 for Yate by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address> </body> </html>