Docs revisions for PiPedal 2.0

This commit is contained in:
Robin E.R. Davies
2026-06-02 00:55:31 -04:00
parent faea240e3a
commit f435c2d1b1
32 changed files with 318 additions and 193 deletions
+7 -13
View File
@@ -29,15 +29,11 @@ Note how PiPedal has been configured to use <i>banks</i> as containers for songs
#### Accessing Snapshots in the PiPedal User Interface.
#### Creating Snapshots in the PiPedal User Interface.
You can create, modify, and select snapshots in two places in the PiPedal user interface.
You can create, modify, and select snapshots in the main PiPedal preset editor.
The first is via the <b><i>Snapshot</i></b> icon button in the middle row of controls in the main page of pipedal. It's the button that looks like a camera. The second is via the <b><i>Performance View</i></b>, which is accessible via the <b><i>Performance View</i></b> menu entry in the main PiPedal menu.
It's easier to create an initial set of snapshots from the main PiPedal page. You edit the current controls of the current preset, and you can then save current control values to a snapshot by first pressing the <b><i>Snapshots</i></b> icon button (the camera icon), and then pressing the <b><i>Save</i></b> button for a particular snapshot in the popup dialog.
On the other hand, you may find it easier to edit an existing set of snapshots from the <b><i>Performance View</i></b>. When you click the <b><i>Edit</i></b> button for a particular snapshot, PiPedal displays the <b><i>Snapshot Editor</i></b> which allows you to edit the control values for that snapshot directly.
Click on the <b><i>Snapshot</i></b> icon button in the middle row of controls in the main page of pipedal. It's the button that looks like a camera.
@@ -45,12 +41,10 @@ On the other hand, you may find it easier to edit an existing set of snapshots f
As a general rule, it's best to get the structure (which plugins are loaded, and how they are connected together) settled before you start creating snapshots. If you change the structure of a preset, it may affect snapshots that belong to that preset.
Each preset has its own set of preset control settings which are independent of the control settings in each snapshot. But all share the same plugin structure (which plugins are loaded, and how they are connected together).
When you click the edit button in the Performance View, you are editing control settings associated with the snapshot. When you press the back button from the snapshot editor, control settings for that snapshot are saved immediately. Saved control settings for the preset are not modified. You can avoid saving snapshot control settings by pressing the Cancel icon button (X) at the end of the toolbar for the snapshot editor. You cannot change the structure of the plugins in the preset to which snapshots belong from within the Snapshot editor. Nothing you do in the snapshot editor will affect the saved control values for the currently loaded preset.
Things are different when you are editing presets in the main PiPedal page. Changes to preset controls are not saved until you press the Save button. And you can make structural changes. When you make structural changes to the preset, you may also affect the control settings included in each snapshot. You can move plugins around freely. Snapshot controls will still apply to the plugin even if it has moved. But if you remove a plugin, the settings for that plugin in each snapshot will be removed. Even if you re-add a new instance of of the same plugin, settings in snapshots will not be remembered. And if you add a plugin, selecting a snapshot will set controls for the new plugin to default values (not the values of the controls in the main preset). So as a general rule, it's best to get the structure of a preset more-or-less settled before you start creating snapshots.
Each snapshot has its own set of preset control settings which are independent of the control settings in each snapshot. But all share the same plugin structure (which plugins are loaded, and how they are connected together).
If you make structural changes to a preset that add a new plugin, there will not be control settings for the new plugins in any of the snapshots (they will default to the values of the controls in the main preset, or whichever snapshot was last loaded, which may lead to unexpected results when switching between snapshots). You can actually re-order plugins within a preset, or remove plugins without affecting the control settings in a snapshot. But if you add a new plugin, there will be no saved values for the controls of the new plugin in each of the snapshots. If you do add a new plugin, it would be a good idea to go through each of the snapshots, and resave them to make sure that control settings for each of the snapshots are what you expect them to be.
--------
[<< Using TooB Neural Amp Modeler](UsingNAM.md) | [Up](Documentation.md) | | [Choosing a USB Audio Adapter >>](ChoosingAUsbAudioAdapter.md)
[<< How to Build Presets With PiPedal](BuildingPresets.md) | [Up](Documentation.md) | [Neural Amp Modeler Calibration >>](NamCalibration.md)