/usr/share/doc/libucommon-dev/a00024.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | <!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>UCommon: ucc::audio::framer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.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>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00023.html">audio</a>::<a class="el" href="a00024.html">framer</a>
</div>
</div>
<div class="contents">
<h1>ucc::audio::framer Class Reference</h1><!-- doxytag: class="ucc::audio::framer" -->
<p>Common access to audio frames.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00187_source.html">audio.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::audio::framer:</div>
<div class="dynsection">
<div class="center"><img src="a00349.png" border="0" usemap="#ucc_1_1audio_1_1framer_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1audio_1_1framer_inherit__map" id="ucc_1_1audio_1_1framer_inherit__map">
<area shape="rect" id="node3" href="a00025.html" title="Generic audio buffering and transcoding for audio sources and sinks." alt="" coords="60,83,183,112"/><area shape="rect" id="node5" href="a00027.html" title="Basic audio file access class." alt="" coords="5,160,109,189"/><area shape="rect" id="node7" href="a00173.html" title="Tone generator class for producing convertable tones." alt="" coords="133,160,237,189"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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"><a class="anchor" id="a94c7c26bf8acfa732244aec14543bbae"></a><!-- doxytag: member="ucc::audio::framer::append" ref="a94c7c26bf8acfa732244aec14543bbae" args="(void)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>append</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a059910467654631625dffe1d85fea4eb"></a><!-- doxytag: member="ucc::audio::framer::buf" ref="a059910467654631625dffe1d85fea4eb" args="(void)" -->
virtual encoded_t </td><td class="memItemRight" valign="bottom"><b>buf</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c04cf90d448cf8f068fcf2204612afa"></a><!-- doxytag: member="ucc::audio::framer::fill" ref="a0c04cf90d448cf8f068fcf2204612afa" args="(void)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>fill</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e14d2709b1ed53f1e35613154bb86b8"></a><!-- doxytag: member="ucc::audio::framer::flush" ref="a6e14d2709b1ed53f1e35613154bb86b8" args="(void)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>flush</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7002938a757a7834627b81c0e9be4ab7"></a><!-- doxytag: member="ucc::audio::framer::framesize" ref="a7002938a757a7834627b81c0e9be4ab7" args="(encoded_t data)=0" -->
virtual unsigned </td><td class="memItemRight" valign="bottom"><b>framesize</b> (encoded_t data)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae618f0636d6e7441b2cd5538822084a4"></a><!-- doxytag: member="ucc::audio::framer::framesize" ref="ae618f0636d6e7441b2cd5538822084a4" args="(void)=0" -->
virtual unsigned </td><td class="memItemRight" valign="bottom"><b>framesize</b> (void)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a726d4311e1cac62c776ffc94311a051d"></a><!-- doxytag: member="ucc::audio::framer::frametime" ref="a726d4311e1cac62c776ffc94311a051d" args="(void)=0" -->
virtual <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><b>frametime</b> (void)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a446aaa1e7c5eba1e516fef19bf236448"></a><!-- doxytag: member="ucc::audio::framer::get" ref="a446aaa1e7c5eba1e516fef19bf236448" args="(encoded_t data)" -->
virtual unsigned </td><td class="memItemRight" valign="bottom"><b>get</b> (encoded_t data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa371feb2d76cb10e2e5ed5e8cd016607"></a><!-- doxytag: member="ucc::audio::framer::get" ref="aa371feb2d76cb10e2e5ed5e8cd016607" args="(void)" -->
virtual encoded_t </td><td class="memItemRight" valign="bottom"><b>get</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac720b8b15123222725e254b51f36e359"></a><!-- doxytag: member="ucc::audio::framer::length" ref="ac720b8b15123222725e254b51f36e359" args="(void)" -->
virtual <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><b>length</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0db31a3b6e183fd98eea399b2b84c411"></a><!-- doxytag: member="ucc::audio::framer::locate" ref="a0db31a3b6e183fd98eea399b2b84c411" args="(void)" -->
virtual <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><b>locate</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a89343595d59003cc09d3034b563f5d"></a><!-- doxytag: member="ucc::audio::framer::operator bool" ref="a9a89343595d59003cc09d3034b563f5d" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb0c22c82992eaa9d81f54fb1b2fcf03"></a><!-- doxytag: member="ucc::audio::framer::pull" ref="acb0c22c82992eaa9d81f54fb1b2fcf03" args="(encoded_t data, unsigned size)" -->
virtual unsigned </td><td class="memItemRight" valign="bottom"><b>pull</b> (encoded_t data, unsigned size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c1c5e99e7d17feec7e00eec363e72ae"></a><!-- doxytag: member="ucc::audio::framer::push" ref="a6c1c5e99e7d17feec7e00eec363e72ae" args="(encoded_t data, unsigned size)" -->
virtual unsigned </td><td class="memItemRight" valign="bottom"><b>push</b> (encoded_t data, unsigned size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac868fa1c40dbef06b84d9a2aafe15910"></a><!-- doxytag: member="ucc::audio::framer::put" ref="ac868fa1c40dbef06b84d9a2aafe15910" args="(void)" -->
virtual unsigned </td><td class="memItemRight" valign="bottom"><b>put</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14fc284bbbe5730b057485b008611201"></a><!-- doxytag: member="ucc::audio::framer::put" ref="a14fc284bbbe5730b057485b008611201" args="(encoded_t data)" -->
virtual unsigned </td><td class="memItemRight" valign="bottom"><b>put</b> (encoded_t data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e62d1bb00ff3e5ab8859b24cdc721c8"></a><!-- doxytag: member="ucc::audio::framer::release" ref="a9e62d1bb00ff3e5ab8859b24cdc721c8" args="(void)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>release</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf5f95737805062cb66bcae14f85f3b0"></a><!-- doxytag: member="ucc::audio::framer::rewind" ref="abf5f95737805062cb66bcae14f85f3b0" args="(void)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>rewind</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a570a950a7021c9d2809610f52c6a8309"></a><!-- doxytag: member="ucc::audio::framer::seek" ref="a570a950a7021c9d2809610f52c6a8309" args="(timeout_t position)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>seek</b> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> position)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afae582b3541bc3393b8ab46e0c64f191"></a><!-- doxytag: member="ucc::audio::framer::skip" ref="afae582b3541bc3393b8ab46e0c64f191" args="(timeout_t offset)" -->
virtual <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><b>skip</b> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> offset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6fe2a89385c269cfaf6b1cd9a19b9be"></a><!-- doxytag: member="ucc::audio::framer::status" ref="ad6fe2a89385c269cfaf6b1cd9a19b9be" args="(void)" -->
state_t </td><td class="memItemRight" valign="bottom"><b>status</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a402014dad3edcbf8573ef214642c0296"></a><!-- doxytag: member="ucc::audio::framer::trim" ref="a402014dad3edcbf8573ef214642c0296" args="(timeout_t backup=0)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>trim</b> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> backup=0)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a630d8b96b7e920846bb17e32c1d58554"></a><!-- doxytag: member="ucc::audio::framer::state" ref="a630d8b96b7e920846bb17e32c1d58554" args="" -->
state_t </td><td class="memItemRight" valign="bottom"><b>state</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Common access to audio frames. </p>
<p>This offers access to and manipulation of audio media sources such as files, devices, and streams. Most audio sources are optimally accessed in dsp frames, and hence this class is optimized for frame oriented access to media. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l00054">54</a> of file <a class="el" href="a00187_source.html">audio.h</a>.</p>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00187_source.html">audio.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:24 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|