<!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: FormatInfo Struct 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="structTelEngine_1_1FormatInfo.html">FormatInfo</a>
</div>
</div>
<div class="contents">
<h1>FormatInfo Struct Reference</h1><!-- doxytag: class="TelEngine::FormatInfo" --><code>#include <<a class="el" href="yatephone_8h-source.html">yatephone.h</a>></code>
<p>
<p>
<a href="structTelEngine_1_1FormatInfo-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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structTelEngine_1_1FormatInfo.html#35d1da042d81d9348b022167de84d013">guessSamples</a> (int len) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structTelEngine_1_1FormatInfo.html#bc8554f667f2e50a48fbff6faf18b149">dataRate</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structTelEngine_1_1FormatInfo.html#304249568a3901900be938de0ddb4d54">FormatInfo</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structTelEngine_1_1FormatInfo.html#24d43dde7b7acfe0014e2e545d2065c3">FormatInfo</a> (const char *_name, int fsize=0, int ftime=10000, const char *_type="audio", int srate=8000, int nchan=1, bool convert=false)</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structTelEngine_1_1FormatInfo.html#8f8f80d37794cde9472343e4487ba3eb">name</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structTelEngine_1_1FormatInfo.html#763fd8db6bba8fbbbc113ca0d61c47c2">type</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structTelEngine_1_1FormatInfo.html#a3dad37bb3b3c95138a96b2668936923">frameSize</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structTelEngine_1_1FormatInfo.html#636fa05e7f380226f94d3baf2fe6256e">frameTime</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structTelEngine_1_1FormatInfo.html#d16762d495115c2606417076f062c39d">sampleRate</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structTelEngine_1_1FormatInfo.html#833642af16b83f234a41e9038ac89aaf">numChannels</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structTelEngine_1_1FormatInfo.html#ab55690eaa85a4ffb189439d180afe6a">converter</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A structure to hold information about a data format. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="304249568a3901900be938de0ddb4d54"></a><!-- doxytag: member="TelEngine::FormatInfo::FormatInfo" ref="304249568a3901900be938de0ddb4d54" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structTelEngine_1_1FormatInfo.html">FormatInfo</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor - used to initialize arrays
</div>
</div><p>
<a class="anchor" name="24d43dde7b7acfe0014e2e545d2065c3"></a><!-- doxytag: member="TelEngine::FormatInfo::FormatInfo" ref="24d43dde7b7acfe0014e2e545d2065c3" args="(const char *_name, int fsize=0, int ftime=10000, const char *_type="audio", int srate=8000, int nchan=1, bool convert=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structTelEngine_1_1FormatInfo.html">FormatInfo</a> </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">int </td>
<td class="paramname"> <em>fsize</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ftime</em> = <code>10000</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>_type</em> = <code>"audio"</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>srate</em> = <code>8000</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nchan</em> = <code>1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>convert</em> = <code>false</code></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>
Normal constructor
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="bc8554f667f2e50a48fbff6faf18b149"></a><!-- doxytag: member="TelEngine::FormatInfo::dataRate" ref="bc8554f667f2e50a48fbff6faf18b149" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int dataRate </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the data rate in bytes/s <dl class="return" compact><dt><b>Returns:</b></dt><dd>Data rate or 0 if variable/undefined </dd></dl>
</div>
</div><p>
<a class="anchor" name="35d1da042d81d9348b022167de84d013"></a><!-- doxytag: member="TelEngine::FormatInfo::guessSamples" ref="35d1da042d81d9348b022167de84d013" args="(int len) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int guessSamples </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>len</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Guess the number of samples in an encoded data block <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data block in octets </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of samples or 0 if unknown </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="ab55690eaa85a4ffb189439d180afe6a"></a><!-- doxytag: member="TelEngine::FormatInfo::converter" ref="ab55690eaa85a4ffb189439d180afe6a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structTelEngine_1_1FormatInfo.html#ab55690eaa85a4ffb189439d180afe6a">converter</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If this is a valid candidate for conversion
</div>
</div><p>
<a class="anchor" name="a3dad37bb3b3c95138a96b2668936923"></a><!-- doxytag: member="TelEngine::FormatInfo::frameSize" ref="a3dad37bb3b3c95138a96b2668936923" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTelEngine_1_1FormatInfo.html#a3dad37bb3b3c95138a96b2668936923">frameSize</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Frame size in octets/frame, 0 for non-framed formats
</div>
</div><p>
<a class="anchor" name="636fa05e7f380226f94d3baf2fe6256e"></a><!-- doxytag: member="TelEngine::FormatInfo::frameTime" ref="636fa05e7f380226f94d3baf2fe6256e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTelEngine_1_1FormatInfo.html#636fa05e7f380226f94d3baf2fe6256e">frameTime</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Frame time in microseconds, 0 for variable
</div>
</div><p>
<a class="anchor" name="8f8f80d37794cde9472343e4487ba3eb"></a><!-- doxytag: member="TelEngine::FormatInfo::name" ref="8f8f80d37794cde9472343e4487ba3eb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structTelEngine_1_1FormatInfo.html#8f8f80d37794cde9472343e4487ba3eb">name</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard no-blanks lowercase format name
</div>
</div><p>
<a class="anchor" name="833642af16b83f234a41e9038ac89aaf"></a><!-- doxytag: member="TelEngine::FormatInfo::numChannels" ref="833642af16b83f234a41e9038ac89aaf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTelEngine_1_1FormatInfo.html#833642af16b83f234a41e9038ac89aaf">numChannels</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of channels, typically 1
</div>
</div><p>
<a class="anchor" name="d16762d495115c2606417076f062c39d"></a><!-- doxytag: member="TelEngine::FormatInfo::sampleRate" ref="d16762d495115c2606417076f062c39d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structTelEngine_1_1FormatInfo.html#d16762d495115c2606417076f062c39d">sampleRate</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Rate in samples/second (audio) or 1e-6 frames/second (video), 0 for unknown
</div>
</div><p>
<a class="anchor" name="763fd8db6bba8fbbbc113ca0d61c47c2"></a><!-- doxytag: member="TelEngine::FormatInfo::type" ref="763fd8db6bba8fbbbc113ca0d61c47c2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structTelEngine_1_1FormatInfo.html#763fd8db6bba8fbbbc113ca0d61c47c2">type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Format type: "audio", "video", "text"
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="yatephone_8h-source.html">yatephone.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:12 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
>
750
