Cue: complete the Follow Action documentation

This commit is contained in:
Alexandre Prokoudine 2022-07-12 19:20:56 +03:00 committed by Paul Davis
parent 00dfe7684b
commit ed55220976
8 changed files with 76 additions and 31 deletions

View File

@ -1,48 +1,93 @@
<h2>Follow Actions</h2>
<p>When the contents of one trigger slots has been played a user-defined number of times, Ardour can stop playing trigger slots or switch to a different trigger slot. This is defined by follow actions, i.e. actions follow the playback of a trigger slot.</p>
<p>
Here are the currently available follow actions:
When the contents of one trigger slot has been played a user-defined
number of times, Ardour can do one of the two things: stop playing
or switch to a different trigger slot. This is defined by follow actions.
A commonly used follow action is playing a clip in the next trigger slot
down the grid.
</p>
<p>FIXME THE ENTIRE TABLE</p>
<p>
Here are the currently available follow actions. Please note that to help
distinguishing between them, Ardour will display an icon next to the name
of a clip in a slot:
</p>
<table class="dl">
<tr><th><kbd class="menu">None</kbd></th>
<td>Play the contents of the slot once and stop</td></tr>
<tr><th><kbd class="menu">Stop</kbd></th>
<td>Stop after playing back the amount of times set with Follow Count or via Follow Length (see below)</td></tr>
<tr><th><kbd class="menu">Again</kbd></th>
<td>Repeat the contents of the trigger slot over and over again</td></tr>
<tr><th><kbd class="menu">Reverse</kbd></th>
<td>Play back and go to the previous trigger slot</td></tr>
<tr><th><kbd class="menu">Forward</kbd></th>
<td>Play back and go to the next trigger slot</td></tr>
<tr><th><kbd class="menu">Jump</kbd></th>
<td>Play back and jump to a particular scene. Selecting multi-jump and multiple trigger slots will result in randomly playing one of the selected slots.</td></tr>
<table>
<tr>
<th><kbd class="menu">None</kbd></th>
<td width="100px">No icon</td>
<td>Play the contents of the slot once and stop</td></tr>
<tr>
<th><kbd class="menu">Stop</kbd></th>
<td width="100px"><img src="/images/follow-action-icons-stop.png" /></td>
<td>Stop after playing back the amount of times set with Follow Count
or via Follow Length (see below)</td></tr>
<tr>
<th><kbd class="menu">Again</kbd></th>
<td width="100px"><img src="/images/follow-action-icons-again.png" /></td>
<td>Repeat the contents of the trigger slot over and over again</td></tr>
<tr>
<th><kbd class="menu">Reverse</kbd></th>
<td width="100px"><img src="/images/follow-action-icons-reverse.png" /></td>
<td>Play back and go to the previous trigger slot</td></tr>
<tr>
<th><kbd class="menu">Forward</kbd></th>
<td width="100px"><img src="/images/follow-action-icons-forward.png" /></td>
<td>Play back and go to the next trigger slot</td></tr>
<tr>
<th><kbd class="menu">Jump</kbd></th>
<td width="100px">
<img src="/images/follow-action-icons-jump-cue-e.png" />&nbsp;
<img src="/images/follow-action-icons-jump-multi.png" />
</td>
<td>Play back and jump to a particular scene. Selecting multi-jump
and multiple trigger slots will result in randomly playing one of
the selected slots.</td>
</tr>
</table>
<p>To help distinguishing between them, Ardour will display an icon next to the name of a clip in a slot:</p>
<figure>
<img style="width:150px;" src="/images/cue-follow-actions-all-icons.png" alt="Follow Action icons">
<figcaption>
Follow action icons, top to bottom: None, Stop, Again, Reverse, Forward, Jump to scene B, Multi-Jump
</figcaption>
</figure>
<p>
Note that you can set the follow action right in the grid. For that,
click the icon that corresponds to the currently selected follow action
for a slot and choose a different one in the newly opened menu.
</p>
<h2>Follow Actions Probability</h2>
<p>Ardour can help you explore ideas by bringing an element of randomness. You can set two possible follow actions to randonly alternate between, then set the percentage of probability of the left or the right follow action to be triggered. 0% means the left follow action is always chosen, 100% means the right follow action is always chosen. Anything between 0% and 50% will skew the probability towards the left follow action, anything between 50% and 100% will do the same for the right follow action.</p>
<p>
Ardour can help you explore ideas by bringing an element of randomness.
You can set two possible follow actions to randonly alternate between,
then set the percentage of probability of the left or the right follow
action to be triggered.
</p>
<h2>Duration</h2>
<ul>
<li>0% means the left follow action is always chosen</li>
<li>100% means the right follow action is always chosen</li>
<li>Anything between 0% and 50% will skew the probability towards the
left follow action</li>
<li>Anything between 50% and 100% will do the same for the right follow
action</li>
</ul>
<p>Follow Count</p>
<h2>Playback Duration</h2>
<p>How many times to repeat a clip before triggering the Follow Action. FIXME</p>
<p>
There are two options here that affect the playback duration one way
or another.
</p>
<p>Follow Length: [] beats</p>
<p>
<dfn>Follow Count</dfn> defines how many times a clip will be played
back before triggering the follow action.
</p>
<p>When enabled, follow length is used instead of clip length. FIXME</p>
<p>
<dfn>Follow Length</dfn> overrides clip length and defines the new one
in beats. By default it's as long as the clip is long. Making this value
lower will cut the clip short, making it longer will add some silence
at the end of the clip.
</p>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 716 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 656 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 651 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 669 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 656 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 625 B