<!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: JGAudioList 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_1JGAudioList.html">JGAudioList</a>
</div>
</div>
<div class="contents">
<h1>JGAudioList Class Reference</h1><!-- doxytag: class="TelEngine::JGAudioList" --><!-- doxytag: inherits="TelEngine::ObjList" -->A List of Jingle data payloads.
<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 JGAudioList:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1JGAudioList.png" usemap="#JGAudioList_map" border="0" alt=""></center>
<map name="JGAudioList_map">
<area href="classTelEngine_1_1ObjList.html" alt="ObjList" shape="rect" coords="0,56,80,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,80,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1JGAudioList-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudioList.html#fe5751cc745288231a11080bee30d507">add</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"><a class="el" href="classTelEngine_1_1JGAudio.html">JGAudio</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudioList.html#165b1c52b3a4419495d2fb85d3cf7667">findSynonym</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &value)</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_1JGAudioList.html#78424c6d585369d977b2c787a7ca6fe1">toXML</a> (bool telEvent=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudioList.html#5cd7f02fd2fa558b6cc20f533bc03add">fromXML</a> (<a class="el" href="classTelEngine_1_1XMLElement.html">XMLElement</a> *xml)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1JGAudioList.html#37290447bb5fc8757ca860fe016b4975">createList</a> (<a class="el" href="classTelEngine_1_1String.html">String</a> &dest, bool synonym, const char *sep=",")</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A List of Jingle data payloads.
<p>
Hold a list of data payloads <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="fe5751cc745288231a11080bee30d507"></a><!-- doxytag: member="TelEngine::JGAudioList::add" ref="fe5751cc745288231a11080bee30d507" 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 add </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>
Append a new data payload <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 payload's id </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The payload's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>clockrate</em> </td><td>The payload's clockrate </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bitrate</em> </td><td>The payload's bitrate </td></tr>
<tr><td valign="top"></td><td valign="top"><em>synonym</em> </td><td>The payload's synonym </td></tr>
</table>
</dl>
<p>References <a class="el" href="classTelEngine_1_1ObjList.html#abb60c1b270c8c7fdb5b548d99e40b67">ObjList::append()</a>.</p>
</div>
</div><p>
<a class="anchor" name="37290447bb5fc8757ca860fe016b4975"></a><!-- doxytag: member="TelEngine::JGAudioList::createList" ref="37290447bb5fc8757ca860fe016b4975" args="(String &dest, bool synonym, const char *sep=",")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool createList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>synonym</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sep</em> = <code>","</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a list from data payloads <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>Destination string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>synonym</em> </td><td>True to create from synonyms, false to create from names </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sep</em> </td><td>List item separator </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the list is empty </dd></dl>
</div>
</div><p>
<a class="anchor" name="165b1c52b3a4419495d2fb85d3cf7667"></a><!-- doxytag: member="TelEngine::JGAudioList::findSynonym" ref="165b1c52b3a4419495d2fb85d3cf7667" args="(const String &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1JGAudio.html">JGAudio</a>* findSynonym </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a data payload by its synonym <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The value to compare with </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classTelEngine_1_1JGAudio.html" title="A Jingle data payload.">JGAudio</a> pointer or 0 if not found </dd></dl>
</div>
</div><p>
<a class="anchor" name="5cd7f02fd2fa558b6cc20f533bc03add"></a><!-- doxytag: member="TelEngine::JGAudioList::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 list from an XML element's children. Clear before attempting to fill <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 source XML element </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="78424c6d585369d977b2c787a7ca6fe1"></a><!-- doxytag: member="TelEngine::JGAudioList::toXML" ref="78424c6d585369d977b2c787a7ca6fe1" args="(bool telEvent=true)" -->
<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="paramtype">bool </td>
<td class="paramname"> <em>telEvent</em> = <code>true</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a 'description' element and add payload children to it <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>telEvent</em> </td><td>True to append a telephone event data payload </td></tr>
</table>
</dl>
<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>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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
253
