jmod.oscnet.html from Jamoma at Krugle
Show jmod.oscnet.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.oscnet </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.oscnet</h1>
<h2>Send and receive OpenSoundControl over a network port. You may receive directly or join up to 2 multicast addresses in addition to receiving directly.</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>
Interface Size: <code> 1U-half </code> </p>
<p> Number of signal inlets: <code> </code> <br>
Number of signal outlets: <code> </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"> /clock/set </td>
<td class="instructionType"> msg_symbol </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Sync module to external clock. <br><code>/set_clock max</code> set module to use the Max scheduler (default behaviour). </td>
</tr>
<tr>
<td class="instructionName"> /mode </td>
<td class="instructionType"> toggle </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Choose between single IP or multicast usage </td>
</tr>
<tr>
<td class="instructionName"> /multicast_ip </td>
<td class="instructionType"> generic </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> no </td>
<td class="instructionDescription"> Define the multicast host to for OpenSoundControl messages to which you would like to join. This may be symbolic or an ip address. </td>
</tr>
<tr>
<td class="instructionName"> /multicast_join </td>
<td class="instructionType"> msg_int </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Set the network port number on which to receive OpenSoundControl messages. </td>
</tr>
<tr>
<td class="instructionName"> /multicast_port </td>
<td class="instructionType"> msg_int </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Set the network port number used for sending out multicast OpenSoundControl messages. </td>
</tr>
<tr>
<td class="instructionName"> /osc_prefix </td>
<td class="instructionType"> generic </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> no </td>
<td class="instructionDescription"> Define a string to concatenate to the beginning of all OpenSoundControl strings sent by this module. </td>
</tr>
<tr>
<td class="instructionName"> /receive_port </td>
<td class="instructionType"> msg_int </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Set the network port number on which to receive OpenSoundControl messages. </td>
</tr>
<tr>
<td class="instructionName"> /send_host </td>
<td class="instructionType"> generic </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> no </td>
<td class="instructionDescription"> Set the host to which OpenSoundControl messages should be sent. This may be symbolic or an ip address. </td>
</tr>
<tr>
<td class="instructionName"> /send_port </td>
<td class="instructionType"> msg_int </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Set the network port number used for sending out OpenSoundControl messages. </td>
</tr>
<tr>
<td class="instructionName"> /ui/freeze </td>
<td class="instructionType"> toggle </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </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>
</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/help </td>
<td class="instructionType"> generic </td>
<td class="instructionRange"> n/a </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Open the help patch for the module. </td>
</tr>
<tr>
<td class="instructionName"> /documentation/html </td>
<td class="instructionType"> generic </td>
<td class="instructionRange"> n/a </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Open the online html reference for this module. </td>
</tr>
<tr>
<td class="instructionName"> /module/parameter_names/get </td>
<td class="instructionType"> n/a </td>
<td class="instructionRange"> n/a </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Returns a dump of symbols out the feedback outlet with the names of parameters accessible in this module. </td>
</tr>
<tr>
<td class="instructionName"> /module/size/get </td>
<td class="instructionType"> generic </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Get size of module. </td>
</tr>
<tr>
<td class="instructionName"> /module/view_internals </td>
<td class="instructionType"> n/a </td>
<td class="instructionRange"> n/a </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </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"> /preset/default </td>
<td class="instructionType"> n/a </td>
<td class="instructionRange"> n/a </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Open the default preset file and recall the first preset in that file. </td>
</tr>
<tr>
<td class="instructionName"> /preset/direct </td>
<td class="instructionType"> generic </td>
<td class="instructionRange"> n/a </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Access directly to the pattrstorage object. See Max Reference. </td>
</tr>
<tr>
<td class="instructionName"> /preset/load </td>
<td class="instructionType"> msg_symbol </td>
<td class="instructionRange"> n/a </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </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_int </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </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/save </td>
<td class="instructionType"> msg_symbol </td>
<td class="instructionRange"> n/a </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </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"> /preset/store </td>
<td class="instructionType"> msg_int </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </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"> /send </td>
<td class="instructionType"> generic </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> An OpenSoundControl message to send out over the network. </td>
</tr>
<tr>
<td class="instructionName"> /ui/refresh </td>
<td class="instructionType"> msg_bang </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> no </td>
<td class="instructionRepetitions"> yes </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"> /module/size </td>
<td class="instructionType"> generic </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> N/A </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> Size of module. </td>
</tr>
<tr>
<td class="instructionName"> /preset/out </td>
<td class="instructionType"> generic </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> N/A </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> returns the ouptput of pattrstorage object </td>
</tr>
<tr>
<td class="instructionName"> /receive </td>
<td class="instructionType"> generic </td>
<td class="instructionRange"> default </td>
<td class="instructionClipmode"> none </td>
<td class="instructionRamp"> N/A </td>
<td class="instructionRepetitions"> yes </td>
<td class="instructionDescription"> OpenSoundControl messages coming in from the network are reported here. </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