From f748342d8f02f3cb9b07e498e00ea8631e66f581 Mon Sep 17 00:00:00 2001
From: Len Ovens
Date: Mon, 15 May 2017 10:36:36 -0700
Subject: [PATCH] Added documentation for automation modes in OSC
---
include/osc58-automation.html | 43 +++++++++++++++++++
.../osc58-controlling-ardour-with-osc.html | 6 +++
include/osc58-feedback.html | 6 +++
master-doc.txt | 8 ++++
4 files changed, 63 insertions(+)
create mode 100644 include/osc58-automation.html
diff --git a/include/osc58-automation.html b/include/osc58-automation.html
new file mode 100644
index 00000000..bc41510f
--- /dev/null
+++ b/include/osc58-automation.html
@@ -0,0 +1,43 @@
+
+OSC Automation
+
+
+ Ardour has automation modes for many of it's controls. As of version
+ 5.9, OSC can control what automation mode a fader uses.
+ (See Automation.)
+
+
+ The form of the automation mode command is:
+
+
+ /strip/[control]/automation ii ssid mode
+
+
+
+
+ - /strip may also be /select in which case the only parameter is the mode.
+ - [control] as of Ardour version 5.9 control can be:
+
+ This list will expand.
+
+ - ssid can be a parameter as shown or inline (automation/[ssid]). /select has no ssid.
+ - mode can be one of:
+
+ 0
Manual mode
+ 1
Play mode
+ 2
Write mode
+ 3
Touch mode
+
+ 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.
+
+
+
+
+ The next version of Ardour will add /strip/[control]/automation_name is ssid mode_name
+ 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)
+
diff --git a/include/osc58-controlling-ardour-with-osc.html b/include/osc58-controlling-ardour-with-osc.html
index 3bbe7003..3e3cdd40 100644
--- a/include/osc58-controlling-ardour-with-osc.html
+++ b/include/osc58-controlling-ardour-with-osc.html
@@ -351,6 +351,9 @@ here"/>
where gain is a float ranging from -193 to 6 representing the desired gain of the track in dB. |
/strip/fader ssid position |
where position is a float ranging from 0 to 1 representing the fader control position. |
+ /strip/*/automation ssid mode |
+ where mode is an int ranging from 0 to 3 representing the desired automation mode for the control.
+ See OSC Automation. |
/strip/trimdB ssid trim_db |
where trim_db is a float ranging from -20 to 20 representing the desired trim of the track in dB. |
/strip/pan_stereo_position ssid position |
@@ -457,6 +460,9 @@ here"/>
Where gain is a float ranging from -193 to 6 representing the desired gain of the track in dB. |
/select/fader position |
Where position is an float ranging from 0 to 1 representing the fader control position. |
+ /select/*/automation mode |
+ where mode is an int ranging from 0 to 3 representing the desired automation mode for the control.
+ See OSC Automation. |
/select/trimdB trim_db |
where trim_db is a float ranging from -20 to 20 representing the desired trim of the track in dB. |
/select/pan_stereo_position position |
diff --git a/include/osc58-feedback.html b/include/osc58-feedback.html
index 9919cd2b..50547177 100644
--- a/include/osc58-feedback.html
+++ b/include/osc58-feedback.html
@@ -83,6 +83,9 @@
/strip/name ssid track_name |
where track_name is a string representing the name of the track |
+ /strip/*/automation_name ssid name |
+ where name is a string representing the current automation mode for the control.
+ See OSC Automation. |
/session_name session_name |
where session_name is a string representing the name of the session |
/strip/meter ssid meter |
@@ -200,6 +203,9 @@
where gain is a float ranging from -193 to 6 representing the actual gain of the track in dB. |
/strip/fader ssid position |
where position is an float ranging from 0 to 1 representing the actual fader position of the track. |
+ /strip/*/automation ssid mode |
+ where mode is an int ranging from 0 to 3 representing the actual automation mode for the control.
+ See OSC Automation. |
/strip/trimdB ssid trim_db |
where trim_db is a float ranging from -20 to 20 representing the actual trim of the track in dB. |
/strip/pan_stereo_position ssid position |
diff --git a/master-doc.txt b/master-doc.txt
index 0f93576e..83d54285 100644
--- a/master-doc.txt
+++ b/master-doc.txt
@@ -2100,6 +2100,14 @@ uri: using-control-surfaces/controlling-ardour-with-osc/jog-modes
part: subchapter
---
+---
+title: OSC: Automation
+include: osc58-automation.html
+link: osc58-automation
+uri: using-control-surfaces/controlling-ardour-with-osc/automation
+part: subchapter
+---
+
---
title: OSC: Personal Monitoring Control
include: osc58-personal-monitoring-control.html
---|
---|