Added documentation for automation modes in OSC

This commit is contained in:
Len Ovens 2017-05-15 10:36:36 -07:00
parent 743b93f203
commit f748342d8f
4 changed files with 63 additions and 0 deletions

View File

@ -0,0 +1,43 @@
<h3>OSC Automation</h3>
<p>
Ardour has automation modes for many of it's controls. As of version
5.9, OSC can control what automation mode a fader uses.
(<a href="@@automation">See Automation.</a>)
</p>
<p>
The form of the automation mode command is:
</p>
<p>
<code>/strip/[control]/automation ii ssid mode</code>
</p>
<p>
<ul>
<li>/strip may also be /select in which case the only parameter is the mode.</li>
<li>[control] as of Ardour version 5.9 control can be:
<ul>
<li>gain</li>
<li>fader</li>
</ul>
This list will expand.
</li>
<li>ssid can be a parameter as shown or inline (automation/[ssid]). /select has no ssid.</li>
<li>mode can be one of:
<ul>
<li><code>0</code> Manual mode</li>
<li><code>1</code> Play mode</li>
<li><code>2</code> Write mode</li>
<li><code>3</code> Touch mode</li>
</ul>
The mode value may be sent as a float allowing a "pot" or "slider" with a range of
0 to 3 to be used to control mode.
</li>
</ul>
</p>
<p>
The next version of Ardour will add <code>/strip/[control]/automation_name is ssid mode_name</code>
as feedback. A surface may choose to use only the first character of the string (M, P, W or T) instead of
the whole string. (this is in git now)
</p>

View File

@ -351,6 +351,9 @@ here</em>"/&gt;</kbd>
<td>where <em>gain</em> is a float ranging from -193 to 6 representing the desired gain of the track in dB.</td></tr>
<tr><th><kbd class="osc">/strip/fader <em>ssid</em> <em>position</em></kbd></th>
<td>where <em>position</em> is a float ranging from 0 to 1 representing the fader control position.</td></tr>
<tr><th><kbd class="osc">/strip/*/automation <em>ssid</em> <em>mode</em></kbd></th>
<td>where <em>mode</em> is an int ranging from 0 to 3 representing the desired automation mode for the control.
<a href="@@osc58-automation">See OSC Automation.</a></td></tr>
<tr><th><kbd class="osc">/strip/trimdB <em>ssid</em> <em>trim_db</em></kbd></th>
<td>where <em>trim_db</em> is a float ranging from -20 to 20 representing the desired trim of the track in dB.</td></tr>
<tr><th><kbd class="osc">/strip/pan_stereo_position <em>ssid</em> <em>position</em></kbd></th>
@ -457,6 +460,9 @@ here</em>"/&gt;</kbd>
<td>Where <em>gain</em> is a float ranging from -193 to 6 representing the desired gain of the track in dB.</td></tr>
<tr><th><kbd class="osc">/select/fader <em>position</em></kbd></th>
<td>Where <em>position</em> is an float ranging from 0 to 1 representing the fader control position.</td></tr>
<tr><th><kbd class="osc">/select/*/automation <em>mode</em></kbd></th>
<td>where <em>mode</em> is an int ranging from 0 to 3 representing the desired automation mode for the control.
<a href="@@osc58-automation">See OSC Automation.</a></td></tr>
<tr><th><kbd class="osc">/select/trimdB <em>trim_db</em></kbd></th>
<td>where <em>trim_db</em> is a float ranging from -20 to 20 representing the desired trim of the track in dB.</td></tr>
<tr><th><kbd class="osc">/select/pan_stereo_position <em>position</em></kbd></th>

View File

@ -83,6 +83,9 @@
<table class="dl">
<tr><th><kbd class="osc">/strip/name <em>ssid</em> <em>track_name</em></kbd></th>
<td>where <em>track_name</em> is a string representing the name of the track</td></tr>
<tr><th><kbd class="osc">/strip/*/automation_name <em>ssid</em> <em>name</em></kbd></th>
<td>where <em>name</em> is a string representing the current automation mode for the control.
<a href="@@osc58-automation">See OSC Automation.</a></td></tr>
<tr><th><kbd class="osc">/session_name <em>session_name</em></kbd></th>
<td>where <em>session_name</em> is a string representing the name of the session</td></tr>
<tr><th><kbd class="osc">/strip/meter <em>ssid</em> <em>meter</em></kbd></th>
@ -200,6 +203,9 @@
<td>where <em>gain</em> is a float ranging from -193 to 6 representing the actual gain of the track in dB.</td></tr>
<tr><th><kbd class="osc">/strip/fader <em>ssid</em> <em>position</em></kbd></th>
<td>where <em>position</em> is an float ranging from 0 to 1 representing the actual fader position of the track.</td></tr>
<tr><th><kbd class="osc">/strip/*/automation <em>ssid</em> <em>mode</em></kbd></th>
<td>where <em>mode</em> is an int ranging from 0 to 3 representing the actual automation mode for the control.
<a href="@@osc58-automation">See OSC Automation.</a></td></tr>
<tr><th><kbd class="osc">/strip/trimdB <em>ssid</em> <em>trim_db</em></kbd></th>
<td>where <em>trim_db</em> is a float ranging from -20 to 20 representing the actual trim of the track in dB.</td></tr>
<tr><th><kbd class="osc">/strip/pan_stereo_position <em>ssid</em> <em>position</em></kbd></th>

View File

@ -2100,6 +2100,14 @@ uri: using-control-surfaces/controlling-ardour-with-osc/jog-modes
part: subchapter
---
---
title: OSC&#58; Automation
include: osc58-automation.html
link: osc58-automation
uri: using-control-surfaces/controlling-ardour-with-osc/automation
part: subchapter
---
---
title: OSC&#58; Personal Monitoring Control
include: osc58-personal-monitoring-control.html