Commit 751d1dc8 authored by jhammen's avatar jhammen
Browse files

updates from api

parent e256dc41
......@@ -25,13 +25,17 @@ Reads JSON data into a table or object
<h2>Methods</h2>
<table class="summary">
<tr>
<td><a href="#readstringclass">read</a>(<a href="../types/string.html">string</a> json, <i><a href="../types/class.html">class</a> clazz</i>)</td>
<td>parse json from a string and populate into a table or object</td>
</tr>
<tr>
<td><a href="#readIO.Fileclass">read</a>(<a href="../IO/File.html">IO.File</a> file, <i><a href="../types/class.html">class</a> clazz</i>)</td>
<td>parse json from a file and populate into a table or object</td>
</tr>
<tr>
<td><a href="#readstringclass">read</a>(<a href="../types/string.html">string</a> json, <i><a href="../types/class.html">class</a> clazz</i>)</td>
<td>parse json from a string and populate into a table or object</td>
<td><a href="#writeanyIO.File">write</a>(<a href="../types/any.html">any</a> object, <a href="../IO/File.html">IO.File</a> file)</td>
<td>serialize an object to json in a file</td>
</tr>
</table>
......@@ -46,7 +50,19 @@ Reads JSON data into a table or object
<h2>Method Documentation</h2>
<hr/>
<h3><a href="../types/sqobject.html">sqobject</a> <a name="readIO.Fileclass">read</a>(<a href="../IO/File.html">IO.File</a> file, <i><a href="../types/class.html">class</a> clazz</i>)</h3>
<h3><a href="../types/any.html">any</a> <a name="readstringclass">read</a>(<a href="../types/string.html">string</a> json, <i><a href="../types/class.html">class</a> clazz</i>)</h3>
<p>Parse json from a string and populate into a table or object</p>
<h4>Parameters</h4>
<ul>
<li>json (<a href="../types/string.html">string</a>) </li>
<li><i>clazz (<a href="../types/class.html">class</a>) optional</i> </li>
</ul>
<h4>Returns</h4>
<ul>
<li><a href="../types/any.html">any</a></li>
</ul>
<hr/>
<h3><a href="../types/any.html">any</a> <a name="readIO.Fileclass">read</a>(<a href="../IO/File.html">IO.File</a> file, <i><a href="../types/class.html">class</a> clazz</i>)</h3>
<p>Parse json from a file and populate into a table or object.<br/>
<br/>
This method will bind the JSON to a new instance of an existing class if the class definition is given as an optional second parameter.<br/>
......@@ -58,19 +74,15 @@ This method will bind the JSON to a new instance of an existing class if the cla
</ul>
<h4>Returns</h4>
<ul>
<li><a href="../types/sqobject.html">sqobject</a></li>
<li><a href="../types/any.html">any</a></li>
</ul>
<hr/>
<h3><a href="../types/sqobject.html">sqobject</a> <a name="readstringclass">read</a>(<a href="../types/string.html">string</a> json, <i><a href="../types/class.html">class</a> clazz</i>)</h3>
<p>Parse json from a string and populate into a table or object</p>
<h3>void <a name="writeanyIO.File">write</a>(<a href="../types/any.html">any</a> object, <a href="../IO/File.html">IO.File</a> file)</h3>
<p>Serialize an object to json in a file</p>
<h4>Parameters</h4>
<ul>
<li>json (<a href="../types/string.html">string</a>) </li>
<li><i>clazz (<a href="../types/class.html">class</a>) optional</i> </li>
</ul>
<h4>Returns</h4>
<ul>
<li><a href="../types/sqobject.html">sqobject</a></li>
<li>object (<a href="../types/any.html">any</a>) </li>
<li>file (<a href="../IO/File.html">IO.File</a>) </li>
</ul>
<br/><hr/>
......
......@@ -26,7 +26,7 @@ Reads XML data into an object
<h2>Methods</h2>
<table class="summary">
<tr>
<td><a href="#readIO.Fileclass">read</a>(<a href="../IO/File.html">IO.File</a> file, <a href="../types/class.html">class</a> clazz)</td>
<td><a href="#readIO.Fileclass">read</a>(<a href="../IO/File.html">IO.File</a> file, <i><a href="../types/class.html">class</a> clazz</i>)</td>
<td>parse XML from a file and populate into a table or object</td>
</tr>
<tr>
......@@ -46,7 +46,7 @@ Reads XML data into an object
<h2>Method Documentation</h2>
<hr/>
<h3><a href="../types/sqobject.html">sqobject</a> <a name="readIO.Fileclass">read</a>(<a href="../IO/File.html">IO.File</a> file, <a href="../types/class.html">class</a> clazz)</h3>
<h3><a href="../types/any.html">any</a> <a name="readIO.Fileclass">read</a>(<a href="../IO/File.html">IO.File</a> file, <i><a href="../types/class.html">class</a> clazz</i>)</h3>
<p>Parse XML from a file and populate into a table or object.<br/>
<br/>
This method will bind the XML to an instance of an existing class if the class definition is given as an optional second parameter.<br/>
......@@ -54,14 +54,14 @@ This method will bind the XML to an instance of an existing class if the class d
<h4>Parameters</h4>
<ul>
<li>file (<a href="../IO/File.html">IO.File</a>) </li>
<li>clazz (<a href="../types/class.html">class</a>) </li>
<li><i>clazz (<a href="../types/class.html">class</a>) optional</i> </li>
</ul>
<h4>Returns</h4>
<ul>
<li><a href="../types/sqobject.html">sqobject</a></li>
<li><a href="../types/any.html">any</a></li>
</ul>
<hr/>
<h3><a href="../types/sqobject.html">sqobject</a> <a name="readstringclass">read</a>(<a href="../types/string.html">string</a> json, <a href="../types/class.html">class</a> clazz)</h3>
<h3><a href="../types/any.html">any</a> <a name="readstringclass">read</a>(<a href="../types/string.html">string</a> json, <a href="../types/class.html">class</a> clazz)</h3>
<p>Parse XML from a string and populate into a table or object</p>
<h4>Parameters</h4>
<ul>
......@@ -70,7 +70,7 @@ This method will bind the XML to an instance of an existing class if the class d
</ul>
<h4>Returns</h4>
<ul>
<li><a href="../types/sqobject.html">sqobject</a></li>
<li><a href="../types/any.html">any</a></li>
</ul>
<br/><hr/>
......
......@@ -60,17 +60,33 @@ Represents an instance of an LV2 Plugin
<td>set a control value</td>
</tr>
<tr>
<td><a href="#playAudio.Clip">play</a>(<a href="../Audio/Clip.html">Audio.Clip</a> clip)</td>
<td>immediately play an audio clip.</td>
<td><a href="#onWorkResponsefunction">onWorkResponse</a>(<a href="../types/function.html">function</a> handler)</td>
<td></td>
</tr>
<tr>
<td><a href="#playAudio.Buffer">play</a>(<a href="../Audio/Buffer.html">Audio.Buffer</a> buffer)</td>
<td>immediately play an audio buffer.</td>
</tr>
<tr>
<td><a href="#playAudio.Clip">play</a>(<a href="../Audio/Clip.html">Audio.Clip</a> clip)</td>
<td>immediately play an audio clip.</td>
</tr>
<tr>
<td><a href="#presetstring">preset</a>(<a href="../types/string.html">string</a> name)</td>
<td></td>
</tr>
<tr>
<td><a href="#saveStatestring">saveState</a>(<a href="../types/string.html">string</a> path)</td>
<td></td>
</tr>
<tr>
<td><a href="#scheduleAudio.ClipfloatTime.Clock">schedule</a>(<a href="../Audio/Clip.html">Audio.Clip</a> clip, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</td>
<td>schedule an audio clip to play.</td>
</tr>
<tr>
<td><a href="#scheduleLv2.ControlChangefloatTime.Clock">schedule</a>(<a href="../Lv2/ControlChange.html">Lv2.ControlChange</a> change, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</td>
<td>schedule a control value change</td>
</tr>
<tr>
<td><a href="#scheduleMidi.NotefloatTime.Clock">schedule</a>(<a href="../Midi/Note.html">Midi.Note</a> note, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</td>
<td>schedule a MIDI note</td>
......@@ -87,14 +103,6 @@ Represents an instance of an LV2 Plugin
<td><a href="#scheduleAudio.BufferfloatTime.Clock">schedule</a>(<a href="../Audio/Buffer.html">Audio.Buffer</a> buffer, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</td>
<td>schedule an audio buffer to play.</td>
</tr>
<tr>
<td><a href="#scheduleLv2.ControlChangefloatTime.Clock">schedule</a>(<a href="../Lv2/ControlChange.html">Lv2.ControlChange</a> change, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</td>
<td>schedule a control value change</td>
</tr>
<tr>
<td><a href="#scheduleAudio.ClipfloatTime.Clock">schedule</a>(<a href="../Audio/Clip.html">Audio.Clip</a> clip, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</td>
<td>schedule an audio clip to play.</td>
</tr>
</table>
<h2>Constructor Documentation</h2>
......@@ -152,11 +160,11 @@ Represents an instance of an LV2 Plugin
<li>value (<a href="../types/float.html">float</a>) </li>
</ul>
<hr/>
<h3>void <a name="playAudio.Clip">play</a>(<a href="../Audio/Clip.html">Audio.Clip</a> clip)</h3>
<p>Immediately play an audio clip.</p>
<h3>void <a name="onWorkResponsefunction">onWorkResponse</a>(<a href="../types/function.html">function</a> handler)</h3>
<p></p>
<h4>Parameters</h4>
<ul>
<li>clip (<a href="../Audio/Clip.html">Audio.Clip</a>) </li>
<li>handler (<a href="../types/function.html">function</a>) </li>
</ul>
<hr/>
<h3>void <a name="playAudio.Buffer">play</a>(<a href="../Audio/Buffer.html">Audio.Buffer</a> buffer)</h3>
......@@ -165,6 +173,20 @@ Represents an instance of an LV2 Plugin
<ul>
<li>buffer (<a href="../Audio/Buffer.html">Audio.Buffer</a>) </li>
</ul>
<hr/>
<h3>void <a name="playAudio.Clip">play</a>(<a href="../Audio/Clip.html">Audio.Clip</a> clip)</h3>
<p>Immediately play an audio clip.</p>
<h4>Parameters</h4>
<ul>
<li>clip (<a href="../Audio/Clip.html">Audio.Clip</a>) </li>
</ul>
<hr/>
<h3>void <a name="presetstring">preset</a>(<a href="../types/string.html">string</a> name)</h3>
<p></p>
<h4>Parameters</h4>
<ul>
<li>name (<a href="../types/string.html">string</a>) </li>
</ul>
<hr/>
<h3>void <a name="saveStatestring">saveState</a>(<a href="../types/string.html">string</a> path)</h3>
<p></p>
......@@ -173,56 +195,56 @@ Represents an instance of an LV2 Plugin
<li>path (<a href="../types/string.html">string</a>) </li>
</ul>
<hr/>
<h3>void <a name="scheduleMidi.NotefloatTime.Clock">schedule</a>(<a href="../Midi/Note.html">Midi.Note</a> note, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>Schedule a MIDI note</p>
<h3>void <a name="scheduleAudio.ClipfloatTime.Clock">schedule</a>(<a href="../Audio/Clip.html">Audio.Clip</a> clip, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>Schedule an audio clip to play.</p>
<h4>Parameters</h4>
<ul>
<li>note (<a href="../Midi/Note.html">Midi.Note</a>) </li>
<li>clip (<a href="../Audio/Clip.html">Audio.Clip</a>) </li>
<li>measure (<a href="../types/float.html">float</a>) </li>
<li><i>clock (<a href="../Time/Clock.html">Time.Clock</a>) optional</i> </li>
</ul>
<hr/>
<h3>void <a name="scheduleMidi.PatternfloatTime.Clock">schedule</a>(<a href="../Midi/Pattern.html">Midi.Pattern</a> pattern, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>Schedule a MIDI Pattern</p>
<h3>void <a name="scheduleLv2.ControlChangefloatTime.Clock">schedule</a>(<a href="../Lv2/ControlChange.html">Lv2.ControlChange</a> change, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>schedule a control value change</p>
<h4>Parameters</h4>
<ul>
<li>pattern (<a href="../Midi/Pattern.html">Midi.Pattern</a>) </li>
<li>change (<a href="../Lv2/ControlChange.html">Lv2.ControlChange</a>) </li>
<li>measure (<a href="../types/float.html">float</a>) </li>
<li><i>clock (<a href="../Time/Clock.html">Time.Clock</a>) optional</i> </li>
</ul>
<hr/>
<h3>void <a name="scheduleMidi.MessagefloatTime.Clock">schedule</a>(<a href="../Midi/Message.html">Midi.Message</a> message, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>Schedule a MIDI message</p>
<h3>void <a name="scheduleMidi.NotefloatTime.Clock">schedule</a>(<a href="../Midi/Note.html">Midi.Note</a> note, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>Schedule a MIDI note</p>
<h4>Parameters</h4>
<ul>
<li>message (<a href="../Midi/Message.html">Midi.Message</a>) </li>
<li>note (<a href="../Midi/Note.html">Midi.Note</a>) </li>
<li>measure (<a href="../types/float.html">float</a>) </li>
<li><i>clock (<a href="../Time/Clock.html">Time.Clock</a>) optional</i> </li>
</ul>
<hr/>
<h3>void <a name="scheduleAudio.BufferfloatTime.Clock">schedule</a>(<a href="../Audio/Buffer.html">Audio.Buffer</a> buffer, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>Schedule an audio buffer to play.</p>
<h3>void <a name="scheduleMidi.PatternfloatTime.Clock">schedule</a>(<a href="../Midi/Pattern.html">Midi.Pattern</a> pattern, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>Schedule a MIDI Pattern</p>
<h4>Parameters</h4>
<ul>
<li>buffer (<a href="../Audio/Buffer.html">Audio.Buffer</a>) </li>
<li>pattern (<a href="../Midi/Pattern.html">Midi.Pattern</a>) </li>
<li>measure (<a href="../types/float.html">float</a>) </li>
<li><i>clock (<a href="../Time/Clock.html">Time.Clock</a>) optional</i> </li>
</ul>
<hr/>
<h3>void <a name="scheduleLv2.ControlChangefloatTime.Clock">schedule</a>(<a href="../Lv2/ControlChange.html">Lv2.ControlChange</a> change, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>schedule a control value change</p>
<h3>void <a name="scheduleMidi.MessagefloatTime.Clock">schedule</a>(<a href="../Midi/Message.html">Midi.Message</a> message, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>Schedule a MIDI message</p>
<h4>Parameters</h4>
<ul>
<li>change (<a href="../Lv2/ControlChange.html">Lv2.ControlChange</a>) </li>
<li>message (<a href="../Midi/Message.html">Midi.Message</a>) </li>
<li>measure (<a href="../types/float.html">float</a>) </li>
<li><i>clock (<a href="../Time/Clock.html">Time.Clock</a>) optional</i> </li>
</ul>
<hr/>
<h3>void <a name="scheduleAudio.ClipfloatTime.Clock">schedule</a>(<a href="../Audio/Clip.html">Audio.Clip</a> clip, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>Schedule an audio clip to play.</p>
<h3>void <a name="scheduleAudio.BufferfloatTime.Clock">schedule</a>(<a href="../Audio/Buffer.html">Audio.Buffer</a> buffer, <a href="../types/float.html">float</a> measure, <i><a href="../Time/Clock.html">Time.Clock</a> clock</i>)</h3>
<p>Schedule an audio buffer to play.</p>
<h4>Parameters</h4>
<ul>
<li>clip (<a href="../Audio/Clip.html">Audio.Clip</a>) </li>
<li>buffer (<a href="../Audio/Buffer.html">Audio.Buffer</a>) </li>
<li>measure (<a href="../types/float.html">float</a>) </li>
<li><i>clock (<a href="../Time/Clock.html">Time.Clock</a>) optional</i> </li>
</ul>
......
......@@ -17,6 +17,10 @@ A MIDI system input.
<td><a href="#ctorstringstring">Input</a>(<a href="../types/string.html">string</a> name, <i><a href="../types/string.html">string</a> connection</i>)</td>
<td></td>
</tr>
<tr>
<td><a href="#ctorstringregex">Input</a>(<a href="../types/string.html">string</a> name, <a href="../types/regex.html">regex</a> connection)</td>
<td></td>
</tr>
</table>
<h2>Properties</h2>
<table class="summary">
......@@ -55,6 +59,14 @@ A MIDI system input.
<li>name (<a href="../types/string.html">string</a>) </li>
<li><i>connection (<a href="../types/string.html">string</a>) optional</i> </li>
</ul>
<hr/>
<h3><a name="ctorstringregex">Input</a>(<a href="../types/string.html">string</a> name, <a href="../types/regex.html">regex</a> connection)</h3>
<p></p>
<h4>Parameters</h4>
<ul>
<li>name (<a href="../types/string.html">string</a>) The name of the new input as it will show in the audio system.</li>
<li>connection (<a href="../types/regex.html">regex</a>) The new Output will connect to every external client in the audio system whose name matches the regex</li>
</ul>
<h2>Property Documentation</h2>
<hr/>
<h3><a href="../types/array.html">array</a> <a name="propmidiout">midiout</a></h3>
......
<html>
<!-- This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. -->
<head>
<title>Class Midi.NoteEvent</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../api.css" type="text/css"/>
</head>
<body>
<h1>Class Midi.NoteEvent</h1>
<h2>Properties</h2>
<table class="summary">
<tr>
<td><a href="#propmeasure">measure</a></td>
<td></td>
</tr>
<tr>
<td><a href="#propnote">note</a></td>
<td></td>
</tr>
</table>
<h2>Property Documentation</h2>
<hr/>
<h3><a href="../types/float.html">float</a> <a name="propmeasure">measure</a></h3>
<p></p>
<hr/>
<h3><a href="../Midi/Note.html">Midi.Note</a> <a name="propnote">note</a></h3>
<p></p>
<br/><hr/>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">
<img alt="Creative Commons Logo" style="float:right;border-width:0" src="../cc-by-nc-sa.png" /></a>
<span class="fineprint">This work is licensed under a <a rel="license"
href="http://creativecommons.org/licenses/by-nc-sa/4.0/">
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.</span>
</body>
</html>
......@@ -29,6 +29,10 @@ A timed collection of MIDI notes.
<td><a href="#addMidi.Notefloat">add</a>(<a href="../Midi/Note.html">Midi.Note</a> note, <a href="../types/float.html">float</a> measure)</td>
<td>add a Midi.Note to this pattern.</td>
</tr>
<tr>
<td><a href="#len">len</a>()</td>
<td></td>
</tr>
<tr>
<td><a href="#noteinteger">note</a>(<a href="../types/integer.html">integer</a> index)</td>
<td>return the note at the given index</td>
......@@ -69,6 +73,13 @@ A timed collection of MIDI notes.
<li>note (<a href="../Midi/Note.html">Midi.Note</a>) </li>
<li>measure (<a href="../types/float.html">float</a>) </li>
</ul>
<hr/>
<h3><a href="../types/integer.html">integer</a> <a name="len">len</a>()</h3>
<p></p>
<h4>Returns</h4>
<ul>
<li><a href="../types/integer.html">integer</a></li>
</ul>
<hr/>
<h3><a href="../Midi/Note.html">Midi.Note</a> <a name="noteinteger">note</a>(<a href="../types/integer.html">integer</a> index)</h3>
<p>Return the note at the given index</p>
......
......@@ -95,6 +95,11 @@ package for creating and scheduling MIDI events
<td>a single MIDI note.</td>
</tr>
<tr>
<td><a href="./NoteEvent.html">Midi.NoteEvent</a></td>
<td></td>
</tr>
<tr>
<td><a href="./NoteOff.html">Midi.NoteOff</a></td>
<td>a single MIDI note off message.</td>
......
......@@ -105,7 +105,7 @@ An OSC message.
<li>value (<a href="../types/string.html">string</a>) </li>
</ul>
<hr/>
<h3><a href="../types/sqobject.html">sqobject</a> <a name="arginteger">arg</a>(<a href="../types/integer.html">integer</a> index)</h3>
<h3><a href="../types/any.html">any</a> <a name="arginteger">arg</a>(<a href="../types/integer.html">integer</a> index)</h3>
<p>Returns the argument at the given index.</p>
<h4>Parameters</h4>
<ul>
......@@ -113,7 +113,7 @@ An OSC message.
</ul>
<h4>Returns</h4>
<ul>
<li><a href="../types/sqobject.html">sqobject</a></li>
<li><a href="../types/any.html">any</a></li>
</ul>
<hr/>
<h3><a href="../types/integer.html">integer</a> <a name="args">args</a>()</h3>
......
......@@ -7,7 +7,7 @@
</head>
<body>
<h1>any</h1>
Parameters marked as "any" can take all possible types, e.g. primitives, tables, arrays, or class instances
Values marked as "any" can take any type, e.g. primitives, tables, arrays, or class instances
<br/><hr/>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">
<img alt="Creative Commons Logo" style="float:right;border-width:0" src="../cc-by-nc-sa.png" /></a>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment