<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: LimiterReader Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classLimiterReader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LimiterReader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This reader limits another reader in start and end times.
<a href="classLimiterReader.html#details">More...</a></p>
<p><code>#include <<a class="el" href="LimiterReader_8h_source.html">LimiterReader.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for LimiterReader:</div>
<div class="dyncontent">
<div class="center"><img src="classLimiterReader__inherit__graph.png" border="0" usemap="#LimiterReader_inherit__map" alt="Inheritance graph"/></div>
<map name="LimiterReader_inherit__map" id="LimiterReader_inherit__map">
<area shape="rect" title="This reader limits another reader in start and end times." alt="" coords="5,155,112,181"/>
<area shape="rect" href="classEffectReader.html" title="This reader is a base class for all effect readers that take one other reader as input." alt="" coords="9,80,109,107"/>
<area shape="rect" href="classIReader.html" title="This class represents a sound source as stream or as buffer which can be read for example by another ..." alt="" coords="24,5,93,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a173663c424dce85ff6dde8ca84bd82f7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLimiterReader.html#a173663c424dce85ff6dde8ca84bd82f7">LimiterReader</a> (std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > reader, float start=0, float end=-1)</td></tr>
<tr class="memdesc:a173663c424dce85ff6dde8ca84bd82f7"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new limiter reader. <a href="#a173663c424dce85ff6dde8ca84bd82f7">More...</a><br /></td></tr>
<tr class="separator:a173663c424dce85ff6dde8ca84bd82f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac436d0ee225a108528569d5039b3685c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLimiterReader.html#ac436d0ee225a108528569d5039b3685c">seek</a> (int position)</td></tr>
<tr class="memdesc:ac436d0ee225a108528569d5039b3685c"><td class="mdescLeft"> </td><td class="mdescRight">Seeks to a specific position in the source. <a href="#ac436d0ee225a108528569d5039b3685c">More...</a><br /></td></tr>
<tr class="separator:ac436d0ee225a108528569d5039b3685c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3096d0840b446584eab6947cb3ceef88"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classLimiterReader.html#a3096d0840b446584eab6947cb3ceef88">getLength</a> () const</td></tr>
<tr class="memdesc:a3096d0840b446584eab6947cb3ceef88"><td class="mdescLeft"> </td><td class="mdescRight">Returns an approximated length of the source in samples. <a href="#a3096d0840b446584eab6947cb3ceef88">More...</a><br /></td></tr>
<tr class="separator:a3096d0840b446584eab6947cb3ceef88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a811778051474eba5659d8988f64f9d3c"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classLimiterReader.html#a811778051474eba5659d8988f64f9d3c">getPosition</a> () const</td></tr>
<tr class="memdesc:a811778051474eba5659d8988f64f9d3c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the position of the source as a sample count value. <a href="#a811778051474eba5659d8988f64f9d3c">More...</a><br /></td></tr>
<tr class="separator:a811778051474eba5659d8988f64f9d3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5142a68e8e108ebc8f3900c33947deb7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLimiterReader.html#a5142a68e8e108ebc8f3900c33947deb7">read</a> (int &length, bool &eos, <a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> *buffer)</td></tr>
<tr class="memdesc:a5142a68e8e108ebc8f3900c33947deb7"><td class="mdescLeft"> </td><td class="mdescRight">Request to read the next length samples out of the source. <a href="#a5142a68e8e108ebc8f3900c33947deb7">More...</a><br /></td></tr>
<tr class="separator:a5142a68e8e108ebc8f3900c33947deb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classEffectReader"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classEffectReader')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classEffectReader.html">EffectReader</a></td></tr>
<tr class="memitem:a2d55c6b9a73180b67a4af6897ab9ad83 inherit pub_methods_classEffectReader"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a2d55c6b9a73180b67a4af6897ab9ad83">EffectReader</a> (std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > reader)</td></tr>
<tr class="memdesc:a2d55c6b9a73180b67a4af6897ab9ad83 inherit pub_methods_classEffectReader"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new effect reader. <a href="classEffectReader.html#a2d55c6b9a73180b67a4af6897ab9ad83">More...</a><br /></td></tr>
<tr class="separator:a2d55c6b9a73180b67a4af6897ab9ad83 inherit pub_methods_classEffectReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e0f0af0c5dbbc0c63dd413c80293af8 inherit pub_methods_classEffectReader"><td class="memItemLeft" align="right" valign="top"><a id="a6e0f0af0c5dbbc0c63dd413c80293af8"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a6e0f0af0c5dbbc0c63dd413c80293af8">~EffectReader</a> ()</td></tr>
<tr class="memdesc:a6e0f0af0c5dbbc0c63dd413c80293af8 inherit pub_methods_classEffectReader"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the reader. <br /></td></tr>
<tr class="separator:a6e0f0af0c5dbbc0c63dd413c80293af8 inherit pub_methods_classEffectReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a633b8c01babc0b8cdfb9bb0b91b2b516 inherit pub_methods_classEffectReader"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a633b8c01babc0b8cdfb9bb0b91b2b516">isSeekable</a> () const</td></tr>
<tr class="memdesc:a633b8c01babc0b8cdfb9bb0b91b2b516 inherit pub_methods_classEffectReader"><td class="mdescLeft"> </td><td class="mdescRight">Tells whether the source provides seeking functionality or not. <a href="classEffectReader.html#a633b8c01babc0b8cdfb9bb0b91b2b516">More...</a><br /></td></tr>
<tr class="separator:a633b8c01babc0b8cdfb9bb0b91b2b516 inherit pub_methods_classEffectReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d82581f492bb2cadf80bd466cb2aec5 inherit pub_methods_classEffectReader"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structSpecs.html">Specs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a3d82581f492bb2cadf80bd466cb2aec5">getSpecs</a> () const</td></tr>
<tr class="memdesc:a3d82581f492bb2cadf80bd466cb2aec5 inherit pub_methods_classEffectReader"><td class="mdescLeft"> </td><td class="mdescRight">Returns the specification of the reader. <a href="classEffectReader.html#a3d82581f492bb2cadf80bd466cb2aec5">More...</a><br /></td></tr>
<tr class="separator:a3d82581f492bb2cadf80bd466cb2aec5 inherit pub_methods_classEffectReader"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classIReader"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classIReader')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classIReader.html">IReader</a></td></tr>
<tr class="memitem:a3489c23855da532dd3a10cfae78bc899 inherit pub_methods_classIReader"><td class="memItemLeft" align="right" valign="top"><a id="a3489c23855da532dd3a10cfae78bc899"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classIReader.html#a3489c23855da532dd3a10cfae78bc899">~IReader</a> ()</td></tr>
<tr class="memdesc:a3489c23855da532dd3a10cfae78bc899 inherit pub_methods_classIReader"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the reader. <br /></td></tr>
<tr class="separator:a3489c23855da532dd3a10cfae78bc899 inherit pub_methods_classIReader"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classEffectReader"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classEffectReader')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classEffectReader.html">EffectReader</a></td></tr>
<tr class="memitem:a798b7d1356bd214d99dd05f521b248aa inherit pro_attribs_classEffectReader"><td class="memItemLeft" align="right" valign="top"><a id="a798b7d1356bd214d99dd05f521b248aa"></a>
std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a798b7d1356bd214d99dd05f521b248aa">m_reader</a></td></tr>
<tr class="memdesc:a798b7d1356bd214d99dd05f521b248aa inherit pro_attribs_classEffectReader"><td class="mdescLeft"> </td><td class="mdescRight">The reader to read from. <br /></td></tr>
<tr class="separator:a798b7d1356bd214d99dd05f521b248aa inherit pro_attribs_classEffectReader"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This reader limits another reader in start and end times. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a173663c424dce85ff6dde8ca84bd82f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a173663c424dce85ff6dde8ca84bd82f7">◆ </a></span>LimiterReader()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LimiterReader::LimiterReader </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>start</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>end</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new limiter reader. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>The reader to read from. </td></tr>
<tr><td class="paramname">start</td><td>The desired start time (inclusive). </td></tr>
<tr><td class="paramname">end</td><td>The desired end time (sample exklusive), a negative value signals that it should play to the end. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3096d0840b446584eab6947cb3ceef88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3096d0840b446584eab6947cb3ceef88">◆ </a></span>getLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int LimiterReader::getLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an approximated length of the source in samples. </p>
<dl class="section return"><dt>Returns</dt><dd>The length as sample count. May be negative if unknown. </dd></dl>
<p>Reimplemented from <a class="el" href="classEffectReader.html#ae628230020b2e85f02a62f8c54fb0983">EffectReader</a>.</p>
</div>
</div>
<a id="a811778051474eba5659d8988f64f9d3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a811778051474eba5659d8988f64f9d3c">◆ </a></span>getPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int LimiterReader::getPosition </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the position of the source as a sample count value. </p>
<dl class="section return"><dt>Returns</dt><dd>The current position in the source. A negative value indicates that the position is unknown. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>The value returned doesn't always have to be correct for readers, especially after seeking. </dd></dl>
<p>Reimplemented from <a class="el" href="classEffectReader.html#af1d48c9edfadd0ea892245975e2c9994">EffectReader</a>.</p>
</div>
</div>
<a id="a5142a68e8e108ebc8f3900c33947deb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5142a68e8e108ebc8f3900c33947deb7">◆ </a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void LimiterReader::read </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"><em>eos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> * </td>
<td class="paramname"><em>buffer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Request to read the next length samples out of the source. </p>
<p>The buffer supplied has the needed size. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">length</td><td>The count of samples that should be read. Shall contain the real count of samples after reading, in case there were only fewer samples available. A smaller value also indicates the end of the reader. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">eos</td><td>End of stream, whether the end is reached or not. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>The pointer to the buffer to read into. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classEffectReader.html#a2c0a347337dc390caec08acb8fde95ba">EffectReader</a>.</p>
</div>
</div>
<a id="ac436d0ee225a108528569d5039b3685c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac436d0ee225a108528569d5039b3685c">◆ </a></span>seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void LimiterReader::seek </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>position</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Seeks to a specific position in the source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>The position to seek for measured in samples. To get from a given time to the samples you simply have to multiply the time value in seconds with the sample rate of the reader. </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>This may work or not, depending on the actual reader. </dd></dl>
<p>Reimplemented from <a class="el" href="classEffectReader.html#a33297aeb697345439f4256fb9ac0e2ba">EffectReader</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fx/<a class="el" href="LimiterReader_8h_source.html">LimiterReader.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
1121
