File: classstk_1_1WvIn.html

package info (click to toggle)
stk 4.4.4-5
links: PTS, VCS
area: main
in suites: jessie-kfreebsd
size: 24,856 kB
sloc: cpp: 33,976; tcl: 2,375; sh: 2,319; ansic: 163; perl: 114; makefile: 37
file content (91 lines) | stat: -rw-r--r-- 6,462 bytes
parent folder | download | duplicates (2)
<HTML>
<HEAD>
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.6.2 -->
  <div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1WvIn.html">WvIn</a>
  </div>
<div class="contents">
<h1>stk::WvIn Class Reference</h1><!-- doxytag: class="stk::WvIn" --><!-- doxytag: inherits="stk::Stk" -->
<p>STK audio input abstract base class.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="WvIn_8h_source.html">WvIn.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::WvIn:</div>
<div class="dynsection">
 <div class="center">
  <img src="classstk_1_1WvIn.png" usemap="#stk::WvIn_map" alt=""/>
  <map id="stk::WvIn_map" name="stk::WvIn_map">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="92,0,174,24"/>
<area href="classstk_1_1FileWvIn.html" alt="stk::FileWvIn" shape="rect" coords="0,112,82,136"/>
<area href="classstk_1_1InetWvIn.html" alt="stk::InetWvIn" shape="rect" coords="92,112,174,136"/>
<area href="classstk_1_1RtWvIn.html" alt="stk::RtWvIn" shape="rect" coords="184,112,266,136"/>
<area href="classstk_1_1FileLoop.html" alt="stk::FileLoop" shape="rect" coords="0,168,82,192"/>
</map>
 </div>
</div>

<p><a href="classstk_1_1WvIn-members.html">List of all members.</a></p>
<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="a2ce05e5c8087e483236961335e8abf04"></a><!-- doxytag: member="stk::WvIn::channelsOut" ref="a2ce05e5c8087e483236961335e8abf04" args="(void) const " -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvIn.html#a2ce05e5c8087e483236961335e8abf04">channelsOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of audio channels in the data or stream. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvIn.html#a3ab86e33eff9f962c9ef7b41e3ccb77e">lastFrame</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return an <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> reference to the last computed sample frame.  <a href="#a3ab86e33eff9f962c9ef7b41e3ccb77e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0eda243730408a434856fffed776931e"></a><!-- doxytag: member="stk::WvIn::tick" ref="a0eda243730408a434856fffed776931e" args="(unsigned int channel=0)=0" -->
virtual StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvIn.html#a0eda243730408a434856fffed776931e">tick</a> (unsigned int channel=0)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute one sample frame and return the specified <code>channel</code> value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76718752b0cc1ab767ba4e70d72b9453"></a><!-- doxytag: member="stk::WvIn::tick" ref="a76718752b0cc1ab767ba4e70d72b9453" args="(StkFrames &amp;frames)=0" -->
virtual <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvIn.html#a76718752b0cc1ab767ba4e70d72b9453">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument with computed frames and return the same reference. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK audio input abstract base class. </p>
<p>This class provides common functionality for a variety of audio data input subclasses.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3ab86e33eff9f962c9ef7b41e3ccb77e"></a><!-- doxytag: member="stk::WvIn::lastFrame" ref="a3ab86e33eff9f962c9ef7b41e3ccb77e" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a>&amp; stk::WvIn::lastFrame </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return an <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> reference to the last computed sample frame. </p>
<p>If no file data is loaded, an empty container is returned. </p>

<p><div class="fragment"><pre class="fragment"><a name="l00029"></a>00029 { <span class="keywordflow">return</span> lastFrame_; };
</pre></div></p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="WvIn_8h_source.html">WvIn.h</a></li>
</ul>
</div>
<HR>

<table>
  <tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
  <tr><td>&copy;1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>

</BODY>
</HTML>