=============== Common Features =============== .. image:: screenshot.png Every plugin has common menu bar and status bar on the top and bottom of plugin GUI. Common Menu Bar =============== ----------- Plugin Menu ----------- .. image:: menu_button.png :scale: 100% By clicking plugin menu button, plugin menu appears. .. image:: plugin_menu.png :scale: 60% About This Product Shows plugin name, version, build date, plugin format and other information. Open Manual Opens installed manual (this document). Visit A.O.M. Website Opens A.O.M. website using default browser. Install License Opens license installation dialog. Tooltip -- Shot/Hide Tooltip Toggles tooltip visibility. This setting is shared among all A.O.M. plugins. Tooltip -- Language Chooses tooltip language. This setting is shared among all A.O.M. plugins. Scaling Changes plugin scaling factor. This setting is saved per plugin. Wheel and Swipe operations Enable/Disable wheel and swipe operations. This reduces accidental knob operations caused by Magic Mouse or two-finger swipe. Open Diagnostic Log Opens diagnostic log file. A.O.M. plugins record some events, such as authentication failure or fatal errors, to diagnostic log file. Our support staff may ask you to send the diagnostic log for troubleshooting. Copy System Stats to Clipboard Copies several system information to clipboard. It's helpful to add this information to support request email. Plugin-specific Settings Shows Plugin-specific menu if exist. See each plugin's document for details. ----------------------- Factory Preset Controls ----------------------- .. image:: preset/main.png Some plugins employs factory presets. Left Triangle button Selects previous factory preset. Right Triangle button Selects next factory preset. Preset Selector Shows preset pop-up menu. Preset Pop-up Menu ------------------ By choosing **Save Preset** menu, one can save current settings as user preset. After entering preset name, preset file is saved to predefined user preset folder. .. image:: preset/save_preset.png If one choose subfolder's save preset menu, preset file is created in selected subfolder. .. image:: preset/subfolder.png When choosing preset name item, preset content is loaded to this plugin instance. When **Open Preset Folder** menu is clicked, plugin opens user preset folder with File Explorer (on Windows) or Finder.app (on macOS). One can do with explorer or finder: * Rename presets * Delete presets * Create subfolders * Rename subfolders * Delete subfolders **[Factory Presets]** is a special virtual folder which contains factory presets. Factory presets are embedded in plugin and thus read-only. .. image:: preset/factory_preset.png ------------ Reset Button ------------ .. image:: reset.png Sets all plugin parameters to each default value. Undoable. ----------------- Undo/Redo Buttons ----------------- .. image:: undo.png Undo button (left arrow) Cancels the last operation and rollback to previous plugin setting. Redo button (right arrow) Does previously cancelled operation again. ---------------- Snapshot Buttons ---------------- .. image:: snapshot.png This buttons can be used to compare between two sets of plugin setup. "Save to A/B/C/D" menus under Snapshot button Saves current plugin setting to each slot. A/B/C/D button Loads saved settings. Undoable. .. NOTE:: Saved settings are volatile, in other words, they will be discarded when project is closed or plugin instance is deleted. .. NOTE:: A/B comparison feature is superseded by snapshot feature as of version 1.9.5. ---------- Peak Meter ---------- .. image:: peak_meter_normal.png .. image:: peak_meter_over.png **Peak Meter** shows instantaneous sample peak of each channel. When peak exceeds 0dB full-scale, the bar becomes red. -------------- License Status -------------- .. image:: license.png .. image:: license_ng.png Shows current license status. Key icon License is valid. Cross mark over key icon, red background License has been expired or there is no valid license. Controls ======== A.O.M. plugin GUI contains various type of controls. These controls share common behavior over all A.O.M. plugins. ------------- On/Off Button ------------- .. image:: control/onoff1.png :scale: 150 .. image:: control/onoff2.png .. image:: control/onoff3.png An on/Off button represents a control with **binary value**. When button is active (typically lighter), the parameter related to the control is on, active or enabled. .. csv-table:: On/Off button operation "Area", "Operation", "Behavior" "Button", "Left Click", "Toggle value" ------------ Button Group ------------ .. image:: control/buttongroup1.png :scale: 70 .. image:: control/buttongroup2.png :scale: 170 A button group represents **single selection from multiple values**. The button related to current value is shown active (typically lighter). .. csv-table:: Button group operation "Area", "Operation", "Behavior" "Button", "Left Click", "Select value related to the button" ------------- Dropdown List ------------- .. image:: control/dropdown1.png :scale: 110 .. image:: control/dropdown2.png A dropdown list represents **single selection from multiple values**. Current selection is shown in the box. **Previous/Next buttons** are visible on hover. Users can select previous or next value by clicking them. .. csv-table:: Dropdown list operation "Area", "Operation", "Behavior" "Button", "Left Click", "Show a selectable value list" "Button", "Wheel", "Select next or previous value" "Previous/Next button", "Left Click", "Select previous or next value" ---- Knob ---- .. image:: control/knob1.png :scale: 140 .. image:: control/knob2.png .. image:: control/knob3.png A knob represents a **continuous value**. Some knobs come with **value box**, users can directly edit the value. .. csv-table:: Knob operation "Area", "Operation", "Behavior" "Knob", "Left Drag", "Increase or decrease value" "Knob", "Left Shift+Drag", "Precisely increase or decrease value" "Knob", "Left Double-Click", "Reset value" "Knob", "Left Ctrl+Click", "Reset value" "Value Box", "Left Click", "Begin editing value" ------------- Selector Knob ------------- .. image:: control/selectorknob1.png :scale: 140 .. image:: control/selectorknob2.png :scale: 140 A selector knob represents **single selection from multiple values**. .. csv-table:: Selector knob operation "Area", "Operation", "Behavior" "Knob", "Left Drag", "Choose previous or next value" "Knob", "Left Double-Click", "Reset value" "Knob", "Left Ctrl+Click", "Reset value"