Copy local state in AudioRegionView copy constructor. Fixes #4047.
[ardour2.git] / manual / xml / frontier_design_tranzport.xml
blob675999f17bebb6868f77d1905b6b48772c870af1
1 <?xml version="1.0" standalone="no"?>
3 <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
5 ]>
7 <section id="sn-frontier-design-tranzport">
8   <title>Using a Frontier Design Tranzport</title>
9   <section id="tranzport-configuration">
10     <title>Enabling a Tranzport</title>
11     <para>
12       Ardour 2.0 can currently use a single Tranzport controller. Ensure
13       that the device is plugged into a functional USB port. On Linux you
14       will need to <link linkend="sn-configuring-usb-device-access">take
15       steps</link> to ensure that non-administrative users can access the
16       device. Note that this feature is <emphasis>not</emphasis> available
17       in Ardour 0.99.x.
18     </para>
20     <para>
21       In the Options menu, navigate into the Control Surfaces submenu. Click
22       on the "Tranzport" option to enable use of the control surface within
23       Ardour. To disable it, click on this item a second time.
24     </para>
25   </section>
27   <section id="tranzport-buttons-and-wheel-functions">
28     <title>Tranzport Buttons and Datawheel functions</title>
29     <table id="tbl-tranzport-functions">
30       <title>Tranzport Functions</title>
31       <tgroup cols = "3">
32         <colspec colnum="1" colname = "Key Binding" colwidth = "1"/>
33         <colspec colnum="2" colname="Action" colwidth= "2"/>
34         <thead>
35           <row>
36             <entry>
37               Key
38             </entry>
40             <entry>
41               Normal Click
42             </entry>
44             <entry>
45               Shift Click
46             </entry>
47           </row>
48         </thead>
49         <tbody>
50           <row>
51             <entry>
52               <para>
53                 REW
54               </para>
55             </entry>
57             <entry>
58               <para>
59                 Rewind
60               </para>
61             </entry>
63             <entry>
64               <para>
65                 Go to start
66               </para>
67             </entry>
68           </row>
70           <row>
71             <entry>
72               <para>
73                 FFWD
74               </para>
75             </entry>
77             <entry>
78               <para>
79                 Fast forward
80               </para>
81             </entry>
83             <entry>
84               <para>
85                 Go to end
86               </para>
87             </entry>
88           </row>
90           <row>
91             <entry>
92               <para>
93                 STOP
94               </para>
95             </entry>
97             <entry>
98               <para>
99                 Stop
100               </para>
101             </entry>
103             <entry>
104               <para>
105                 Enter *
106               </para>
107             </entry>
108           </row>
110           <row>
111             <entry>
112               <para>
113                 PLAY
114               </para>
115             </entry>
117             <entry>
118               <para>
119                 Play
120               </para>
121             </entry>
123             <entry>
124               <para>
125                 Save
126               </para>
127             </entry>
128           </row>
130           <row>
131             <entry>
132               <para>
133                 RECORD
134               </para>
135             </entry>
137             <entry>
138               <para>
139                 Record
140               </para>
141             </entry>
143             <entry>
144               <para></para>
145             </entry>
146           </row>
148           <row>
149             <entry></entry>
151             <entry></entry>
153             <entry></entry>
154           </row>
156           <row>
157             <entry>
158               <para>
159                 PREV
160               </para>
161             </entry>
163             <entry>
164               <para>
165                 Go to previous marker
166               </para>
167             </entry>
169             <entry>
170               <para>
171                 Zoom full
172               </para>
173             </entry>
174           </row>
176           <row>
177             <entry>
178               <para>
179                 ADD
180               </para>
181             </entry>
183             <entry>
184               <para>
185                 Add marker at current location
186               </para>
187             </entry>
189             <entry>
190               <para></para>
191             </entry>
192           </row>
194           <row>
195             <entry>
196               <para>
197                 NEXT
198               </para>
199             </entry>
201             <entry>
202               <para>
203                 Go to next marker
204               </para>
205             </entry>
207             <entry>
208               <para>
209                 Select normal, scrub or shuttle mode
210               </para>
211             </entry>
212           </row>
214           <row>
215             <entry></entry>
217             <entry></entry>
219             <entry></entry>
220           </row>
222           <row>
223             <entry>
224               <para>
225                 IN
226               </para>
227             </entry>
229             <entry>
230               <para></para>
231             </entry>
233             <entry>
234               <para>
235                 Zoom In
236               </para>
237             </entry>
238           </row>
240           <row>
241             <entry>
242               <para>
243                 OUT
244               </para>
245             </entry>
247             <entry>
248               <para></para>
249             </entry>
251             <entry>
252               <para>
253                 Zoom Out
254               </para>
255             </entry>
256           </row>
258           <row>
259             <entry>
260               <para>
261                 PUNCH
262               </para>
263             </entry>
265             <entry>
266               <para></para>
267             </entry>
269             <entry>
270               <para></para>
271             </entry>
272           </row>
274           <row>
275             <entry>
276               <para>
277                 LOOP
278               </para>
279             </entry>
281             <entry>
282               <para></para>
283             </entry>
285             <entry>
286               <para>
287                 Select gain/pan/master level mode
288               </para>
289             </entry>
290           </row>
292           <row>
293             <entry></entry>
295             <entry></entry>
297             <entry></entry>
298           </row>
300           <row>
301             <entry>
302               <para>
303                 &lt; TRACK
304               </para>
305             </entry>
307             <entry>
308               <para>
309                 Previous track
310               </para>
311             </entry>
313             <entry>
314               <para></para>
315             </entry>
316           </row>
318           <row>
319             <entry>
320               <para>
321                 TRACK &gt;
322               </para>
323             </entry>
325             <entry>
326               <para>
327                 Next track
328               </para>
329             </entry>
331             <entry>
332               <para></para>
333             </entry>
334           </row>
336           <row>
337             <entry>
338               <para>
339                 REC
340               </para>
341             </entry>
343             <entry>
344               <para>
345                 Toggle track's record enable on/off
346               </para>
347             </entry>
349             <entry>
350               <para>
351                 Clear all track record arming
352               </para>
353             </entry>
354           </row>
356           <row>
357             <entry>
358               <para>
359                 MUTE
360               </para>
361             </entry>
363             <entry>
364               <para>
365                 Toggle track's mute status on/off
366               </para>
367             </entry>
369             <entry>
370               <para>
371                 Clear all mutes
372               </para>
373             </entry>
374           </row>
376           <row>
377             <entry>
378               <para>
379                 SOLO
380               </para>
381             </entry>
383             <entry>
384               <para>
385                 Toggle track's solo status on/off
386               </para>
387             </entry>
389             <entry>
390               <para>
391                 Clear all solos
392               </para>
393             </entry>
394           </row>
396           <row>
397             <entry>
398               <para>
399                 UNDO
400               </para>
401             </entry>
403             <entry>
404               <para>
405                 Undo
406               </para>
407             </entry>
409             <entry>
410               <para>
411                 Redo
412               </para>
413             </entry>
414           </row>
416           <row>
417             <entry></entry>
419             <entry></entry>
421             <entry></entry>
422           </row>
424           <row>
425             <entry>
426               <para>
427                 DATA WHEEL
428               </para>
429             </entry>
431             <entry>
432               <para>
433                 scroll timeline, scrub or shuttle
434               </para>
435             </entry>
437             <entry>
438               <para>
439                 adjust track gain, track pan or master gain
440               </para>
441             </entry>
442           </row>
444           <row>
445             <entry></entry>
447             <entry></entry>
449             <entry></entry>
450           </row>
452           <row>
453             <entry>
454               <para>
455                 FOOTSWITCH
456               </para>
457             </entry>
459             <entry>
460               <para></para>
461             </entry>
463             <entry>
464               <para></para>
465             </entry>
466           </row>
467         </tbody>
468       </tgroup>
469     </table>
470   </section>
472   <section id="tranzport-normal-scrub-shuttle-modes">
473     <title>Normal, Scrub and Shuttle Modes</title>
474     <para>
475       In Ardour, the Tranzport in has 3 different modes of operation termed
476       "timeline", "scrub" and "shuttle".
477     </para>
479     <variablelist>
480       <title>Tranzport Modes of Operation</title>
481       <varlistentry>
482         <term>Timeline</term>
483         <listitem>
484           <para>
485             the data wheel scrolls the timeline in the editor window back
486             and forth.
487           </para>
488         </listitem>
489       </varlistentry>
491       <varlistentry>
492         <term>Scrub</term>
493         <listitem>
494           <para>
495             the data wheel is used to scrub audio data back and forth.
496           </para>
497         </listitem>
498       </varlistentry>
500       <varlistentry>
501         <term>Shuttle</term>
502         <listitem>
503           <para>
504             the data wheel is used to control varispeed playback. Turning
505             the data wheel clockwise increases the playback speed in a
506             forward direction. Counter-clockwise decreases the speed and
507             will reverse playback. Shuttle mode as several important
508             features:
509             <itemizedlist>
510               <listitem>
511                 <para>
512                   While in Shuttle mode the actual playback speed will be
513                   displayed in the top right corner of the LCD as a
514                   percentage of real-time, ie. +100% is normal playback
515                   speed.
516                 </para>
517               </listitem>
519               <listitem>
520                 <para>
521                   Press STOP to automatically set the Shuttle speed to 0%.
522                 </para>
523               </listitem>
525               <listitem>
526                 <para>
527                   Press PLAY to automatically set the Shuttle speed to
528                   +100%.
529                 </para>
530               </listitem>
532               <listitem>
533                 <para>
534                   Press and hold SHIFT to momentarily toggle the TranzPort
535                   into Scrub mode. Releasing the SHIFT button will return to
536                   Shuttle mode at 0% speed. This combination of functions is
537                   very useful for quickly moving through an audio track and
538                   accurately locating points hit points.
539                 </para>
540               </listitem>
542               <listitem>
543                 <para>
544                   Pressing ADD will drop a marker at the current location
545                   and exit Shuttle mode
546                 </para>
547               </listitem>
548             </itemizedlist>
549           </para>
550         </listitem>
551       </varlistentry>
552     </variablelist>
553   </section>
554 <!--
555         <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
556                 href="Some_Subsection.xml" />
557         -->
558 </section>