| 1 |
<?php |
| 2 |
$CTL = $RES_ROOT . "/img/controls/"; |
| 3 |
?> |
| 4 |
<div class="grid-2col-man"> |
| 5 |
<div class="thc-descr"> |
| 6 |
<p>The following picture demonstrates typical Graphical User Interface (GUI) of plugin:</p> |
| 7 |
<img class="plugin" style="max-width: 100%;" src="<?= $RES_ROOT ?>/img/plugins/phase_detector.png"> |
| 8 |
</div> |
| 9 |
<div class="thc-descr"> |
| 10 |
<p>Each plugin consists of the following elements:</p> |
| 11 |
<ul> |
| 12 |
<li><a href="#AudioFile"><b>Audio File</b></a> – audio file chooser and editor.</li> |
| 13 |
<li><a href="#Button"><b>Button</b></a> – button control.</li> |
| 14 |
<li><a href="#Combo"><b>Combo</b></a> – combo box control.</li> |
| 15 |
<li><a href="#ComboGroup"><b>Combo Group</b></a> – combo group control.</li> |
| 16 |
<li><a href="#Fader"><b>Fader</b></a> – fader control.</li> |
| 17 |
<li><a href="#FileSaver"><b>File Saver</b></a> – file saving control.</li> |
| 18 |
<li><a href="#Footer"><b>Footer</b></a> – plugin footer.</li> |
| 19 |
<li><a href="#Fraction"><b>Fraction</b></a> – control for setting musical time signature.</li> |
| 20 |
<li><a href="#Graph"><b>Graph</b></a> – graphical output area.</li> |
| 21 |
<li><a href="#Group"><b>Group</b></a> – group control.</li> |
| 22 |
<li><a href="#Header"><b>Header</b></a> – plugin header.</li> |
| 23 |
<li><a href="#Indicator"><b>Indicator</b></a> – digital LED indicator.</li> |
| 24 |
<li><a href="#InlineDisplay"><b>Inline Display</b></a> – inline display.</li> |
| 25 |
<li><a href="#Knob"><b>Knob</b></a> – rotating knob control.</li> |
| 26 |
<li><a href="#Label"><b>Label</b></a> – label with text information.</li> |
| 27 |
<li><a href="#Led"><b>Led</b></a> – LED.</li> |
| 28 |
<li><a href="#Meter"><b>Meter</b></a> – metering control.</li> |
| 29 |
<li><a href="#Overlay"><b>Overlay</b></a> – widget container.</li> |
| 30 |
<li><a href="#Parameter"><b>Parameter</b></a> – the value of controllable parameter.</li> |
| 31 |
<li><a href="#ProgressBar"><b>Progress Bar</b></a> – progress control.</li> |
| 32 |
<li><a href="#SampleEditor"><b>Sample Editor</b></a> – sample editor.</li> |
| 33 |
<li><a href="#SharedMemoryLink"><b>Shared Memory Link</b></a> – sample editor.</li> |
| 34 |
<li><a href="#TabControl"><b>Tab Control</b></a> – tab control.</li> |
| 35 |
</ul> |
| 36 |
</div> |
| 37 |
</div> |
| 38 |
|
| 39 |
<p>Colors of widgets may vary but the color scheme of widgets often follows these rules:</p> |
| 40 |
<ul> |
| 41 |
<li>Widgets that adjust parameters of similar objects are consolidated into one common group.</li> |
| 42 |
<li>Widgets that control parameters of one object often have similar colors.</li> |
| 43 |
<li>Widgets associated with audio channels often use the following color scheme:</li> |
| 44 |
<ul> |
| 45 |
<li><b style="color:#c344d3">Moderate magenta</b> – for thresholds.</li> |
| 46 |
<li><b style="color:#bf6455">Moderate red</b> – for mono channel and stereo channel (when both left and right channels are controlled at same time).</li> |
| 47 |
<li><b style="color:#d8412a">Strong red</b> and <b style="color:#5072f4">Soft blue</b> – for left and right channels in stereo pair, direct output channel.</li> |
| 48 |
<li><b style="color:#0090a1">Dark cyan</b> and <b style="color:#009700">Dark lime green</b> – for middle and side channels.</li> |
| 49 |
<li><b style="color:#d8412a">Strong red</b> – for left channel in stero pair.</li> |
| 50 |
<li><b style="color:#5072f4">Soft blue</b> – for right channel </li> |
| 51 |
<li><b style="color:#da404a"/>Bright red</b> – for velocity.</li> |
| 52 |
<li><b style="color:#b07000"/>Dark orange</b> – for balance.</li> |
| 53 |
<li><b style="color:#9e60ee"/>Soft violet</b> – for envelopes.</li> |
| 54 |
<li><b style="color:#c65219"/>Strong orange</b> – for sidechain.</li> |
| 55 |
<li><b style="color:#c2487b"/>Moderate pink</b> and <b style="color:#009555"/>Lime green</b>– for attack and release.</li> |
| 56 |
<li><b style="color:#8c8700"/>Olive tone</b> and <b style="color:#368ccc"/>Moderate blue</b> – for dry and wet.</li> |
| 57 |
</ul> |
| 58 |
<li> |
| 59 |
Each widget that allows to set continuous parameters has corresponding label displaying it's current value and, |
| 60 |
optionally, units. |
| 61 |
</li> |
| 62 |
</ul> |
| 63 |
|
| 64 |
<p>Below the detailed description of controls is present.</p> |
| 65 |
|
| 66 |
<section id="AudioFile"> |
| 67 |
<h2>Audio File</h2> |
| 68 |
|
| 69 |
<div class="grid-2col-man"> |
| 70 |
<div class="thc-descr"> |
| 71 |
<p>File widget – initial condition:</p> |
| 72 |
<img class="plugin" style="max-width: 100%;" src="<?= $CTL ?>file_unloaded.png"> |
| 73 |
<p>File widget – error message:</p> |
| 74 |
<img class="plugin" style="max-width: 100%;" src="<?= $CTL ?>file_error.png"> |
| 75 |
<p>File widget – file loaded:</p> |
| 76 |
<img class="plugin" style="max-width: 100%;" src="<?= $CTL ?>file_loaded.png"> |
| 77 |
</div> |
| 78 |
|
| 79 |
<div class="thc-descr"> |
| 80 |
<p> |
| 81 |
AudioFile widget is used for loading and editing audio files. It tells to the plugin the actual location of file on |
| 82 |
file system. |
| 83 |
</p> |
| 84 |
<p> |
| 85 |
By default there is no file associated with plugin, so the file widget displays |
| 86 |
<b style="color: #00909e">'Click or drug to load'</b> text. |
| 87 |
</p> |
| 88 |
<br> |
| 89 |
<p> |
| 90 |
By clicking left mouse button on the widget you may open file choosing dialog and select the file to use by plugin. |
| 91 |
</p> |
| 92 |
<p> |
| 93 |
After the path to the file will be passed to plugin, the plugin starts to load the file, and the status |
| 94 |
displayed by the file widget changes. If file was successfully loaded, file widget will display |
| 95 |
the corresponding content of the file and it's name (without path). On error, error message is displayed |
| 96 |
with red color. |
| 97 |
</p> |
| 98 |
<br> |
| 99 |
<p> |
| 100 |
By clicking right mouse button, popup dialog appears that allows to cut, copy, paste and clear contents of widget |
| 101 |
</p> |
| 102 |
<p> |
| 103 |
There is also the way to force plugin to unload file. For this purpose simply double-click by right |
| 104 |
mouse button on widget's area if popup menu does not appear. |
| 105 |
</p> |
| 106 |
</div> |
| 107 |
</div> |
| 108 |
</section> |
| 109 |
|
| 110 |
<section id="Button"> |
| 111 |
<h2>Button</h2> |
| 112 |
|
| 113 |
<p> |
| 114 |
Buttons are mostly used to turn on/turn off some binary parameter. Rarely they are also used for switching between |
| 115 |
different processing modes (See <?php plugin_ref('comp_delay_mono'); ?> plugin for example). There are two different |
| 116 |
types of buttons: |
| 117 |
</p> |
| 118 |
<ul> |
| 119 |
<li><b>push/pop</b> - these buttons allow to change the state of parameter and keep it until next button push occurs.</li> |
| 120 |
<li><b>trigger</b> - these buttons allow to trigger some event while the button is pressed and return to initial state when the button is released.</li> |
| 121 |
</ul> |
| 122 |
<p> |
| 123 |
Push/pop buttons may be pressed by left mouse button click and do not affect |
| 124 |
any parameter changes until the left mouse button is released over the button widget. |
| 125 |
It is possible to cancel button press by moving mouse cursor out of the widget's area |
| 126 |
or by additionally pressing right mouse button. |
| 127 |
</p> |
| 128 |
<p> |
| 129 |
Trigger buttons have radically different behaviour. They trigger event on left mouse |
| 130 |
button click and every time they fall into pushed state. So there is possible to trigger |
| 131 |
sequence of events by pressing left mouse button over the button and repeatedly moving |
| 132 |
mouse cursor outside widget's area and back. |
| 133 |
</p> |
| 134 |
|
| 135 |
<p>For space economy and clarity improving purposes buttons may be combined with LEDs.</p> |
| 136 |
|
| 137 |
<p style="text-align:center">Here is example of different button widgets:</p> |
| 138 |
<div class="images"> |
| 139 |
<img src="<?= $CTL ?>button_tap.png"> |
| 140 |
<img src="<?= $CTL ?>button_active.png"> |
| 141 |
<img src="<?= $CTL ?>button_blank.png"> |
| 142 |
<img src="<?= $CTL ?>button_lcf.png"> |
| 143 |
<img src="<?= $CTL ?>button_l_r.png"> |
| 144 |
<img src="<?= $CTL ?>button_l_r_sm.png"> |
| 145 |
<img src="<?= $CTL ?>button_mag_sm.png"> |
| 146 |
<img src="<?= $CTL ?>button_on_s_m.png"> |
| 147 |
<img src="<?= $CTL ?>button_on_s_m_2.png"> |
| 148 |
<img src="<?= $CTL ?>button_on_s_m_3.png"> |
| 149 |
<img src="<?= $CTL ?>button_sc_sm.png"> |
| 150 |
<img src="<?= $CTL ?>button_side_on.png"> |
| 151 |
</div> |
| 152 |
</section> |
| 153 |
|
| 154 |
<section id="Combo"> |
| 155 |
<h2>Combo</h2> |
| 156 |
|
| 157 |
<p>Combo is a drop-down list that in normal state displays only currently selected item. When clicking |
| 158 |
by left mouse button, it shows drop-down list with all possible variants for choosing. Only one list item |
| 159 |
may be selected at the same time.</p> |
| 160 |
|
| 161 |
<p>It is very useful for defining controls that use enumerations or for switching between different |
| 162 |
control groups.</p> |
| 163 |
|
| 164 |
<p style="text-align:center">Here is example of combo box widgets:</p> |
| 165 |
<div class="images"> |
| 166 |
<img src="<?= $CTL ?>combo.png"> |
| 167 |
</div> |
| 168 |
</section> |
| 169 |
|
| 170 |
<section id="ComboGroup"> |
| 171 |
<h2>Combo Group</h2> |
| 172 |
|
| 173 |
<p>Combo group is a <b>Group</b> control that allows to select the displayed content by calling a drop-down list. |
| 174 |
The drop-down list is accessible by clicking with left mouse button the header header of the group.</p> |
| 175 |
|
| 176 |
<p style="text-align:center">Here is example of combo group widget:</p> |
| 177 |
<div class="images"> |
| 178 |
<img class="border" src="<?= $CTL ?>combo_group.png"> |
| 179 |
</div> |
| 180 |
|
| 181 |
<p style="text-align:center">When clicking the group header, we get all possible variants for choosing widget groups for displaying:</p> |
| 182 |
<div class="images"> |
| 183 |
<img class="border" src="<?= $CTL ?>combo_group_select.png"> |
| 184 |
</div> |
| 185 |
</section> |
| 186 |
|
| 187 |
<section id="Fader"> |
| 188 |
<h2>Fader</h2> |
| 189 |
<p>The Fader widget allows to adjust value for continuous parameters in the pre-defined range.</p> |
| 190 |
<p>It is possible to achieve more precision by using the right mouse button instead of left when changing fader's value.</p> |
| 191 |
<p>To cancel editing, the opposite mouse button should be pressed (right if used left and vice verse).</p> |
| 192 |
<p>To reset parameter to it's default value, issue double click by the left mouse button.</p> |
| 193 |
<div class="images"> |
| 194 |
<img src="<?= $CTL ?>fader.png"> |
| 195 |
</div> |
| 196 |
</section> |
| 197 |
|
| 198 |
<section id="FileSaver"> |
| 199 |
<h2>File Saver</h2> |
| 200 |
<p> |
| 201 |
This widget allows to choose the file and tell plugin to save some data to it. It also allows to display progress |
| 202 |
and status of operation. |
| 203 |
</p> |
| 204 |
<div class="images"> |
| 205 |
<img src="<?= $CTL ?>save_v1.png"> |
| 206 |
<img src="<?= $CTL ?>save_v2.png"> |
| 207 |
<img src="<?= $CTL ?>save_v3.png"> |
| 208 |
</div> |
| 209 |
</section> |
| 210 |
|
| 211 |
<section id="Footer"> |
| 212 |
<h2>Footer</h2> |
| 213 |
<p>The footer is located at the bottom of plugin and allows to adjust some parameters available in the main menu:</p> |
| 214 |
<ul> |
| 215 |
<li>Show manual for the plugin.</li> |
| 216 |
<li>Adjust the UI scaling for high-DPI displays.</li> |
| 217 |
<li>Adjust the font scaling for people with disabled vision.</li> |
| 218 |
</ul> |
| 219 |
|
| 220 |
<div class="images"> |
| 221 |
<img class="border" src="<?= $CTL ?>footer.png"> |
| 222 |
</div> |
| 223 |
</section> |
| 224 |
|
| 225 |
<section id="Fraction"> |
| 226 |
<h2>Fraction</h2> |
| 227 |
<p> |
| 228 |
This widget allows to set-up time signature of the audio that is present as a fraction where top and bottom parts are |
| 229 |
integer values. Both numerator and denominator of fraction is adjustable by mouse wheel. Also, when clicking numerator |
| 230 |
or denominator with left mouse button, popup list box appears that allows to quickly set the required value. |
| 231 |
</p> |
| 232 |
<div class="images"> |
| 233 |
<img src="<?= $CTL ?>fraction.png"> |
| 234 |
</div> |
| 235 |
</section> |
| 236 |
|
| 237 |
<section id="Graph"> |
| 238 |
<h2>Graph</h2> |
| 239 |
<p> |
| 240 |
Graph is special widget for displaying graphical information about processes that flow |
| 241 |
in the DSP core of plugin. It may contain lines, text labels, different curves (meshes), |
| 242 |
markers and dots. |
| 243 |
</p> |
| 244 |
|
| 245 |
<p style="text-align:center">Example of graph widget:</p> |
| 246 |
<div class="grid-2col-man"> |
| 247 |
<div class="images"> |
| 248 |
<img src="<?= $CTL ?>graph.png"> |
| 249 |
</div> |
| 250 |
<div class="images"> |
| 251 |
<img src="<?= $CTL ?>graph_osc.png"> |
| 252 |
</div> |
| 253 |
</div> |
| 254 |
|
| 255 |
<p> |
| 256 |
All elements of graph except dots can not change input parameters of plugin. Dots may control |
| 257 |
simultaneously up to three parameters by the following events: |
| 258 |
</p> |
| 259 |
<ul> |
| 260 |
<li>moving dot horizontally;</li> |
| 261 |
<li>moving dot vertically;</li> |
| 262 |
<li>scrolling mouse wheel over the dot.</li> |
| 263 |
</ul> |
| 264 |
<p>By moving dot over the graph widget two parameters may be changed simultaneously. This can be |
| 265 |
done by left-clicking on the dot, holding mouse button and moving mouse cursor over the graph |
| 266 |
widget's area. Also, additional tolerance may be reached by right-clicking the dot instead of |
| 267 |
left-clicking, this makes the change of parameters more accurate. The movement may be cancelled |
| 268 |
by pressing the opposite button of the mouse.</p> |
| 269 |
<p>Additional tolerance for mouse scroll may be achieved by pressing shift key on keyboard</p> |
| 270 |
|
| 271 |
<p style="text-align:center">Example showing dot controls:</p> |
| 272 |
<div class="images"> |
| 273 |
<img src="<?= $CTL ?>dots.png"> |
| 274 |
</div> |
| 275 |
</section> |
| 276 |
|
| 277 |
<section id="Group"> |
| 278 |
<h2>Group</h2> |
| 279 |
|
| 280 |
<p>Group widget is a special widget that allows to visually distinguish set of widgets that |
| 281 |
control parameters of some device or set of similar devices.</p> |
| 282 |
|
| 283 |
<p style="text-align:center">Example showing controls consolidated into group:</p> |
| 284 |
<div class="images"> |
| 285 |
<img class="border" src="<?= $CTL ?>group.png"> |
| 286 |
</div> |
| 287 |
</section> |
| 288 |
|
| 289 |
<section id="Header"> |
| 290 |
<h2>Header</h2> |
| 291 |
<p> |
| 292 |
Header delivers the basic information about the plugin and allow to perform primary control over the plugin settings. |
| 293 |
It consists of the following elements: |
| 294 |
</p> |
| 295 |
<ul> |
| 296 |
<li><b>LSP Logo</b> at the left</li> |
| 297 |
<li><b>Plugin name</b> at the top</li> |
| 298 |
<li><b>Plugin model</b> code near to the plugin name.</li> |
| 299 |
<li><b>Bypass button</b> at the right of the plugin name.</li> |
| 300 |
<li><b>Main menu bar</b> that consists of the following elements:</li> |
| 301 |
<ul> |
| 302 |
<li><b>Menu</b> – triggers the main plugin menu.</li> |
| 303 |
<li><b>Save</b> – launches the dialog that allows to save the configuration of plugin to confiruation file.</li> |
| 304 |
<li><b>Load</b> – launches the dialog that allows to load the configuration of plugin from confiruation file.</li> |
| 305 |
<li><b>Reset</b> – resets the state of plugin to the default. Requires a confirmation as a protection from accidental click.</li> |
| 306 |
<li><b>About</b> – shows the dialog which displays all necessary information about the plugin</li> |
| 307 |
</ul> |
| 308 |
</ul> |
| 309 |
<p>The main menu allows to perform the following actions on plugin instance:</p> |
| 310 |
<ul> |
| 311 |
<li>Show manual for the plugin and for the controls.</li> |
| 312 |
<li>Export plugin settings to file and clipboard.</li> |
| 313 |
<li>Import plugin settings from file or clipboard or some special file format (like Hydrogen drumkits or RoomEqWizard filters).</li> |
| 314 |
<li>Create an internal state dump of plugin for shipping an issue report to developers.</li> |
| 315 |
<li>Select the default lanuguage of the user interface.</li> |
| 316 |
<li>Adjust the UI scaling for high-DPI displays.</li> |
| 317 |
<li>Adjust the font scaling for people with disabled vision.</li> |
| 318 |
<li>Change the visual schema for widgets.</li> |
| 319 |
<li>Select the 3D rendering backend if plugin requires 3D rendering.</li> |
| 320 |
<li>Apply different built-in presets if they are present and supported by the plugin.</li> |
| 321 |
</ul> |
| 322 |
|
| 323 |
<p>Plugins typically use the following model code format: <b>XXXX MM NN CC</b>, where:</p> |
| 324 |
<ul> |
| 325 |
<li><b>XXXX</b> – arconym from the full name of plugin, for example <b>GE</b> for <b>Grafischer Entzerrer</b>.</li> |
| 326 |
<li><b>MM</b> – modifiers that show additional facilities of plugin like <b>M</b> (MIDI) or <b>SC</b> (Side chain)</li> |
| 327 |
<li><b>NN</b> – number of devices that work simultaneously. For example, <b>16</b> filters for the equalizer.</li> |
| 328 |
<li><b>CC</b> – channels that plugin operates:</li> |
| 329 |
<ul> |
| 330 |
<li><b>M</b> – mono;</li> |
| 331 |
<li><b>S</b> – stereo;</li> |
| 332 |
<li><b>D</b> – stereo with additional direct output channel;</li> |
| 333 |
<li><b>LR</b> – stereo, but separately left and right channels;</li> |
| 334 |
<li><b>MS</b> – middle and side channels.</li> |
| 335 |
</ul> |
| 336 |
</ul> |
| 337 |
|
| 338 |
<div class="images"> |
| 339 |
<img class="border" src="<?= $CTL ?>menu_bar.png"> |
| 340 |
</div> |
| 341 |
|
| 342 |
<p> |
| 343 |
The content of the exported/imported text file can be manually edited. |
| 344 |
Each parameter has detailed description. Below an example of the configuration file is present: |
| 345 |
</p> |
| 346 |
<pre> |
| 347 |
#------------------------------------------------------------------------------- |
| 348 |
# |
| 349 |
# This file contains configuration of the audio plugin. |
| 350 |
# Plugin name: Verzögerungsausgleicher Mono (Delay Compensator Mono) |
| 351 |
# Plugin version: 1.0.0 |
| 352 |
# LV2 URI: http://lsp-plug.in/plugins/lv2/comp_delay_mono |
| 353 |
# VST identifier: jav8 |
| 354 |
# LADSPA identifier: 5002065 |
| 355 |
# |
| 356 |
# (C) Linux Studio Plugins Project |
| 357 |
# https://lsp-plug.in/ |
| 358 |
# |
| 359 |
#------------------------------------------------------------------------------- |
| 360 |
|
| 361 |
# Bypass: true/false |
| 362 |
bypass = false |
| 363 |
|
| 364 |
# Mode: 0..2 |
| 365 |
# 0: Samples |
| 366 |
# 1: Distance |
| 367 |
# 2: Time |
| 368 |
mode = 2 |
| 369 |
|
| 370 |
# Samples [samp]: 0..10000 |
| 371 |
samp = 0 |
| 372 |
|
| 373 |
# Meters [m]: 0..200 |
| 374 |
m = 0 |
| 375 |
|
| 376 |
# Centimeters [cm]: 0.000000..100.000000 |
| 377 |
cm = 0.000000 |
| 378 |
|
| 379 |
# Temperature [°C]: -60.000000..60.000000 |
| 380 |
t = 20.000000 |
| 381 |
|
| 382 |
# Time [ms]: 0.000000..1000.000000 |
| 383 |
time = 3.349236 |
| 384 |
|
| 385 |
# Dry amount [G]: 0.000000..10.000000 |
| 386 |
dry = 0.000000 |
| 387 |
|
| 388 |
# Wet amount [G]: 0.000000..10.000000 |
| 389 |
wet = 1.000000 |
| 390 |
|
| 391 |
# Output gain [G]: 0.000000..10.000000 |
| 392 |
g_out = 1.000000 |
| 393 |
|
| 394 |
#------------------------------------------------------------------------------- |
| 395 |
</pre> |
| 396 |
</section> |
| 397 |
|
| 398 |
<section id="Indicator"> |
| 399 |
<h2>Indicator</h2> |
| 400 |
|
| 401 |
<p>Indicators are widgets that display measured or computed value by the plugin.</p> |
| 402 |
|
| 403 |
<p style="text-align:center">Example of indicator widget:</p> |
| 404 |
<div class="images"> |
| 405 |
<img src="<?= $CTL ?>indicator.png"> |
| 406 |
</div> |
| 407 |
</section> |
| 408 |
|
| 409 |
<section id="InlineDisplay"> |
| 410 |
<h2>Inline display</h2> |
| 411 |
|
| 412 |
<p>Inline displays are not widgets or elements of plugin's UI at all. Instead of this, they're part of |
| 413 |
the host UI since the <a href="https://ardour.org/">Ardour DAW</a> implemented Inline Display extension for |
| 414 |
LV2 format.</p> |
| 415 |
<p>So they're available in the Ardour's mixer strip even if UI is not shown. Inline displays also are |
| 416 |
available in <a href="https://harrisonconsoles.com/">Mixbus DAW</a> as the relative to Ardour product.</p> |
| 417 |
<p>Because inline display is an LV2-specific extension, it is available only for LV2 version of LSP plugins. |
| 418 |
But standalone JACK versions of plugins that support inline displays in LV2, draw them on window's icon.</p> |
| 419 |
|
| 420 |
<p style="text-align:center">Example of inline displays:</p> |
| 421 |
<div class="images"> |
| 422 |
<img src="<?= $CTL ?>inline_display1.png"> |
| 423 |
<img src="<?= $CTL ?>inline_display2.png"> |
| 424 |
</div> |
| 425 |
</section> |
| 426 |
|
| 427 |
<section id="Knob"> |
| 428 |
<h2>Knob</h2> |
| 429 |
<p>Knobs are the mostly used controls by plugin GUIs. They allow to adjust value for continuous parameters |
| 430 |
in the pre-defined range. Highlighted part of the knob's scale shows deviation from it's zero position. |
| 431 |
There are many ways to adjust the controlled parameter.<p> |
| 432 |
<p>The first way to change the parameter is performing left mouse click on the knob's cap, holding mouse |
| 433 |
button and moving cursor up and down. To apply more accurate adjustment, right button of mouse may be pressed |
| 434 |
while moving cursor.</p> |
| 435 |
<p>The second way to change parameter's value may be reached by using mouse scroll. To perform more accurate |
| 436 |
adjustment, shift key may be pressed on keyboard. To accelerate the adjustment, control key may be pressed on keyboard.</p> |
| 437 |
<p>For all knobs (especially when they are stiff) quick adjustment of parameter may be achieved by left-clicking |
| 438 |
knob's scale. Also, additionally mouse button may be hold and parameter will be adjusted by moving mouse |
| 439 |
clockwise/counter-clockwise.</p> |
| 440 |
<p>Note, that knob scale actions can be enabled or disabled by the additional 'UI behavior' → 'Editable knob scale' option.</p> |
| 441 |
<p>To reset parameter to it's default value, left mouse button double click may be issued.</p> |
| 442 |
<p>Note that in most cases additional 'Parameter' widget that displays the actual value of the parameteris |
| 443 |
located nearby the knob . While the knob widget allows to adjust the value with some step, the 'Parameter' |
| 444 |
widget allows to set the precise value by double-clicking the displayed value and entering the new desired |
| 445 |
value by the keyboard.</p> |
| 446 |
|
| 447 |
<p style="text-align:center">Example showing knob controls:</p> |
| 448 |
<div class="images"> |
| 449 |
<img src="<?= $CTL ?>knob_blue.png"> |
| 450 |
<img src="<?= $CTL ?>knob_cyan.png"> |
| 451 |
<img src="<?= $CTL ?>knob_green.png"> |
| 452 |
<img src="<?= $CTL ?>knob_orange.png"> |
| 453 |
<img src="<?= $CTL ?>knob_red.png"> |
| 454 |
<img src="<?= $CTL ?>knob_yellow.png"> |
| 455 |
</div> |
| 456 |
</section> |
| 457 |
|
| 458 |
<section id="Label"> |
| 459 |
<h2>Label</h2> |
| 460 |
<p style="text-align:center">Labels are widgets that display static text information.<p> |
| 461 |
|
| 462 |
<p style="text-align:center">Example of label widgets:</p> |
| 463 |
<div class="images"> |
| 464 |
<img class="border" src="<?= $CTL ?>labels.png"> |
| 465 |
</div> |
| 466 |
</section> |
| 467 |
|
| 468 |
<section id="Led"> |
| 469 |
<h2>Led</h2> |
| 470 |
<p style="text-align:center">LEDs are used to display state of binary output parameter.<p> |
| 471 |
<p style="text-align:center">Example of LEDs:</p> |
| 472 |
<div class="images"> |
| 473 |
<img class="border" src="<?= $CTL ?>leds.png"> |
| 474 |
</div> |
| 475 |
</section> |
| 476 |
|
| 477 |
<section id="Meter"> |
| 478 |
<h2>Meter</h2> |
| 479 |
<p>Meters are used for metering some values (mostly, levels of the audio signal). They may contain yellow |
| 480 |
and red zones. They respectively show that signal exceeds -6dB and 0dB levels.<p> |
| 481 |
<p style="text-align:center">Example of meters:</p> |
| 482 |
<div class="images"> |
| 483 |
<img style="margin-right:10px;" src="<?= $CTL ?>meter_mono.png"> |
| 484 |
<img src="<?= $CTL ?>meter_stereo.png"> |
| 485 |
</div> |
| 486 |
</section> |
| 487 |
|
| 488 |
<section id="Overlay"> |
| 489 |
<h2>Overlay</h2> |
| 490 |
<p>Overlays are special widget containers designed to hide rarely used controls from regular user while |
| 491 |
keeping the power, functionality and flexibility of the plugin. These widget allow to show on demand set |
| 492 |
of additional controls laying on the top of plugin's window. Usually it is done by special button.<p> |
| 493 |
<p style="text-align:center">Example of overlay:</p> |
| 494 |
<div class="images"> |
| 495 |
<img style="margin-right:10px;" src="<?= $CTL ?>overlay.png"> |
| 496 |
</div> |
| 497 |
</section> |
| 498 |
|
| 499 |
<section id="Parameter"> |
| 500 |
<h2>Parameter</h2> |
| 501 |
<p>Parameters are widgets that display the actual value and measuring units of some controlled parameter. |
| 502 |
It is possible do double-click the parameter and enter it's value manually in the popup window. |
| 503 |
<div class="images"> |
| 504 |
<img class="border" style="margin-right: 10px;" src="<?= $CTL ?>params.png"> |
| 505 |
<img class="border" src="<?= $CTL ?>param_enter.png"> |
| 506 |
</div> |
| 507 |
</section> |
| 508 |
|
| 509 |
<section id="ProgressBar"> |
| 510 |
<h2>Progress Bar</h2> |
| 511 |
<p> |
| 512 |
Progress Bar is a widget for monitoring execution progress of offline tasks. |
| 513 |
It shows the actual completion percentage of the background job. |
| 514 |
<p> |
| 515 |
<p>Example of progress bar:</p> |
| 516 |
<div class="images"> |
| 517 |
<img src="<?= $CTL ?>progress_bar.png"> |
| 518 |
</div> |
| 519 |
</section> |
| 520 |
|
| 521 |
<section id="SampleEditor"> |
| 522 |
<h2>Sample Editor</h2> |
| 523 |
|
| 524 |
<p>Sample Editor widget is used for viewing and editing audio samples. It is similar to AudioFile wiget but |
| 525 |
unlike AudioFile widget, it does not allow to load files from file system.</p> |
| 526 |
|
| 527 |
<p>By default if there is no sample data, the file widget displays |
| 528 |
<b style="color: #00c000">'No data'</b> text.</p> |
| 529 |
<p>Example of sample editor widget:</p> |
| 530 |
<div class="images"> |
| 531 |
<img class="border" src="<?= $CTL ?>sample_editor.png"> |
| 532 |
</div> |
| 533 |
</section> |
| 534 |
|
| 535 |
<section id="SharedMemoryLink"> |
| 536 |
<h2>Shared Memory Link</h2> |
| 537 |
|
| 538 |
<p>The shared memory link allows to connect plugins via a shared memory segment. This allows one set of plugins |
| 539 |
to allocate some named shared memory segment and submit some data (like audio stream) to it. The other set of |
| 540 |
plugins can connect to the shared memory segment and read data from it. Some plugins allow to work with multiple |
| 541 |
shared memory segments as both readers and writers.</p> |
| 542 |
<p>Shared memory link is a very versatile feature that allows to communicate plugins of different formats |
| 543 |
and of different kinds and do some cooperative work.<p> |
| 544 |
<p>The shared memory link control looks similar to button. By default it shows the 'Send...' or 'Link...' text |
| 545 |
that indicates that currently there is no connection estimated to the shared memory segment. When connected, |
| 546 |
it shows the name of the shared memory segment and the direction of the connection:</p> |
| 547 |
<ul> |
| 548 |
<li>the arrow at the left of the link name indicates the link being audio send (output only);</li> |
| 549 |
<li>the arror at the right of the link name indicates the link being audio return (input only);</li> |
| 550 |
<li>the equation at the left of the link name indicates the link being some unidirectional readable and writeable shared memory structure.</li> |
| 551 |
</ul> |
| 552 |
<p>When clicking the shared memory link, the popup dialog appears that allows to enter the name of new shared memory |
| 553 |
segment or choose the already existing one. The input field also acts as a filter for filtering all available shared |
| 554 |
memory segments.</p> |
| 555 |
<p>Example of sample editor widget:</p> |
| 556 |
<div class="images"> |
| 557 |
<img class="border" src="<?= $CTL ?>shmlink_not_connected.png"> |
| 558 |
<img class="border" src="<?= $CTL ?>shmlink_connected.png"> |
| 559 |
<img class="border" src="<?= $CTL ?>shmlink_popup.png"> |
| 560 |
</div> |
| 561 |
</section> |
| 562 |
|
| 563 |
<section id="TabControl"> |
| 564 |
<h2>Tab Control</h2> |
| 565 |
|
| 566 |
<p>Tab control allows to group multiple elements into tabs. When a specific tab is active, the only set of |
| 567 |
controls that belong to the tab becomes visible.</p> |
| 568 |
|
| 569 |
<p>Example of the tab control:</p> |
| 570 |
<div class="images"> |
| 571 |
<img class="border" src="<?= $CTL ?>tab_control.png"> |
| 572 |
</div> |
| 573 |
</section> |
| 574 |
|