3 In order to make a custom controller that knows what strips Ardour
4 has, the controller needs to be able to query Ardour for that
5 information. These set of commands are for smarter control surfaces
6 That have the logic to figure out what to do with the information.
7 These are not of value for mapped controllers like touchOSC and
8 friends. The controller will need to send these queries to ardour
9 as often as it needs this information. It may well make sense to use
10 regular feedback for things that need to be updated often such as
12 Here are the commands used to query Ardour: (added in Ardour 5.5)
16 <tr><th><kbd class="osc">/strip/list</kbd></th>
17 <td>Ask for a list of strips</td></tr>
18 <tr><th><kbd class="osc">/strip/sends <em>ssid</em></kbd></th>
19 <td>Asks for a list of sends on the strip <em>ssid</em></td></tr>
20 <tr><th><kbd class="osc">/strip/receives <em>ssid</em></kbd></th>
21 <td>Asks for a list of tracks that have sends to the strip <em>ssid</em> points to</td></tr>
22 <tr><th><kbd class="osc">/strip/plugin/list <em>ssid</em></kbd></th>
23 <td>Asks for a list of plug-ins for strip <em>ssid.</em></td></tr>
24 <tr><th><kbd class="osc">/plugin/descriptor <em>ssid</em> <em>piid</em></kbd></th>
25 <td>Asks for a list of descriptors for plug-in <em>piid</em> on strip <em>ssid</em></td></tr>
28 <h3>A list of strips</h3>
31 <code>/strip/list</code> asks Ardour for a list of strips that the
32 current session has. Ardour replies with a message for each
33 strip with the following information:
35 <li>Strip type - One of:</li>
37 <li>AT - Audio Track</li>
38 <li>MT - MIDI Track</li>
39 <li>B - Audio Bus</li>
40 <li>MB - MIDI bus</li>
45 <li>Number of inputs</li>
46 <li>Number of outputs</li>
49 <li>Ssid (strip number)</li>
50 <li>Record enabled</li>
52 After all the strip messages have been sent, one final message is
55 <li>The text <code>end_route_list</code></li>
56 <li>The session frame rate</li>
57 <li>The last frame number of the session</li>
58 <li>Monitor section present</li>
62 The <code>/set_surface</code> should be set before this is called. That way
63 The right set of strips will be sent in return (though the default is good
64 for most uses) and feedback will start correctly.
67 If the surface is using <code>/strip/list</code>, the surface needs to know
68 if the strips have changed. This would be true if a strip gets moved, created or
69 deleted. When this happens Ardour sends <code>/strip/list</code> to the surfaces
70 that have previously requested a <code>/strip/list</code>. This lets the
71 surface know that it's list of strips is no longer valid.
73 <p class="note">A bus will not have a record enable and so a bus message
74 will have one less parameter than a track. It is the controllers
75 responsability to deal with this.
78 <h3>A list of sends</h3>
80 <code>/strip/sends <em>ssid</em></code> asks Ardour for a list of
81 sends for strip number ssid. The reply is sent back to the
82 controller as one message with the following information:
84 <li>Ssid that information is for</li>
85 <li>Each send's information:</li>
87 <li>The send's target bus ssid</li>
88 <li>The send's target bus name</li>
89 <li>The send id for this strip</li>
90 <li>The send gain as a fader possition</li>
91 <li>The Send's enable state</li>
96 The controller can tell how many sends there are from the number of
97 parameters as each send has 5 parameters and there is one extra for
101 <h3>A list if tracks that send audio to a bus</h3>
103 <code>/strip/receives <em>ssid</em></code> will return a list of
104 tracks that have sends to the bus at the ssid. The reply will
105 contain the following information for each track conntected to this
108 <li>The ssid of the track sending</li>
109 <li>The name of the sending track</li>
110 <li>The id of the send at that track</li>
111 <li>It's gain in fader possition</li>
112 <li>The send's enable state</li>
116 <h3>A list of plug-ins for strip</h3>
118 <code>/strip/plugin/list <em>ssid</em></code> will return a list of
119 plug-ins that strip ssid has. The reply will contain the following
122 <li>Ssid that information is for</li>
123 <li>Each plugin's information:</li>
125 <li>The plug-in's id</li>
126 <li>The plug-in's name</li>
131 <h3>A list of a plug-in's parameters</h3>
133 <code>/plugin/descriptor <em>ssid</em> <em>piid</em></code> will
134 return the plug-in parameters for ppid plug-in on the ssid strip. The
135 reply will contain the following information:
137 <li>Ssid of the strip the plug-in is in</li>
138 <li>The plug-in id for the plug-in</li>
139 <li>The plug-in's name</li>
140 <li>Information about each parameter</li>
142 <li>The parameter id</li>
143 <li>The parameter's name</li>
144 <li>A bitset of flags (see below)</li>
146 <li>Minimum value</li>
147 <li>Maximum value</li>
148 <li>The number of scale points</li>
149 <li>zero or more scale points of one value and one string each</li>
150 <li>The current parameter value</li>
155 The flag bitset above has been defined as (from lsb):
157 <li>0—enumeration</li>
158 <li>1—integer step</li>
159 <li>2—logarithmic</li>
160 <li>3—max unbound</li>
161 <li>4—min unbound</li>
162 <li>5—sample rate dependent</li>
163 <li>6—toggled</li>
164 <li>7—controllable</li>
168 While this seems complex, it is really not that bad. Minimum,
169 maximum and value will in most cases give you all you need.