mirror of
https://github.com/thestk/stk
synced 2026-01-14 21:41:53 +00:00
89 lines
5.4 KiB
HTML
89 lines
5.4 KiB
HTML
<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"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
|
|
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.5.8 -->
|
|
<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" -->STK audio input abstract base class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="WvIn_8h-source.html">WvIn.h</a>></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::WvIn:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1WvIn.png" usemap="#stk::WvIn_map" border="0" alt=""></center>
|
|
<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>
|
|
|
|
<p>
|
|
<a href="classstk_1_1WvIn-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"><a class="anchor" name="2ce05e5c8087e483236961335e8abf04"></a><!-- doxytag: member="stk::WvIn::channelsOut" ref="2ce05e5c8087e483236961335e8abf04" args="(void) const " -->
|
|
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvIn.html#2ce05e5c8087e483236961335e8abf04">channelsOut</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of audio channels in the data or stream. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvIn.html#3ab86e33eff9f962c9ef7b41e3ccb77e">lastFrame</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="#3ab86e33eff9f962c9ef7b41e3ccb77e"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0eda243730408a434856fffed776931e"></a><!-- doxytag: member="stk::WvIn::tick" ref="0eda243730408a434856fffed776931e" args="(unsigned int channel=0)=0" -->
|
|
virtual StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1WvIn.html#0eda243730408a434856fffed776931e">tick</a> (unsigned int channel=0)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute one sample frame and return the specified <code>channel</code> value. <br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK audio input abstract base class.
|
|
<p>
|
|
This class provides common functionality for a variety of audio data input subclasses.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="3ab86e33eff9f962c9ef7b41e3ccb77e"></a><!-- doxytag: member="stk::WvIn::lastFrame" ref="3ab86e33eff9f962c9ef7b41e3ccb77e" 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>& stk::WvIn::lastFrame </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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>
|
|
If no file data is loaded, an empty container is returned.
|
|
</div>
|
|
</div><p>
|
|
<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></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>©1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|