DISTRHO
/
DISTRHO-Ports-Extra
mirror of https://github.com/DISTRHO/DISTRHO-Ports-Extra


			
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>protoplug: Module stereoFx</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<a href="http://osar.fr">
<div class=osarlogo> </div>
</a>
<br/>
<a href="http://osar.fr/protoplug">
<h1>protoplug</h1>
</a>
	<span class="proto_subtitle">Lua API reference</span>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>

<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Class_stereoFx_Channel">Class stereoFx.Channel </a></li>
</ul>


<h2>Modules</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
  <li><a href="../modules/plugin.html">plugin</a></li>
  <li><a href="../modules/script.html">script</a></li>
  <li><a href="../modules/midi.html">midi</a></li>
  <li><a href="../modules/gui.html">gui</a></li>
  <li><a href="../modules/polyGen.html">polyGen</a></li>
  <li><strong>stereoFx</strong></li>
</ul>
<h2>Classes</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
  <li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li>
  <li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li>
  <li><a href="../classes/juce.Colour.html">juce.Colour</a></li>
  <li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li>
  <li><a href="../classes/juce.Component.html">juce.Component</a></li>
  <li><a href="../classes/juce.FillType.html">juce.FillType</a></li>
  <li><a href="../classes/juce.Font.html">juce.Font</a></li>
  <li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li>
  <li><a href="../classes/juce.Image.html">juce.Image</a></li>
  <li><a href="../classes/juce.Justification.html">juce.Justification</a></li>
  <li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li>
  <li><a href="../classes/juce.Line.html">juce.Line</a></li>
  <li><a href="../classes/juce.Path.html">juce.Path</a></li>
  <li><a href="../classes/juce.Point.html">juce.Point</a></li>
  <li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li>
  <li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li>
  <li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li>
</ul>
<h2>Examples</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
  <li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li>
  <li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li>
  <li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li>
  <li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li>
  <li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li>
</ul>

</div>

<div id="content">

<h1>Module <code>stereoFx</code></h1>
<p>Use this module to create a stereo effect.</p>
<p>

<p> Example at <a href="../examples/classic-filter.lua.html#">classic-filter.lua</a>.</p>

<p> This module acts as a layer that conceals the <a href="../modules/plugin.html#processBlock">plugin.processBlock</a> function,
 manages stereo channels, and exposes the <a href="../modules/stereoFx.html#stereoFx.Channel">stereoFx.Channel</a>  prototype for you
 define per-channel audio processing. Initialize it by calling <a href="../modules/stereoFx.html#init">stereoFx.init</a> .</p>

<p> The <a href="../modules/stereoFx.html#">stereoFx</a>  global is available to every protoplug script after including the
 main protoplug header :</p>
<pre><code>require "include/protoplug"
</code></pre>
</p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#init"><span class="proto_prefix">stereoFx</span>.init ()</a></td>
	<td class="summary">Set up channels.</td>
	</tr>
</table>
<h2><a href="#Class_stereoFx_Channel">Class stereoFx.Channel </a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#Channel:processBlock"><span class="proto_prefix">stereoFx.Channel</span>:processBlock (samples, smax)</a></td>
	<td class="summary">Override to process a channel's audio block.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#Channel:init"><span class="proto_prefix">stereoFx.Channel</span>:init ()</a></td>
	<td class="summary">Override to handle initialisation.</td>
	</tr>
</table>

<br/>
<br/>


    <h2><a name="Functions"></a>Functions</h2>
    <dl class="function">
    <dt>
    <a name = "init"></a>
    <strong><span class="proto_prefix">stereoFx</span>.init ()</strong>
    </dt>
    <dd>
    Set up channels.
 This function must be called by any script that wishes to use this module.

    </ul>


</dd>
</dl>
    <h2><a name="Class_stereoFx_Channel"></a>Class stereoFx.Channel </h2>

 This class represents a channel (ie. left or right).
 <br><br>
    <dl class="function">
    <dt>
    <a name = "Channel:processBlock"></a>
    <strong><span class="proto_prefix">stereoFx.Channel</span>:processBlock (samples, smax)</strong>
    </dt>
    <dd>
    Override to process a channel's audio block.
 Define the audio processing of a single channel in this function.

    </ul>

    <h3>Parameters:</h3>
    <ul>
        <li><span class="parameter">samples</span>
         a C float* serving as input and output
        </li>
        <li><span class="parameter">smax</span>
         the maximum sample index (nSamples - 1)
        </li>
    </ul>


</dd>
    <dt>
    <a name = "Channel:init"></a>
    <strong><span class="proto_prefix">stereoFx.Channel</span>:init ()</strong>
    </dt>
    <dd>
    Override to handle initialisation.
 Override this method to perform initialisation tasks on each channel,
 for example to create any per-channel fields.

    </ul>


</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>