]> Shamusworld >> Repos - ardour-manual/blob - include/osc58-custom-strips.html
update supported format page
[ardour-manual] / include / osc58-custom-strips.html
1
2 <p>
3         It is sometimes desirable to work only with a set of strips out of the whole
4         list of available strips. This could be in any case where there is more than
5         one engineer and one of them is responsible for only a group of strips such
6         as all percussion, all sound effects, choir only, orchestra only, etc.
7 </p>
8 <p class="note">
9         New Ardour 6.0
10 </p>
11 <p>
12         After a strip is added to the custom strip list, it will retain the same
13         SSID for the life of the session so long as banking is not used. If a strip
14         is removed it will leave a gap in the SSID list. Custom strip lists do
15         not survive a session reload and need to be recreated at session start.
16 </p>
17 <p class="note">
18         A custom strip list will only affect the surface that sets it. Any
19         other surface will continue to operate on all strips or may have it's
20         own set of custom strips.
21 </p>
22 <p>
23         The commands below control the use of a custom strip set.
24 </p>
25
26 <table class="dl">
27   <tr><th><kbd class="osc">/strip/listen <em>ssid</em> <em>...</em></kbd></th>
28   <td>where <em>ssid</em> is an integer or list of integers representing
29   tracks to add to the custom track list</td></tr>
30   <tr><th><kbd class="osc">/strip/ignore <em>ssid</em>  <em>...</em></kbd></th>
31   <td>where <em>ssid</em> is an integer or list of integers representing
32   tracks to remove from the custom track list</td></tr>
33   <tr><th><kbd class="osc">/strip/custom/mode <em>mode</em></kbd></th>
34   <td>where <em>mode</em> is an integer representing the desired mode
35   of custom strips.</td></tr>
36   <tr><th><kbd class="osc">/strip/custom/clear </kbd></th>
37   <td>disables custom strips and clears the previously set custom strip list</td></tr>
38 </table>
39
40 <h2>Setting up a custom strip set</h2>
41 <p>
42         The control surface may set up a custom strip list all at once or one
43         strip at a time. A control surface that uses banking would probably
44         be best served by setting up one strip at a time, while one that does
45         no banking (bank_size = 0) and uses <code>/strip/list</code> would
46         probably be best served by having them all selected at once.
47 </p>
48 <ul>
49  <li>
50          <p>One at a time example:</p>
51          <code>/strip/listen 2</code>
52          <p>adds strip 2 to custom strip list</p>
53  </li>
54  <li>
55          <p>Many at a time example:</p>
56          <code>/strip/listen 2 4 6 8</code>
57          <p>Adds strips 2, 4, 6 and 8 to the custom strip list</p>
58  </li>
59 </ul>
60 <p class="note">
61         <code>/strip/listen</code> will only work with custom enable turned off.
62         Using <code>/strip/listen</code> while in custom mode will have no effect.
63 </p>
64 <h2>Using the custom strip set</h2>
65 <p>
66         Once the custom strip set has been set up as shown above, it must be enabled.
67         This is done from the control surface with the <code>/strip/custom/mode <em>mode</em></code>
68         OSC command. <em>Mode</em> may be <em>0</em>: Off, <em>1</em>: Use custom
69         strip set in selected order or <em>2</em>: Use custom strip set
70         in mixer order. <code>/strip/list</code> will now show the custom strip list
71         and and its SSIDs. No more strips may be added to the custom strip list while
72         in custom mode. To add more strips to the end of the list, first send the
73         <code>/strip/custom/mode 0</code> then more strips can be added to the end
74         of the list. After adding the next strips send the
75         <code>/strip/custom/mode <em>mode</em></code>
76         to re-enable custom mode. It is possible to switch back and forth between
77         normal and custom mode as desired.
78 </p>
79 <h3>Custom Strip ordering</h3>
80 <p>
81         The ordering of strips in the custom strip set is affected by both the
82         custom <code>mode</code> and the <code>bank_size</code> setting for the
83         surface.
84 </p>
85 <p class="note">
86         A <code>bank_size</code> of <em>0</em> is also described as having
87         banking turned off. In such a case all strips are shown.
88 </p>
89 <ul>
90   <li>
91         <h4>Mode 0</h4>
92         <p>
93                 Custom mode <em>Off</em>. All strips will be used as set by
94                 <code>strip_types</code>.
95         </p>
96   </li>
97   <li>
98         <h4>Mode 1</h4>
99         <p>
100                 If <code>mode</code> is set to <em>1</em> the custom strip ordering
101                 is always "first come, first served". That is,
102                 <code>/strip/listen 2 4</code> followed by <code>/strip/listen 1 3</code>
103                 will result in strip 2 showing as SSID 1 , strip 4 as SSID 2, strip 1
104                 as SSID 3 and strip 3 as SSID 4 when in custom mode <em>1</em>. Once these SSID are set
105                 in this way, they will remain linked to this SSID with banking turned off and
106                 will at least remain in the same order with banking on.
107         </p>
108   </li>
109   <li>
110         <h4>Mode 2</h4>
111         <p>
112                 If <code>mode</code> is set to <em>2</em> the custom strip ordering
113                 will be set to mixer order and any deleted strips will not leave
114                 a blank strip in the set.
115         </p>
116   </li>
117   <li>
118         <h4>With banking on</h4>
119         <p>
120                 If <code>bank_size</code> is set to greater than <em>0</em>, Then
121                 banking is turned on. In this case <code>strip_types</code> will
122                 be honored and only strips from the custom strip set that match
123                 <code>strip_types</code> will be shown in a bank. However, the
124                 order that the strips appear will still be affected by the
125                 <code>mode</code>.
126         </p>
127   </li>
128 </ul>
129 <h2>Removing a strip from the custom strip list</h2>
130 <p>
131         <code>/strip/ignore ssid</code> will remove that strip from the
132         custom strip list if custom strip use is enabled. In <code>mode</code>
133         <em>1</em> there will be a blank strip at that SSID and all other
134         SSIDs will remain the same for no banking. With banking
135         in use, <code>strip_types</code> are honored and so removed strips
136         which have no type, will not be shown.
137 </p>
138 <p>
139         <code>/strip/custom/clear</code> will remove
140         all strips and SSIDs allowing custom strip lists to be restarted from
141         SSID 1. Custom <code>mode</code> will be set to <em>0</em>.
142 </p>