jmod.sur.speaker.setup.html from Jamoma at Krugle
Show jmod.sur.speaker.setup.html syntax highlighted
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="content-type" content="text/html;charset=ISO-8859-1">
<title> jmod.sur.speaker.setup </title>
<link href="../styles/jamoma.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="jmod_header">
<img src="../images/jmod.icon.mod.png" width="128" height="128">
<h1> jmod.sur.speaker.setup </h1>
<h2> Describe speaker setup as sets of xyz coordinates. </h2>
<h6><a href="../index.html">Table of Contents</a> | <a href="../modules/">Index of Modules</a> | <a href="http://jamoma.org/">Jamoma.org</a></h6>
</div>
<h3> Configuration </h3>
<p> Module Type: <code> control </code> <br>
Algorithm Type: <code> default </code> </p>
<p>Interface Size: <code> 1U-half </code> </p>
<p>Number of signal inlets: <code> 0 </ code> <br/>
Number of signal outlets: <code> 0 </code> </p>
<h3> Parameters </h3>
<table>
<tr class="tableHeading2">
<td> Name </td>
<td> Type </td>
<td> Range </td>
<td> Clipmode </td>
<td> Ramp Enabled </td>
<td> Repetitions </td>
<td> Description </td>
<tr>
<tr>
<td class="instructionName"> ui/freeze </td>
<td class ="instructionType"> msg_toggle </td>
<td class ="instructionRange"> 0 1 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 0 </td>
<td class ="instructionDescription"> Turn off the updating of user interface elements when parameters change. This may be done to conserve CPU resources. </td>
<tr>
<tr>
<td class="instructionName"> voices </td>
<td class ="instructionType"> msg_int </td>
<td class ="instructionRange"> 0 16 </td>
<td class ="instructionClipmode"> both </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 0 </td>
<td class ="instructionDescription"> Number of voices to transmit. </td>
<tr>
<tr>
<td class="instructionName"> xyz/10 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/11 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/12 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/13 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/14 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/15 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/16 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/1 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/2 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/3 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/4 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/5 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/6 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/7 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/8 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
<tr>
<td class="instructionName"> xyz/9 </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position </td>
<tr>
</table>
<p> </p>
<h3> Messages </h3>
<table>
<tr class="tableHeading2">
<td> Name </td>
<td> Type </td>
<td> Range </td>
<td> Clipmode </td>
<td> Ramp Enabled </td>
<td> Repetitions </td>
<td> Description </td>
<tr>
<tr>
<td class="instructionName"> documentation/generate </td>
<td class ="instructionType"> msg_none </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Generate html documentation for the module. </td>
<tr>
<tr>
<td class="instructionName"> documentation/help </td>
<td class ="instructionType"> msg_none </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Open the help patch for the module. </td>
<tr>
<tr>
<td class="instructionName"> documentation/html </td>
<td class ="instructionType"> msg_none </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Open the online html reference for this module. </td>
<tr>
<tr>
<td class="instructionName"> module/view_internals </td>
<td class ="instructionType"> msg_none </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<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>
<tr>
<tr>
<td class="instructionName"> open_inspector </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Open this module's inspector window to gain access to additional information or parameters. </td>
<tr>
<tr>
<td class="instructionName"> preset/default </td>
<td class ="instructionType"> msg_none </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Open the default preset file and recall the first preset in that file. </td>
<tr>
<tr>
<td class="instructionName"> preset/post </td>
<td class ="instructionType"> msg_none </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Post all presets to the Max window. </td>
<tr>
<tr>
<td class="instructionName"> preset/read </td>
<td class ="instructionType"> msg_symbol </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<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>
<tr>
<tr>
<td class="instructionName"> preset/recall </td>
<td class ="instructionType"> msg_float </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Recall a preset by number - you can also choose presets from the module menu. </td>
<tr>
<tr>
<td class="instructionName"> preset/store </td>
<td class ="instructionType"> msg_int </td>
<td class ="instructionRange"> 0 1 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<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>
<tr>
<tr>
<td class="instructionName"> preset/write </td>
<td class ="instructionType"> msg_symbol </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Write an xml-preset file to disk. An optional argument defines the file to open. </td>
<tr>
<tr>
<td class="instructionName"> ui/refresh </td>
<td class ="instructionType"> msg_none </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Update displayed values for module to reflect current state. </td>
<tr>
</table>
<p> </p>
<h3> Return </h3>
<table>
<tr class="tableHeading2">
<td> Name </td>
<td> Type </td>
<td> Range </td>
<td> Clipmode </td>
<td> Ramp Enabled </td>
<td> Repetitions </td>
<td> Description </td>
<tr>
<tr>
<td class="instructionName"> aed </td>
<td class ="instructionType"> msg_list </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Position of Nth voice as list of polar coordinates (index, azi, ele, dist, active). </td>
<tr>
<tr>
<td class="instructionName"> delete </td>
<td class ="instructionType"> msg_int </td>
<td class ="instructionRange"> 0 0 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Delete Nth voice. </td>
<tr>
</table>
<p> </p>
<h3> About Jamoma </h3>
<p> Jamoma is a system for creating and exchanging structured Max patches.
It consists of both a set of guidelines and an implementation of those guidelines.
For more information please visit <a href="http://jamoma.org/">jamoma.org</a>. </p>
</body>
</html>
See more files for this project here