Skip to content

Commit

Permalink
Add documentation of -bundle option in OSC.
Browse files Browse the repository at this point in the history
  • Loading branch information
sletz committed Apr 18, 2024
1 parent 5f700ce commit 02e8c3b
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -465,5 +465,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>

<!--
MkDocs version : 1.4.3
Build Date UTC : 2024-04-04 09:09:51.744520+00:00
Build Date UTC : 2024-04-18 16:20:29.247232+00:00
-->
1 change: 1 addition & 0 deletions docs/manual/osc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,7 @@ <h2 id="simple-example">Simple Example</h2>
to this host.</li>
<li><code>-xmit 0|1|2</code> turns transmission OFF, ALL, or ALIAS (default OFF). When transmission is OFF, input elements can be controlled using their addresses or aliases (if present). When transmission is ALL, input elements can be controlled using their addresses or aliases (if present), user's actions and output elements (i.e., <code>bargraph</code>, etc.) are transmitted as OSC messages as well as aliases (if present). When transmission is ALIAS, input elements can only be controlled using their aliases, user's actions and output elements are transmitted as aliases only.</li>
<li><code>-xmitfilter path</code> allows to filter output messages. Note that <code>path</code> can be a regular expression (like <code>/freeverb/Reverb1/*</code>).</li>
<li><code>-bundle 0|1</code> activates the bundle mode where all transmitted values are sent in a single message, to be used together with the <code>-xmit</code> option.</li>
</ul>
<p>For example:</p>
<pre><code>./noise -xmit 1 -desthost 192.168.1.104 -outport 6000
Expand Down
11 changes: 6 additions & 5 deletions docs/qreference/7-osc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -501,12 +501,13 @@ <h2 id="a-simple-example">A simple example</h2>
<p>Note that if a <span class="lstinline"> declare name \"Foo\"; </span> line is present in the DSP program, <span class="lstinline">Foo</span> will be used as the OSC root name, otherwise the DSP filename will be used instead.</p>
<p>These OSC parameters can be changed from the command line using one of the following options:</p>
<ul>
<li><span class="lstinline">-port number</span> set the port number used by the application to receive messages.</li>
<li><span class="lstinline">-outport number</span> set the port number used by the application to transmit messages.</li>
<li><span class="lstinline">-errport number</span> set the port number used by the application to transmit error messages.</li>
<li><span class="lstinline">-desthost host</span> set the destination host for the messages sent by the application. Note that the destination address can be changed with the first incoming message: first received packet from another host sets the destination address to this host.</li>
<li><span class="lstinline">-xmit 0|1|2</span> turn transmission OFF, ALL, or ALIAS (default OFF). When transmission is OFF, input elements can be controlled using their addresses or aliases (if present). When transmission is ALL, input elements can be controlled using their addresses or aliases (if present), user's actions and output elements (bargraph) are transmitted as OSC messages as well as aliases (if present). When transmission is ALIAS, input elements can only be controlled using their aliases, user's actions and output elements (bargraph) are transmitted as aliases only.</li>
<li><span class="lstinline">-port number</span> sets the port number used by the application to receive messages.</li>
<li><span class="lstinline">-outport number</span> sets the port number used by the application to transmit messages.</li>
<li><span class="lstinline">-errport number</span> sets the port number used by the application to transmit error messages.</li>
<li><span class="lstinline">-desthost host</span> set sthe destination host for the messages sent by the application. Note that the destination address can be changed with the first incoming message: first received packet from another host sets the destination address to this host.</li>
<li><span class="lstinline">-xmit 0|1|2</span> turns transmission OFF, ALL, or ALIAS (default OFF). When transmission is OFF, input elements can be controlled using their addresses or aliases (if present). When transmission is ALL, input elements can be controlled using their addresses or aliases (if present), user's actions and output elements (bargraph) are transmitted as OSC messages as well as aliases (if present). When transmission is ALIAS, input elements can only be controlled using their aliases, user's actions and output elements (bargraph) are transmitted as aliases only.</li>
<li><span class="lstinline">-xmitfilter path</span> allows to filter output messages. Note that 'path' can be a regular expression (like "/freeverb/Reverb1/*").</li>
<li><span class="lstinline">-bundle 0|1</span> activates the bundle mode where all transmitted values are sent in a single message, to be used together with the <span class="lstinline">-xmit</span> option.</li>
</ul>
<p>For example:</p>
<pre><code> ./noise -xmit 1 -desthost 192.168.1.104 -outport 6000
Expand Down
2 changes: 1 addition & 1 deletion docs/search/search_index.json

Large diffs are not rendered by default.

Binary file modified docs/sitemap.xml.gz
Binary file not shown.
11 changes: 6 additions & 5 deletions quick-reference/chapters/osc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,13 @@ \section{A simple example}
% -xmit 0|1|2
%\end{lstlisting}
\begin{itemize}
\item \lstinline'-port number' set the port number used by the application to receive messages.
\item \lstinline'-outport number' set the port number used by the application to transmit messages.
\item \lstinline'-errport number' set the port number used by the application to transmit error messages.
\item \lstinline'-desthost host' set the destination host for the messages sent by the application. Note that the destination address can be changed with the first incoming message: first received packet from another host sets the destination address to this host.
\item \lstinline'-xmit 0|1|2' turn transmission OFF, ALL, or ALIAS (default OFF). When transmission is OFF, input elements can be controlled using their addresses or aliases (if present). When transmission is ALL, input elements can be controlled using their addresses or aliases (if present), user's actions and output elements (bargraph) are transmitted as OSC messages as well as aliases (if present). When transmission is ALIAS, input elements can only be controlled using their aliases, user's actions and output elements (bargraph) are transmitted as aliases only.
\item \lstinline'-port number' sets the port number used by the application to receive messages.
\item \lstinline'-outport number' sets the port number used by the application to transmit messages.
\item \lstinline'-errport number' sets the port number used by the application to transmit error messages.
\item \lstinline'-desthost host' set sthe destination host for the messages sent by the application. Note that the destination address can be changed with the first incoming message: first received packet from another host sets the destination address to this host.
\item \lstinline'-xmit 0|1|2' turns transmission OFF, ALL, or ALIAS (default OFF). When transmission is OFF, input elements can be controlled using their addresses or aliases (if present). When transmission is ALL, input elements can be controlled using their addresses or aliases (if present), user's actions and output elements (bargraph) are transmitted as OSC messages as well as aliases (if present). When transmission is ALIAS, input elements can only be controlled using their aliases, user's actions and output elements (bargraph) are transmitted as aliases only.
\item \lstinline'-xmitfilter path' allows to filter output messages. Note that 'path' can be a regular expression (like "/freeverb/Reverb1/*").
\item \lstinline'-bundle 0|1' activates the bundle mode where all transmitted values are sent in a single message, to be used together with the \lstinline'-xmit' option.
\end{itemize}

For example:
Expand Down
Binary file modified quick-reference/faust-quick-reference.pdf
Binary file not shown.

0 comments on commit 02e8c3b

Please sign in to comment.