| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|
| 2 | <html>
|
|---|
| 3 | <head>
|
|---|
| 4 | <meta http-equiv="content-type" content="text/html;charset=ISO-8859-1">
|
|---|
| 5 | <title> jmod.syn.1 </title>
|
|---|
| 6 | <style type="text/css">
|
|---|
| 7 | body { margin: 0px; font-family: Arial, Helvetica, sans-serif;}
|
|---|
| 8 | h1 { font-size: 24px; font-weight:100; padding-top: 1em; margin: 0;}
|
|---|
| 9 | h2 { font-size: 18px; font-weight:200; margin: 0; color: #555; text-transform: lowercase;}
|
|---|
| 10 | h3 { color: #888; border-bottom: 1px solid #333; font-size: 18px; font-weight:100; margin-top: 20px; margin-bottom: 10px; margin-left: 2%; margin-right: 2%;}
|
|---|
| 11 | h4{ color: #333; font-size: 14px; font-weight: bold; margin-bottom: 0px; margin-left: 2%; margin-right: 2%;}
|
|---|
| 12 | h6 { font-size: 12px; font-weight:100; line-height: 1.2; margin-right: 2%; margin-left: 2%;}
|
|---|
| 13 | p { font-size: 12px; font-weight:100; margin: 5px 2%; padding-bottom: 1em;}
|
|---|
| 14 | ul{ margin-top:0; padding-top:0;}
|
|---|
| 15 | li { font-size: 12px; font-weight:100; margin-top: 0; margin-left: 10px; padding: 0em 0em 0.3em;}
|
|---|
| 16 | img { padding: 10px 10px 0px 0px;}
|
|---|
| 17 | #jmod_header{ display: block; margin: 0 0 40px 0;}#jmod_header img{ float: left;}.objectname { font-size: 24px; font-weight: bold;}
|
|---|
| 18 | .moduleName { font-size: 2em; background-color: #c5c5c5; text-align: right; vertical-align: top; font-weight: bold;}
|
|---|
| 19 | .moduleDescription { font-size: 1em; background-color: #000000; color: #c5c5c5; text-align: right; vertical-align: top;}
|
|---|
| 20 |
|
|---|
| 21 |
|
|---|
| 22 | .tableHeading2 { background-color: #eee; text-align: left; vertical-align: top; font-weight:bold; font-size: 12px;}
|
|---|
| 23 | table { border: 0px; width: 96%; margin-top: 10px; margin-bottom: 10px; margin-left: 2%; font-size: 12px;}
|
|---|
| 24 | .instructionName { font-family: 'Courier New', Courier, mono; background-color: #eed; vertical-align: top; }
|
|---|
| 25 | .instructionType { font-family: 'Times New Roman', Times, serif; background-color: #eee; vertical-align: top;}
|
|---|
| 26 | .instructionDataspace { font-family: 'Times New Roman', Times, serif; background-color: #eed; vertical-align: top; padding: 0;}
|
|---|
| 27 | .instructionRangeBounds { font-family: 'Times New Roman', Times, serif; background-color: #eee; vertical-align: top;}
|
|---|
| 28 | .instructionRangeClipmode { font-family: 'Times New Roman', Times, serif; background-color: #eed; vertical-align: top;}
|
|---|
| 29 | .instructionRampDrive { font-family: 'Times New Roman', Times, serif; background-color: #eee; vertical-align: top;}
|
|---|
| 30 | .instructionRampFunction { font-family: 'Times New Roman', Times, serif; background-color: #eed; vertical-align: top;}
|
|---|
| 31 | .instructionRepetitionsAllow { font-family: 'Times New Roman', Times, serif; background-color: #eee; vertical-align: top;}
|
|---|
| 32 | .instructionDescription { font-family: 'Times New Roman', Times, serif; background-color: #eed; vertical-align: top;}
|
|---|
| 33 | !td { padding-right: 0.5em; padding-left: 0.5em;}
|
|---|
| 34 | ul { list-style-type: disc;}
|
|---|
| 35 | .patchimage { clear: both;}
|
|---|
| 36 | .comment { color: #6666FF;}
|
|---|
| 37 | .smallTable { width: 400px; border: none;}
|
|---|
| 38 | caption { font-size: 11px; font-style: italic;}
|
|---|
| 39 | .filepath { font-family: 'Courier New', Courier, mono;}
|
|---|
| 40 | .instruction { font-family: 'Courier New', Courier, mono;}
|
|---|
| 41 |
|
|---|
| 42 | .categoryBox h3 { background-color: #eee; text-align: left; vertical-align: top; font-weight:bold; font-size: 12px; }
|
|---|
| 43 | .categoryBox h3:hover { cursor: pointer;}
|
|---|
| 44 | .categoryBox div { margin: 0; padding: 1em 0.4em; background-color: #eef; border-bottom: 1px solid #66d; }
|
|---|
| 45 | .categoryBox.hide h3 { color: #000; background-color: #88f; }
|
|---|
| 46 | .categoryBox.hide table { display: none; }
|
|---|
| 47 |
|
|---|
| 48 | .categoryDefault { display: table-row; font-weight: normal; }
|
|---|
| 49 | .categoryDefault.hide { display: none; }
|
|---|
| 50 | .categoryUser { display: table-row; font-weight: bold; }
|
|---|
| 51 | .categoryUser.hide { display: none; }
|
|---|
| 52 | </style>
|
|---|
| 53 | <script type="text/javascript">
|
|---|
| 54 | //<![CDATA[
|
|---|
| 55 | var categoryBoxes = new Array();
|
|---|
| 56 | var defaultRows = new Array();
|
|---|
| 57 | var userRows = new Array();
|
|---|
| 58 | var defaultArray = ['audio/gain','audio/mix','audio/mute','view/color/border','view/color/contentBackground','view/color/toolbarBackground','view/color/toolbarText','view/freeze','view/size','documentation/generate','init','preset/clear','preset/copy','preset/default','preset/dump','preset/interpolate','preset/post','preset/read','preset/recall','preset/store','preset/storecurrent','preset/storenext','preset/write','preset/writeagain','view/inernals','view/refresh','view/script'];
|
|---|
| 59 | function init() {
|
|---|
| 60 | // Grab the accordion items from the page
|
|---|
| 61 | var divs = document.getElementsByTagName( 'div' );
|
|---|
| 62 | for ( var i = 0; i < divs.length; i++ ) {
|
|---|
| 63 | if ( divs[i].className == 'categoryBox' ) categoryBoxes.push( divs[i] );
|
|---|
| 64 | }
|
|---|
| 65 | //Grab the user and default parameters/messages from the page: <tr> class="entry"
|
|---|
| 66 | var allRows = document.getElementsByTagName( 'tr' );
|
|---|
| 67 | // alert('Length of array of all rows: ' + allRows.length);
|
|---|
| 68 | for ( var i = 0; i < allRows.length; i++ ) {
|
|---|
| 69 | var temp = allRows[i].children[0].innerHTML.toString();
|
|---|
| 70 | if (defaultArray.contains(temp)) defaultRows.push(allRows[i]);
|
|---|
| 71 | //if (allRows[i].className=='entry') userRows.push(allRows[i]);
|
|---|
| 72 | }
|
|---|
| 73 |
|
|---|
| 74 | // uncomment the following for testing purposes
|
|---|
| 75 | // alert('Length of array of just default rows: ' + defaultRows.length );
|
|---|
| 76 | // alert(defaultArray.contains('view/script'));
|
|---|
| 77 | // Assign onclick events to the accordion item headings
|
|---|
| 78 | for ( var i = 0; i < categoryBoxes.length; i++ ) {
|
|---|
| 79 | var h3 = getFirstChildWithTagName( categoryBoxes[i], 'H3' );
|
|---|
| 80 | h3.onclick = toggleItem;
|
|---|
| 81 | }
|
|---|
| 82 | // SHOW all accordion item bodies BY DEFAULT
|
|---|
| 83 | for ( var i = 0; i < categoryBoxes.length; i++ ) {
|
|---|
| 84 | categoryBoxes[i].className = 'categoryBox';
|
|---|
| 85 | }
|
|---|
| 86 | toggleDefaults();
|
|---|
| 87 | }
|
|---|
| 88 | function toggleItem() {
|
|---|
| 89 | var itemClass = this.parentNode.className;
|
|---|
| 90 |
|
|---|
| 91 | // Hide all items
|
|---|
| 92 | //for ( var i = 0; i < categoryBoxes.length; i++ ) {
|
|---|
| 93 | // categoryBoxes[i].className = 'categoryBox hide';
|
|---|
| 94 | //}
|
|---|
| 95 |
|
|---|
| 96 | // Show this item if it was previously hidden
|
|---|
| 97 | if ( itemClass == 'categoryBox hide' ) {
|
|---|
| 98 | this.parentNode.className = 'categoryBox';
|
|---|
| 99 | }
|
|---|
| 100 | else
|
|---|
| 101 | {
|
|---|
| 102 | this.parentNode.className = 'categoryBox hide';
|
|---|
| 103 | }
|
|---|
| 104 | }
|
|---|
| 105 | function getFirstChildWithTagName( element, tagName ) {
|
|---|
| 106 | for ( var i = 0; i < element.childNodes.length; i++ ) {
|
|---|
| 107 | //alert(element.childNodes[i].nodeName);
|
|---|
| 108 | if ( element.childNodes[i].nodeName == tagName ) return element.childNodes[i];
|
|---|
| 109 | }
|
|---|
| 110 | }
|
|---|
| 111 | function getFirstChildWithClassName( element, nodeClass ) {
|
|---|
| 112 | for ( var i = 0; i < element.childNodes.length; i++ ) {
|
|---|
| 113 | if ( element.childNodes[i].className == nodeClass ) return element.childNodes[i];
|
|---|
| 114 | }
|
|---|
| 115 | }
|
|---|
| 116 | function toggleDefaults() {
|
|---|
| 117 | // Show/hide all default items
|
|---|
| 118 | for ( var i = 0; i < defaultRows.length; i++ ) {
|
|---|
| 119 | if ( defaultRows[i].className == 'categoryDefault' )
|
|---|
| 120 | {
|
|---|
| 121 | defaultRows[i].className = 'categoryDefault hide';
|
|---|
| 122 | document.getElementById( 'tglDefaults' ).value = 'Show Default Parameters and Messages';
|
|---|
| 123 | }
|
|---|
| 124 | else
|
|---|
| 125 | {
|
|---|
| 126 | defaultRows[i].className = 'categoryDefault';
|
|---|
| 127 | document.getElementById( 'tglDefaults' ).value = 'Hide Default Parameters and Messages';
|
|---|
| 128 | }
|
|---|
| 129 | }
|
|---|
| 130 | }
|
|---|
| 131 | Array.prototype.contains = function(obj) {
|
|---|
| 132 | var i = this.length;
|
|---|
| 133 | while (i--) {
|
|---|
| 134 | if (this[i] === obj) {
|
|---|
| 135 | return true;
|
|---|
| 136 | }
|
|---|
| 137 | }
|
|---|
| 138 | return false;
|
|---|
| 139 | }
|
|---|
| 140 | window.onload=init;
|
|---|
| 141 | //]]>
|
|---|
| 142 | </script>
|
|---|
| 143 | </head>
|
|---|
| 144 |
|
|---|
| 145 | <body>
|
|---|
| 146 | <div id="jmod_header">
|
|---|
| 147 | <img src="../../../documentation/graphics/jmodular.icon.png" width="128" height="128">
|
|---|
| 148 | <h1> jmod.syn.1 </h1>
|
|---|
| 149 | <h2> This module doesn't do much yet </h2>
|
|---|
| 150 | <h6><a href="../../../documentation/html/index.html">Table of Contents</a> | <a href="../../../documentation/html/modules.html">Index of Modules</a> | <a href="../../../documentation/html/credits.html">Credits</a> | <a href="http://pledgie.com/campaigns/5615">Donate</a> | <a href="http://www.jamoma.org/">Jamoma.org</a></h6>
|
|---|
| 151 | </div>
|
|---|
| 152 |
|
|---|
| 153 | <h3> Configuration </h3>
|
|---|
| 154 | <p>Module Type: <code> audio </code> | Algorithm Type: <code> default </code> | Interface Size: <code> 1U-half </code> </p>
|
|---|
| 155 | <p>Number of signal inlets: <code> 0 </code> | Number of signal outlets: <code> 1 </code> </p>
|
|---|
| 156 |
|
|---|
| 157 | <p><input type="button" id="tglDefaults" onclick="toggleDefaults()" value="Hide Default Parameters and Messages" /></p>
|
|---|
| 158 | <div class="categoryBox">
|
|---|
| 159 | <h3> Parameters </h3>
|
|---|
| 160 | <table>
|
|---|
| 161 | <tr class="tableHeading2">
|
|---|
| 162 | <td> /name </td>
|
|---|
| 163 | <td> /type </td>
|
|---|
| 164 | <td> /range /bounds </td>
|
|---|
| 165 | <td> /range /clipmode </td>
|
|---|
| 166 | <td> /ramp /drive </td>
|
|---|
| 167 | <td> /ramp /function </td>
|
|---|
| 168 | <td> /dataspace </td>
|
|---|
| 169 | <td> /repetitions /allow </td>
|
|---|
| 170 | <td> /description </td>
|
|---|
| 171 | </tr>
|
|---|
| 172 | <tr class = "entry">
|
|---|
| 173 | <td class="instructionName">my_bang</td>
|
|---|
| 174 | <td class="instructionType">generic</td>
|
|---|
| 175 | <td class="instructionRangeBounds">0.000000 1.000000</td>
|
|---|
| 176 | <td class="instructionRangeClipmode">-</td>
|
|---|
| 177 | <td class="instructionRampDrive">-</td>
|
|---|
| 178 | <td class="instructionRampFunction">-</td>
|
|---|
| 179 | <td class="instructionDataspace">-</td>
|
|---|
| 180 | <td class="instructionRepetitionsAllow">1</td>
|
|---|
| 181 | <td class="instructionDescription">a bang</td>
|
|---|
| 182 | </tr>
|
|---|
| 183 | <tr class = "entry">
|
|---|
| 184 | <td class="instructionName">audio/gain</td>
|
|---|
| 185 | <td class ="instructionType"> decimal </td>
|
|---|
| 186 | <td class ="instructionRangeBounds"> 0.000000 127.000000 </td>
|
|---|
| 187 | <td class ="instructionRangeClipmode"> - </td>
|
|---|
| 188 | <td class ="instructionRampDrive"> scheduler </td>
|
|---|
| 189 | <td class ="instructionRampFunction"> linear </td>
|
|---|
| 190 | <td class ="instructionDataspace"> gain </td>
|
|---|
| 191 | <td class ="instructionRepetitionsAllow"> 0 </td>
|
|---|
| 192 | <td class ="instructionDescription"> Set gain (as MIDI value by default). </td>
|
|---|
| 193 | </tr>
|
|---|
| 194 | <tr class = "entry">
|
|---|
| 195 | <td class="instructionName">audio/mix</td>
|
|---|
| 196 | <td class ="instructionType"> decimal </td>
|
|---|
| 197 | <td class ="instructionRangeBounds"> 0.000000 100.000000 </td>
|
|---|
| 198 | <td class ="instructionRangeClipmode"> - </td>
|
|---|
| 199 | <td class ="instructionRampDrive"> scheduler </td>
|
|---|
| 200 | <td class ="instructionRampFunction"> linear </td>
|
|---|
| 201 | <td class ="instructionDataspace"> - </td>
|
|---|
| 202 | <td class ="instructionRepetitionsAllow"> 0 </td>
|
|---|
| 203 | <td class ="instructionDescription"> Controls the wet/dry mix of the module's processing routine in percent. </td>
|
|---|
| 204 | </tr>
|
|---|
| 205 | <tr class = "entry">
|
|---|
| 206 | <td class="instructionName">audio/mute</td>
|
|---|
| 207 | <td class ="instructionType"> boolean </td>
|
|---|
| 208 | <td class ="instructionRangeBounds"> 0 1 </td>
|
|---|
| 209 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 210 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 211 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 212 | <td class ="instructionDataspace"> none </td>
|
|---|
| 213 | <td class ="instructionRepetitionsAllow"> 0 </td>
|
|---|
| 214 | <td class ="instructionDescription"> When active, this attribute turns off the module's processing algorithm to save CPU </td>
|
|---|
| 215 | </tr>
|
|---|
| 216 | <tr class = "entry">
|
|---|
| 217 | <td class="instructionName">mult</td>
|
|---|
| 218 | <td class ="instructionType"> decimal </td>
|
|---|
| 219 | <td class ="instructionRangeBounds"> 0.100000 10.000000 </td>
|
|---|
| 220 | <td class ="instructionRangeClipmode"> both </td>
|
|---|
| 221 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 222 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 223 | <td class ="instructionDataspace"> none </td>
|
|---|
| 224 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 225 | <td class ="instructionDescription"> Delay factor. </td>
|
|---|
| 226 | </tr>
|
|---|
| 227 | <tr class = "entry">
|
|---|
| 228 | <td class="instructionName">transp</td>
|
|---|
| 229 | <td class ="instructionType"> decimal </td>
|
|---|
| 230 | <td class ="instructionRangeBounds"> 0.000000 1.000000 </td>
|
|---|
| 231 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 232 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 233 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 234 | <td class ="instructionDataspace"> none </td>
|
|---|
| 235 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 236 | <td class ="instructionDescription"> Transposition factor. </td>
|
|---|
| 237 | </tr>
|
|---|
| 238 | <tr class = "entry">
|
|---|
| 239 | <td class="instructionName">view/color/border</td>
|
|---|
| 240 | <td class ="instructionType"> array </td>
|
|---|
| 241 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 242 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 243 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 244 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 245 | <td class ="instructionDataspace"> none </td>
|
|---|
| 246 | <td class ="instructionRepetitionsAllow"> 0 </td>
|
|---|
| 247 | <td class ="instructionDescription"> The border color of the module in the format RGBA where values range [0.0, 1.0]. </td>
|
|---|
| 248 | </tr>
|
|---|
| 249 | <tr class = "entry">
|
|---|
| 250 | <td class="instructionName">view/color/contentBackground</td> <!split>
|
|---|
| 251 | <td class ="instructionType"> array </td>
|
|---|
| 252 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 253 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 254 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 255 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 256 | <td class ="instructionDataspace"> none </td>
|
|---|
| 257 | <td class ="instructionRepetitionsAllow"> 0 </td>
|
|---|
| 258 | <td class ="instructionDescription"> The background color of the module in the format RGBA where values range [0.0, 1.0]. </td>
|
|---|
| 259 | </tr>
|
|---|
| 260 | <tr class = "entry">
|
|---|
| 261 | <td class="instructionName">view/color/toolbarBackground</td> <!split>
|
|---|
| 262 | <td class ="instructionType"> array </td>
|
|---|
| 263 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 264 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 265 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 266 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 267 | <td class ="instructionDataspace"> none </td>
|
|---|
| 268 | <td class ="instructionRepetitionsAllow"> 0 </td>
|
|---|
| 269 | <td class ="instructionDescription"> The background color of the module's toolbar in the format RGBA where values range [0.0, 1.0]. </td>
|
|---|
| 270 | </tr>
|
|---|
| 271 | <tr class = "entry">
|
|---|
| 272 | <td class="instructionName">view/color/toolbarText</td> <!split>
|
|---|
| 273 | <td class ="instructionType"> array </td>
|
|---|
| 274 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 275 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 276 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 277 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 278 | <td class ="instructionDataspace"> none </td>
|
|---|
| 279 | <td class ="instructionRepetitionsAllow"> 0 </td>
|
|---|
| 280 | <td class ="instructionDescription"> The color of the module's toolbar text in the format RGBA where values range [0.0, 1.0]. </td>
|
|---|
| 281 | </tr>
|
|---|
| 282 | <tr class = "entry">
|
|---|
| 283 | <td class="instructionName">view/freeze</td>
|
|---|
| 284 | <td class ="instructionType"> boolean </td>
|
|---|
| 285 | <td class ="instructionRangeBounds"> 0 1 </td>
|
|---|
| 286 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 287 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 288 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 289 | <td class ="instructionDataspace"> none </td>
|
|---|
| 290 | <td class ="instructionRepetitionsAllow"> 0 </td>
|
|---|
| 291 | <td class ="instructionDescription"> Turn off the updating of user interface elements when parameters change. This may be done to conserve CPU resources. </td>
|
|---|
| 292 | </tr>
|
|---|
| 293 | <tr class = "entry">
|
|---|
| 294 | <td class="instructionName">view/size</td>
|
|---|
| 295 | <td class ="instructionType"> array </td>
|
|---|
| 296 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 297 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 298 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 299 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 300 | <td class ="instructionDataspace"> none </td>
|
|---|
| 301 | <td class ="instructionRepetitionsAllow"> 0 </td>
|
|---|
| 302 | <td class ="instructionDescription"> The size of the module's UI. </td>
|
|---|
| 303 | </tr>
|
|---|
| 304 | </table>
|
|---|
| 305 | </div>
|
|---|
| 306 |
|
|---|
| 307 | <div class="categoryBox">
|
|---|
| 308 | <h3> Messages </h3>
|
|---|
| 309 | <table>
|
|---|
| 310 | <tr class="tableHeading2">
|
|---|
| 311 | <td> /name </td>
|
|---|
| 312 | <td> /type </td>
|
|---|
| 313 | <td> /range /bounds </td>
|
|---|
| 314 | <td> /range /clipmode </td>
|
|---|
| 315 | <td> /ramp /drive </td>
|
|---|
| 316 | <td> /ramp /function </td>
|
|---|
| 317 | <td> /dataspace </td>
|
|---|
| 318 | <td> /repetitions /allow </td>
|
|---|
| 319 | <td> /description </td>
|
|---|
| 320 | </tr>
|
|---|
| 321 | <tr class = "param">
|
|---|
| 322 | <td class="instructionName">documentation/generate</td> <!split>
|
|---|
| 323 | <td class ="instructionType"> generic </td>
|
|---|
| 324 | <td class ="instructionRangeBounds"> 0.000000 1.000000 </td>
|
|---|
| 325 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 326 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 327 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 328 | <td class ="instructionDataspace"> none </td>
|
|---|
| 329 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 330 | <td class ="instructionDescription"> Generate a documentation page for this module and save it to disk. </td>
|
|---|
| 331 | </tr>
|
|---|
| 332 | <tr class = "entry">
|
|---|
| 333 | <td class="instructionName">initialize</td>
|
|---|
| 334 | <td class ="instructionType"> none </td>
|
|---|
| 335 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 336 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 337 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 338 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 339 | <td class ="instructionDataspace"> none </td>
|
|---|
| 340 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 341 | <td class ="instructionDescription"> Init this. </td>
|
|---|
| 342 | </tr>
|
|---|
| 343 | <tr class = "entry">
|
|---|
| 344 | <td class="instructionName">init</td>
|
|---|
| 345 | <td class ="instructionType"> none </td>
|
|---|
| 346 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 347 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 348 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 349 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 350 | <td class ="instructionDataspace"> none </td>
|
|---|
| 351 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 352 | <td class ="instructionDescription"> Initialize a module completely to the original state. </td>
|
|---|
| 353 | </tr>
|
|---|
| 354 | <tr class = "entry">
|
|---|
| 355 | <td class="instructionName">preset/clear</td>
|
|---|
| 356 | <td class ="instructionType"> none </td>
|
|---|
| 357 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 358 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 359 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 360 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 361 | <td class ="instructionDataspace"> none </td>
|
|---|
| 362 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 363 | <td class ="instructionDescription"> Clears all presets, providing a blank slate for saving new presets. </td>
|
|---|
| 364 | </tr>
|
|---|
| 365 | <tr class = "entry">
|
|---|
| 366 | <td class="instructionName">preset/copy</td>
|
|---|
| 367 | <td class ="instructionType"> array </td>
|
|---|
| 368 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 369 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 370 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 371 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 372 | <td class ="instructionDataspace"> none </td>
|
|---|
| 373 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 374 | <td class ="instructionDescription"> Create a new preset (2nd argument) by copying the contents of another preset (1st argument) </td>
|
|---|
| 375 | </tr>
|
|---|
| 376 | <tr class = "entry">
|
|---|
| 377 | <td class="instructionName">preset/default</td>
|
|---|
| 378 | <td class ="instructionType"> none </td>
|
|---|
| 379 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 380 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 381 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 382 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 383 | <td class ="instructionDataspace"> none </td>
|
|---|
| 384 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 385 | <td class ="instructionDescription"> Open the default preset file and recall the first preset in that file. </td>
|
|---|
| 386 | </tr>
|
|---|
| 387 | <tr class = "param">
|
|---|
| 388 | <td class="instructionName">preset/dump</td>
|
|---|
| 389 | <td class ="instructionType"> none </td>
|
|---|
| 390 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 391 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 392 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 393 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 394 | <td class ="instructionDataspace"> none </td>
|
|---|
| 395 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 396 | <td class ="instructionDescription"> Dump all preset names. </td>
|
|---|
| 397 | </tr>
|
|---|
| 398 | <tr class = "entry">
|
|---|
| 399 | <td class="instructionName">preset/interpolate</td> <!split>
|
|---|
| 400 | <td class ="instructionType"> array </td>
|
|---|
| 401 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 402 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 403 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 404 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 405 | <td class ="instructionDataspace"> none </td>
|
|---|
| 406 | <td class ="instructionRepetitionsAllow"> 0 </td>
|
|---|
| 407 | <td class ="instructionDescription"> Interpolate between two named presets (argument 1 and 2) using a ratio (float in the range [0.0, 1.0]) specified as the third argument. </td>
|
|---|
| 408 | </tr>
|
|---|
| 409 | <tr class = "param">
|
|---|
| 410 | <td class="instructionName"> preset/post </td>
|
|---|
| 411 | <td class ="instructionType"> none </td>
|
|---|
| 412 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 413 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 414 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 415 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 416 | <td class ="instructionDataspace"> none </td>
|
|---|
| 417 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 418 | <td class ="instructionDescription"> Post all presets to the Max window. </td>
|
|---|
| 419 | </tr>
|
|---|
| 420 | <tr class = "entry">
|
|---|
| 421 | <td class="instructionName">preset/read</td>
|
|---|
| 422 | <td class ="instructionType"> generic </td>
|
|---|
| 423 | <td class ="instructionRangeBounds"> 0.000000 1.000000 </td>
|
|---|
| 424 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 425 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 426 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 427 | <td class ="instructionDataspace"> none </td>
|
|---|
| 428 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 429 | <td class ="instructionDescription"> Open an xml-preset file and recall the first preset in that file. An optional argument defines the file to open. </td>
|
|---|
| 430 | </tr>
|
|---|
| 431 | <tr class = "entry">
|
|---|
| 432 | <td class="instructionName">preset/recall</td>
|
|---|
| 433 | <td class ="instructionType"> generic </td>
|
|---|
| 434 | <td class ="instructionRangeBounds"> 0.000000 1.000000 </td>
|
|---|
| 435 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 436 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 437 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 438 | <td class ="instructionDataspace"> none </td>
|
|---|
| 439 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 440 | <td class ="instructionDescription"> Recall a preset by number - you can also choose presets from the module menu. </td>
|
|---|
| 441 | </tr>
|
|---|
| 442 | <tr class = "entry">
|
|---|
| 443 | <td class="instructionName">preset/store</td>
|
|---|
| 444 | <td class ="instructionType"> array </td>
|
|---|
| 445 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 446 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 447 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 448 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 449 | <td class ="instructionDataspace"> none </td>
|
|---|
| 450 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 451 | <td class ="instructionDescription"> Store a preset by number in memory. All presets present in memory will be written to disk when you send a save_settings message to the module. </td>
|
|---|
| 452 | </tr>
|
|---|
| 453 | <tr class = "entry">
|
|---|
| 454 | <td class="instructionName">preset/storecurrent</td> <!split>
|
|---|
| 455 | <td class ="instructionType"> none </td>
|
|---|
| 456 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 457 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 458 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 459 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 460 | <td class ="instructionDataspace"> none </td>
|
|---|
| 461 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 462 | <td class ="instructionDescription"> Store on the last recalled or stored preset </td>
|
|---|
| 463 | </tr>
|
|---|
| 464 | <tr class = "entry">
|
|---|
| 465 | <td class="instructionName">preset/storenext</td> <!split>
|
|---|
| 466 | <td class ="instructionType"> none </td>
|
|---|
| 467 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 468 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 469 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 470 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 471 | <td class ="instructionDataspace"> none </td>
|
|---|
| 472 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 473 | <td class ="instructionDescription"> Store a preset in the next preset slot. Handy so that you do not need to specify a preset number manually. </td>
|
|---|
| 474 | </tr>
|
|---|
| 475 | <tr class = "entry">
|
|---|
| 476 | <td class="instructionName">preset/write</td>
|
|---|
| 477 | <td class ="instructionType"> generic </td>
|
|---|
| 478 | <td class ="instructionRangeBounds"> 0.000000 1.000000 </td>
|
|---|
| 479 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 480 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 481 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 482 | <td class ="instructionDataspace"> none </td>
|
|---|
| 483 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 484 | <td class ="instructionDescription"> Write an xml-preset file to disk. An optional argument defines the file to open. </td>
|
|---|
| 485 | </tr>
|
|---|
| 486 | <tr class = "entry">
|
|---|
| 487 | <td class="instructionName">preset/writeagain</td>
|
|---|
| 488 | <td class ="instructionType"> none </td>
|
|---|
| 489 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 490 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 491 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 492 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 493 | <td class ="instructionDataspace"> none </td>
|
|---|
| 494 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 495 | <td class ="instructionDescription"> Write on same xml-preset file. </td>
|
|---|
| 496 | </tr>
|
|---|
| 497 | <tr class = "entry">
|
|---|
| 498 | <td class="instructionName">unit</td>
|
|---|
| 499 | <td class ="instructionType"> integer </td>
|
|---|
| 500 | <td class ="instructionRangeBounds"> 0 1 </td>
|
|---|
| 501 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 502 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 503 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 504 | <td class ="instructionDataspace"> none </td>
|
|---|
| 505 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 506 | <td class ="instructionDescription"> Unit to be played. </td>
|
|---|
| 507 | </tr>
|
|---|
| 508 | <tr class = "entry">
|
|---|
| 509 | <td class="instructionName">view/internals</td>
|
|---|
| 510 | <td class ="instructionType"> none </td>
|
|---|
| 511 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 512 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 513 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 514 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 515 | <td class ="instructionDataspace"> none </td>
|
|---|
| 516 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 517 | <td class ="instructionDescription"> Attempts to open the internal algorithm for viewing. This works for most modules. Some modules may choose to cloak the algorithms - preventing this message from functioning. </td>
|
|---|
| 518 | </tr>
|
|---|
| 519 | <tr class = "entry">
|
|---|
| 520 | <td class="instructionName">view/refresh</td>
|
|---|
| 521 | <td class ="instructionType"> none </td>
|
|---|
| 522 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 523 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 524 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 525 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 526 | <td class ="instructionDataspace"> none </td>
|
|---|
| 527 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 528 | <td class ="instructionDescription"> Update displayed values for module to reflect current state. </td>
|
|---|
| 529 | </tr>
|
|---|
| 530 | <tr class = "entry">
|
|---|
| 531 | <td class="instructionName">view/script</td>
|
|---|
| 532 | <td class ="instructionType"> generic </td>
|
|---|
| 533 | <td class ="instructionRangeBounds"> 0.000000 1.000000 </td>
|
|---|
| 534 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 535 | <td class ="instructionRampDrive"> none </td>
|
|---|
| 536 | <td class ="instructionRampFunction"> none </td>
|
|---|
| 537 | <td class ="instructionDataspace"> none </td>
|
|---|
| 538 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 539 | <td class ="instructionDescription"> Low-level module hacking. Any arguments arguments to this message will be interpreted as patcher scripting for the top-level patcher of the module. </td>
|
|---|
| 540 | </tr>
|
|---|
| 541 | </table>
|
|---|
| 542 | </div>
|
|---|
| 543 |
|
|---|
| 544 | <div class="categoryBox">
|
|---|
| 545 | <h3> Returns </h3>
|
|---|
| 546 | <table>
|
|---|
| 547 | <tr class="tableHeading2">
|
|---|
| 548 | <td> /name </td>
|
|---|
| 549 | <td> /type </td>
|
|---|
| 550 | <td> /range /bounds </td>
|
|---|
| 551 | <td> /range /clipmode </td>
|
|---|
| 552 | <td> /ramp /drive </td>
|
|---|
| 553 | <td> /ramp /function </td>
|
|---|
| 554 | <td> /dataspace </td>
|
|---|
| 555 | <td> /repetitions /allow </td>
|
|---|
| 556 | <td> /description </td>
|
|---|
| 557 | </tr>
|
|---|
| 558 | <tr class = "entry">
|
|---|
| 559 | <td class="instructionName">audio/amplitude.1</td> <!split>
|
|---|
| 560 | <td class ="instructionType"> decimal </td>
|
|---|
| 561 | <td class ="instructionRangeBounds"> 0.000000 1.000000 </td>
|
|---|
| 562 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 563 | <td class ="instructionRampDrive"> </td>
|
|---|
| 564 | <td class ="instructionRampFunction"> </td>
|
|---|
| 565 | <td class ="instructionDataspace"> </td>
|
|---|
| 566 | <td class ="instructionRepetitionsAllow"> 0 </td>
|
|---|
| 567 | <td class ="instructionDescription"> instant amplitude of the signal number #1 </td>
|
|---|
| 568 | </tr>
|
|---|
| 569 | <tr class = "entry">
|
|---|
| 570 | <td class="instructionName">done</td>
|
|---|
| 571 | <td class ="instructionType"> none </td>
|
|---|
| 572 | <td class = "instructionRangeBounds"> N/A </td>
|
|---|
| 573 | <td class ="instructionRangeClipmode"> none </td>
|
|---|
| 574 | <td class ="instructionRampDrive"> </td>
|
|---|
| 575 | <td class ="instructionRampFunction"> </td>
|
|---|
| 576 | <td class ="instructionDataspace"> </td>
|
|---|
| 577 | <td class ="instructionRepetitionsAllow"> 1 </td>
|
|---|
| 578 | <td class ="instructionDescription"> Signal end of current segment. </td>
|
|---|
| 579 | </tr>
|
|---|
| 580 | </table>
|
|---|
| 581 | </div>
|
|---|
| 582 |
|
|---|
| 583 | <h3> About Jamoma </h3>
|
|---|
| 584 | <p> Jamoma is a system for creating and exchanging structured Max patches.
|
|---|
| 585 | It consists of both a set of guidelines and an implementation of those guidelines.
|
|---|
| 586 | For more information please visit <a href="http://jamoma.org/">jamoma.org</a>. </p>
|
|---|
| 587 | </body>
|
|---|
| 588 | </html>
|
|---|