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 Lua API Reference</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>


<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><a href="modules/stereoFx.html">stereoFx</a></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">


  <h2>Protoplug Lua API Reference</h2>

<h2>Modules</h2>
<table class="module_list">
	<tr>
		<td class="name"  nowrap><a href="modules/plugin.html">plugin</a></td>
		<td class="summary">Use <a href="modules/plugin.html#">plugin</a>  to define the AU/VST audio plugin's behaviour.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="modules/script.html">script</a></td>
		<td class="summary">Use <a href="modules/script.html#">script</a>  to handle script events, libraries and files.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="modules/midi.html">midi</a></td>
		<td class="summary"><a href="modules/midi.html#">midi</a>  contains MIDI-related classes and functions.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="modules/gui.html">gui</a></td>
		<td class="summary">Use <a href="modules/gui.html#">gui</a>  to define your script's custom graphical user interface.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="modules/polyGen.html">polyGen</a></td>
		<td class="summary">Use this module to create a polyphonic generator with virtual tracks.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="modules/stereoFx.html">stereoFx</a></td>
		<td class="summary">Use this module to create a stereo effect.</td>
	</tr>
</table>
<h2>Classes</h2>
<table class="module_list">
	<tr>
		<td class="name"  nowrap><a href="classes/juce.AffineTransform.html">juce.AffineTransform</a></td>
		<td class="summary">A geometric transformation.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></td>
		<td class="summary">Class to read audio files.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.Colour.html">juce.Colour</a></td>
		<td class="summary">A simple colour class.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.ColourGradient.html">juce.ColourGradient</a></td>
		<td class="summary">Colour Gradient.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.Component.html">juce.Component</a></td>
		<td class="summary">JUCE Component.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.FillType.html">juce.FillType</a></td>
		<td class="summary">Fill Type.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.Font.html">juce.Font</a></td>
		<td class="summary">Font.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.Graphics.html">juce.Graphics</a></td>
		<td class="summary">Graphics drawing target.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.Image.html">juce.Image</a></td>
		<td class="summary">Image.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.Justification.html">juce.Justification</a></td>
		<td class="summary">Justification.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></td>
		<td class="summary">Lagrange Interpolator.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.Line.html">juce.Line</a></td>
		<td class="summary">Line.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.Path.html">juce.Path</a></td>
		<td class="summary">Path.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.Point.html">juce.Point</a></td>
		<td class="summary">Point.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></td>
		<td class="summary">Rectangle Placement.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.Rectangle_float.html">juce.Rectangle_float</a></td>
		<td class="summary">A floating-point (sub-pixel) rectangle.</td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="classes/juce.Rectangle_int.html">juce.Rectangle_int</a></td>
		<td class="summary">An integer (pixel-aligned) rectangle.</td>
	</tr>
</table>
<h2>Examples</h2>
<table class="module_list">
	<tr>
		<td class="name"  nowrap><a href="examples/classic-filter.lua.html">classic-filter.lua</a></td>
		<td class="summary"></td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="examples/sine-organ.lua.html">sine-organ.lua</a></td>
		<td class="summary"></td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="examples/midi-chordify.lua.html">midi-chordify.lua</a></td>
		<td class="summary"></td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></td>
		<td class="summary"></td>
	</tr>
	<tr>
		<td class="name"  nowrap><a href="examples/soundfile-test.lua.html">soundfile-test.lua</a></td>
		<td class="summary"></td>
	</tr>
</table>

</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>