Changes

Jump to navigation Jump to search

Zynthian UI User Guide - V1/V4 (view source)

Revision as of 01:06, 8 January 2023

808 bytes added ,  01:06, 8 January 2023
Update MIDI CUIA table to be synced with latest stable
Line 144: Line 144:  
<br clear=all>
 
<br clear=all>
 
===Navigation===
 
===Navigation===
−
The main screen is the Mixer and it's always reachable by pressing bold-Back. Navigation between views is performed by pressing buttons or using the touchscreen. Most destructive changes, e.g. removing chains, will request confirmation. Operations that take time to complete may show an animated zynthian logo representing progress.
+
The home screen is the Mixer and it's always reachable by pressing bold-Back. Navigation between views is performed by pressing buttons or using the touchscreen. Most destructive changes, e.g. removing chains, will request confirmation. Operations that take time to complete may show an animated zynthian logo representing progress.
    
Navigation, default actions and common workflows are shown in the following graphs:
 
Navigation, default actions and common workflows are shown in the following graphs:
Line 152: Line 152:  
</gallery>
 
</gallery>
   −
<gallery mode="packed" heights="1000">
+
<gallery mode="packed" heights="1400">
 
Image:Add chain workflow.png|''[[#Main_Menu|Add Chain]]''
 
Image:Add chain workflow.png|''[[#Main_Menu|Add Chain]]''
 
Image:Snapshot workflow.png|''[[#Load_.2F_Save_Snapshot|Manage Snapshots]]''
 
Image:Snapshot workflow.png|''[[#Load_.2F_Save_Snapshot|Manage Snapshots]]''
Line 165: Line 165:  
[[File:Audio mixer.png|400px|right]]
 
[[File:Audio mixer.png|400px|right]]
   −
The mixer view is the main screen and pressing '''bold-BACK''' should always navigate to this screen. It displays a strip for each configured chain plus a strip for the main mixbus. The quantity of strips displayed may be configured using webconf. If there are more chains than can be displayed, the screen can be scrolled horizontally by selecting a higher / lower chain or dragging the bottom legend strip.
+
The mixer view is the home screen and pressing '''bold-BACK''' should always navigate to this screen. It displays a strip for each configured chain plus a strip for the main mixbus. The quantity of strips displayed may be configured using webconf. If there are more chains than can be displayed, the screen can be scrolled horizontally by selecting a higher / lower chain or dragging the bottom legend strip.
    
===Audio Chains===
 
===Audio Chains===
Line 245: Line 245:  
== Bank selector==
 
== Bank selector==
 
[[File:Zynthian_ui_bank_list.png|400px|right]]
 
[[File:Zynthian_ui_bank_list.png|400px|right]]
−
Presets (instruments, patches, sound designs, etc.) for engines may be organized into banks. Choose a bank to see the list of presets for the engine.
+
Presets (instruments, patches, sound designs, etc.) for engines may be organized into banks. You can access engine's bank list by pressing '''short-BACK''' from within its presets list. Choose ('''short-SELECT''') a bank to see the list of presets on it.
    
<br clear=all>
 
<br clear=all>
−
You can access an engine's banks by short press BACK from within its presets list.
+
'''Bold-SELECT''' or touch and hold a bank on the touchscreen will show the '''Bank Options menu'''. User banks may be renamed or deleted. Some engines do not allow banks to be manipulated in which case this will have no effect.
   −
Bold press SELECT or touch and hold a bank on the touchscreen will show the Bank Options menu. A bank may be renamed or deleted. Some engines do not allow banks to be manipulated in which case this will have no effect.
+
'''Short-BACK''' to return to the Control View without selecting.
−
 
  −
Short press BACK to return to the Control View without changing the engine's configuration.
   
<br clear=all>
 
<br clear=all>
    
==Preset selector==
 
==Preset selector==
 
[[File:Zynthian_ui_preset_list.png|400px|right]]
 
[[File:Zynthian_ui_preset_list.png|400px|right]]
−
Once you have chosen a bank, the preset screen will be shown. Choose a preset to load the instrument / sound / patch and the Control View will be shown.
+
Once you have chosen a bank, the preset screen will be shown. Choose a preset to load the instrument / sound / patch / etc. and the Control View will be shown.
 
<br clear=all>
 
<br clear=all>
   −
To change preset of an existing engine, navigate to its Control View then short press BACK to access the list of presets. Use the SELECT encoder to highlight the required preset and short press SELECT or tap on the required preset in the list on the touchscreen to select the preset. The engine will configure with the preset values and the Control View will be displayed.
+
To change the selected preset for a engine in a chain, navigate to its Control View then short press BACK to access the list of presets. Use the SELECT encoder to highlight the required preset and '''short-SELECT''' (or tap, if using touchscreen) to select the preset. The engine will configure with the preset values and the Control View will be displayed.
   −
Bold press SELECT or touch and hold a preset on the touchscreen will show the Preset Options menu. A preset may be added to or removed from a list of favorites, renamed or deleted. Some engines do not allow presets to be manipulated and will only show the Favourite option. (Saving presets is performed in the chain options menu described later.)
+
'''Bold-SELECT''' a preset (or touch and hold on the touchscreen) will show the '''Preset Options menu'''. A preset may be added to or removed from a list of favorites, renamed or deleted. Some engines do not allow presets to be manipulated and will only show the Favourite option. (Saving presets is performed in the chain options menu described later.)
   −
If the '''preload with note-on''' feature is enabled in the admin menu or webconf, you can audition the presets by playing notes. When you do so, the highlighted preset will be pre-loaded without pressing SELECT. N.B. Some engines may be slow to load presets in which case it may be necessary to play the note more than once to hear the new preset sound.
+
If the '''preload with note-on''' feature is enabled in the admin menu or webconf, you can audition the presets by playing notes. When you do so, the highlighted preset will be pre-loaded without pressing SELECT. Note that some engines may be slow to load presets in which case it may be necessary to play the note more than once to hear the new preset sound.
   −
You can return to the bank screen, without selecting any preset, by short press BACK. The previously selected instrument will be restored, e.g. if a preset has been pre-loaded (auditioned).
+
You can return to the bank screen, without selecting any preset, by pressing '''short-BACK'''. The previously selected instrument will be restored, e.g. if a preset has been pre-loaded (auditioned).
   −
Press bold SELECT to manipulate the preset including adding to your favorites. The favorites list can be shown by short press LEARN/SHOT in the Bank or Preset View.
+
Press '''bold-SELECT''' to manage the preset including adding to your favorites. The favorites list can be shown by pressing '''short-LEARN/SHOT''' in the Bank or Preset View.
    
Not all engines support presets. If no presets are configured then this screen is not shown.
 
Not all engines support presets. If no presets are configured then this screen is not shown.
Line 275: Line 273:  
==Control View==
 
==Control View==
 
[[File:Zynthian_ui_instrument_control_01.png|400px|right]]
 
[[File:Zynthian_ui_instrument_control_01.png|400px|right]]
−
The Control View shows the controls available for each engine within a chain. It is shown after adding a chain, adding an engine to a chain or by short press SELECT or tapping the bottom legend strip in the mixer view. Your instrument is now enabled and playable and you can modify its parameters.
+
The Control View shows the controls available for each engine within a chain. It is shown after adding a chain, adding an engine to a chain or by pressing '''short-SELECT''' (or tapping the bottom legend strip in the mixer view). Your instrument is now enabled and playable and you can modify its parameters.
    
The controls are shown in groups of four (or fewer) on several pages. Each hardware knob controls a parameter displayed in the control view or the control may be dragged up and down on the touchscreen. Controls may toggle between two values, e.g. on / off, lists of values, e.g. sine, square, triangle or continuously adjustable values, e.g. 0%..100%. If there are a lot of possible values the hardware knobs will accelerate progress if rotated fast, e.g. stepping by one value when turned slowly and stepping by 10 values when rotated fast. This allows fine and coarse selection of a parameter from a single knob.
 
The controls are shown in groups of four (or fewer) on several pages. Each hardware knob controls a parameter displayed in the control view or the control may be dragged up and down on the touchscreen. Controls may toggle between two values, e.g. on / off, lists of values, e.g. sine, square, triangle or continuously adjustable values, e.g. 0%..100%. If there are a lot of possible values the hardware knobs will accelerate progress if rotated fast, e.g. stepping by one value when turned slowly and stepping by 10 values when rotated fast. This allows fine and coarse selection of a parameter from a single knob.
Line 282: Line 280:  
[[File:Zynthian_ui_instrument_control_03.png|400px|right]]
 
[[File:Zynthian_ui_instrument_control_03.png|400px|right]]
 
There is a list that shows the pages of controls available.
 
There is a list that shows the pages of controls available.
−
To change page, short press SELECT - the list of pages turns grey, rotate SELECT to highlight the required page then short press again to select the page. If there are fewer than three pages then short press SELECT will step through each page. Alternatively, tap the required page on the touchscreen. When a page is selected its controls will be shown. Depending on the configuration, some pages may have fewer than four controls and some engines have no adjustable parameters in which case there will be no control pages.
+
To change page, press '''short-SELECT''' - the list of pages turns grey, '''rotate SELECT''' to highlight the required page then short press again to select the page. If there are fewer than three pages then '''short-SELECT''' will step through each page. Alternatively, tap the required page on the touchscreen. When a page is selected its controls will be shown. Depending on the configuration, some pages may have fewer than four controls and some engines have no adjustable parameters in which case there will be no control pages.
    
The pages for the controls for each engine within a chain are shown separated by a title indicating to which engine subsequent pages belong.
 
The pages for the controls for each engine within a chain are shown separated by a title indicating to which engine subsequent pages belong.
Line 296: Line 294:  
==Chain Options==
 
==Chain Options==
 
[[File:Chain options.png|400px|right]]
 
[[File:Chain options.png|400px|right]]
−
Bold press SELECT when in the Mixer View or Control View will show the Chain Options menu. Manipulation of the chain is possible:
+
Pressing '''bold-SELECT''' when in the '''Mixer View''' or '''Control View''' will show the '''Chain Options menu''', allowing to manipulate the chain:
    
* '''Save Preset''' will allow saving of a engine's configuration as a preset that may later be selected from the preset list. This is only available if the engine supports manipulation of presets. If a chain has several engines then a list of engines will be displayed before naming the preset.
 
* '''Save Preset''' will allow saving of a engine's configuration as a preset that may later be selected from the preset list. This is only available if the engine supports manipulation of presets. If a chain has several engines then a list of engines will be displayed before naming the preset.
Line 320: Line 318:     
[[File:Zynthian_ui_layer_effect_options.png|400px|right]]
 
[[File:Zynthian_ui_layer_effect_options.png|400px|right]]
−
Short press SELECT or tapping on an effect in the list will allow manipulation of the effect:
+
Select an effect in the list for opening the effect options menu, that allows manipulating chain elements:
    
* '''Presets''' shows list of available presets for the effect
 
* '''Presets''' shows list of available presets for the effect
Line 745: Line 743:  
  4    RELOAD_KEY_BINDING        E-1
 
  4    RELOAD_KEY_BINDING        E-1
 
  5    LAST_STATE_ACTION          F-1
 
  5    LAST_STATE_ACTION          F-1
 +
6    EXIT_UI                    F#-1
    
  10    ALL_NOTES_OFF              A#-1
 
  10    ALL_NOTES_OFF              A#-1
Line 764: Line 763:  
  40    STOP_MIDI_PLAY            E2            Stop: 0xFC
 
  40    STOP_MIDI_PLAY            E2            Stop: 0xFC
    +
41    ARROW_UP                  F2
 +
42    ARROW_DOWN                F#2
 +
43    ARROW_RIGHT                G2
 +
44    ARROW_LEFT                G#2
 +
 +
45    ZYNPOT_UP                  A2
 +
46    ZYNPOT_DOWN                A#2
 +
 +
48    BACK                      C3
 +
49    NEXT                      C#3
 +
50    PREV                      D3
 
  51    SELECT                    D#3
 
  51    SELECT                    D#3
 +
 
  52    SELECT_UP                  E3
 
  52    SELECT_UP                  E3
 
  53    SELECT_DOWN                F3
 
  53    SELECT_DOWN                F3
Line 771: Line 782:  
  56    LAYER_UP                  G#3
 
  56    LAYER_UP                  G#3
 
  57    LAYER_DOWN                A3
 
  57    LAYER_DOWN                A3
−
  58    SNAPSHOT_UP                A#3
+
  58    LEARN_UP                  A#3
−
  59    SNAPSHOT_DOWN              B3
+
  59    LEARN_DOWN                B3
    
  64    SWITCH_BACK_SHORT          E4
 
  64    SWITCH_BACK_SHORT          E4
Line 784: Line 795:  
  60    SWITCH_LAYER_SHORT        C4
 
  60    SWITCH_LAYER_SHORT        C4
 
  61    SWITCH_LAYER_BOLD          C#4
 
  61    SWITCH_LAYER_BOLD          C#4
−
  59   SWITCH_LAYER_LONG          B3
+
  68   SWITCH_LAYER_LONG          B3
    
  71    SWITCH_SNAPSHOT_SHORT      B4
 
  71    SWITCH_SNAPSHOT_SHORT      B4
Line 794: Line 805:  
  82    SCREEN_BANK                A#5
 
  82    SCREEN_BANK                A#5
 
  83    SCREEN_PRESET              B5
 
  83    SCREEN_PRESET              B5
−
84    SCREEN_CONTROL            C6
     −
  90    MODAL_SNAPSHOT_LOAD        F#6
+
85    SCREEN_MIDI_RECORDER      C#6
 +
86    SCREEN_ALSA_MIXER          D6
 +
87    SCREEN_STEPSEQ            D#6
 +
88    SCREEN_BANK                E6
 +
89    SCREEN_PRESET              F6
 +
  90    SCREEN_CALIBRATE          F#6
 +
 
 
  91    MODAL_SNAPSHOT_SAVE        G6
 
  91    MODAL_SNAPSHOT_SAVE        G6
 
  92    MODAL_AUDIO_RECORDER      G#6
 
  92    MODAL_AUDIO_RECORDER      G#6
Line 805: Line 821:     
  100  LAYER_CONTROL              E7
 
  100  LAYER_CONTROL              E7
 +
101  LAYER_OPTIONS              F7
 +
102  MENU                      F#7
 +
103  PRESET                    G7
 +
104  FAVS                      G#7
 +
105  ZYNPAD                    A7
    
[[File:2Oct_Keyboard_CUIA.png|600px|Keyboard]]
 
[[File:2Oct_Keyboard_CUIA.png|600px|Keyboard]]
Retrieved from "http://wiki.zynthian.org/index.php/Special:MobileDiff/12279...12311"

Navigation menu