mirror of
https://github.com/thestk/stk
synced 2026-01-14 05:21:53 +00:00
77 lines
5.8 KiB
HTML
77 lines
5.8 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_1Effect.html">Effect</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Effect Class Reference</h1><!-- doxytag: class="stk::Effect" --><!-- doxytag: inherits="stk::Stk" -->STK abstract effects parent class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Effect_8h-source.html">Effect.h</a>></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Effect:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1Effect.png" usemap="#stk::Effect_map" border="0" alt=""></center>
|
|
<map name="stk::Effect_map">
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="225,0,305,24">
|
|
<area href="classstk_1_1Chorus.html" alt="stk::Chorus" shape="rect" coords="0,112,80,136">
|
|
<area href="classstk_1_1Echo.html" alt="stk::Echo" shape="rect" coords="90,112,170,136">
|
|
<area href="classstk_1_1JCRev.html" alt="stk::JCRev" shape="rect" coords="180,112,260,136">
|
|
<area href="classstk_1_1NRev.html" alt="stk::NRev" shape="rect" coords="270,112,350,136">
|
|
<area href="classstk_1_1PitShift.html" alt="stk::PitShift" shape="rect" coords="360,112,440,136">
|
|
<area href="classstk_1_1PRCRev.html" alt="stk::PRCRev" shape="rect" coords="450,112,530,136">
|
|
</map>
|
|
</div>
|
|
|
|
<p>
|
|
<a href="classstk_1_1Effect-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="f6eb27819aed132dd1edf2ce9640893e"></a><!-- doxytag: member="stk::Effect::Effect" ref="f6eb27819aed132dd1edf2ce9640893e" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Effect.html#f6eb27819aed132dd1edf2ce9640893e">Effect</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bfdef9ce644c251607acfd183e3d7f7b"></a><!-- doxytag: member="stk::Effect::channelsOut" ref="bfdef9ce644c251607acfd183e3d7f7b" args="(void) const " -->
|
|
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Effect.html#bfdef9ce644c251607acfd183e3d7f7b">channelsOut</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of output channels for the class. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d7e2b8942bf7adcc71dfc6dccbb7aa0"></a><!-- doxytag: member="stk::Effect::lastFrame" ref="3d7e2b8942bf7adcc71dfc6dccbb7aa0" args="(void) const " -->
|
|
const <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Effect.html#3d7e2b8942bf7adcc71dfc6dccbb7aa0">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 output sample frame. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0598128d1edc97729951310cc5df5171"></a><!-- doxytag: member="stk::Effect::clear" ref="0598128d1edc97729951310cc5df5171" args="()=0" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Effect.html#0598128d1edc97729951310cc5df5171">clear</a> ()=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4facbc9b317f18c139577e52fd69c3d"></a><!-- doxytag: member="stk::Effect::setEffectMix" ref="b4facbc9b317f18c139577e52fd69c3d" args="(StkFloat mix)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Effect.html#b4facbc9b317f18c139577e52fd69c3d">setEffectMix</a> (StkFloat mix)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the mixture of input and "effected" levels in the output (0.0 = input only, 1.0 = effect only). <br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK abstract effects parent class.
|
|
<p>
|
|
This class provides common functionality for STK effects subclasses. It is general enough to support both monophonic and polyphonic input/output classes.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Effect_8h-source.html">Effect.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>
|