Navigators - reaper-csi/reaper_csurf_integrator GitHub Wiki

Navigators provide the context for the Actions triggered within our Zone.

Navigators (if present) MUST be on the second line of the Zone definition.

For example, if we’ve got a Fader widget bound to the TrackVolume action, which track will it change the Volume on? The selected track? The Master Track?

Zone “MyWidgets”
    Fader TrackVolume
EndZone

Well, the answer depends on which Navigator we associate with the Zone:

Available Navigators

The full list of available navigators in CSI is as follows:

• TrackNavigator
• SelectedTrackNavigator
• TrackSendSlotNavigator
• TrackReceiveSlotNavigator
• TrackFXMenuSlotNavigator
• SelectedTrackSendNavigator
• SelectedTrackReceiveNavigator
• SelectedTrackFXMenuNavigator
• SelectedTrackSendSlotNavigator
• SelectedTrackReceiveSlotNavigator
• FocusedFXNavigator
• MasterTrackNavigator

The below chart (view in a new tab to see full screen) is meant to help provide a quick reference guide for each navigator and how/when to use them.

TrackNavigator

The TrackNavigator is what CSI uses to manage navigation and control of widgets that may impact multiple tracks. Example: you have an 8-fader surface with 8 rotaries, 8 solo, and 8 mute buttons that you'll want assigned to different tracks. This is where TrackNavigator differs from SelectedTrackNavigator - since we have more than one fader, and we will want to assign them to more than the selected track.

In the below example, the faders are controlling TrackVolume across multiple tracks. You'll notice the use of the pipe character (located by pressing shift+backslash on your keyboard): see the section on setting up Zones for more details on why.

Zone "Channel|"
	TrackNavigator
	Fader|  			TrackVolume
ZoneEnd

SelectedTrackNavigator

Using the SelectedTrackNavigator will mean that the actions in that Zone act in the context of the currently selected track. The Fader will change the selected track’s volume, TrackPan alters Pan settings, etc. SelectedTrackNavigator is especially useful for tasks like setting the automation mode, record arming, or toggling input monitoring states for the selected track if, for instance, your surface doesn't have multiple sets of buttons for these actions for each channel. SelectedTrackNavigator is how that one Read or Write knob can be setup to work on an 8-fader surface -- the single button sets the automation mode for the selected track only.

Zone “MyWidgets”
    SelectedTrackNavigator
    Fader TrackVolume
EndZone

TrackSendSlotNavigator

Navigate sends slot for each channel on your surface (e.g. slot 1 on Channel 1, slot 1 on Channel 2, slot 1 on channel 3). Use the appropriate slot bank action to see the next set of send slots.

Zone "TrackSendSlot"
     TrackSendSlotNavigator
     DisplayUpper|      TrackSendNameDisplay
     DisplayLower|      TrackSendVolumeDisplay
     Fader|             TraclSendVolume
     BankLeft           SendSlotBank "-1"
     BankRight          SendSlotBank "1"
ZoneEnd

See Send Zones for more details.

TrackReceiveSlotNavigator

Navigate receive slots for each channel on your surface (e.g. slot 1 on Channel 1, slot 1 on Channel 2, slot 1 on channel 3). Use the appropriate slot bank action to see the next set of receive slots.

Zone "TrackReceiveSlot"
     TrackReceiveSlotNavigator
     DisplayUpper|      TrackReceiveNameDisplay
     DisplayLower|      TrackReceiveVolumeDisplay
     Fader|             TrackReceiveVolume
     BankLeft           ReceiveSlotBank "-1"
     BankRight          RecieveSlotBank "1"
ZoneEnd

See Receive Zones for more information.

TrackFXMenuSlotNavigator

Navigate FX Menu slots for each channel on your surface (e.g. slot 1 on Channel 1, slot 1 on Channel 2, slot 1 on channel 3). Use the appropriate slot bank action to see the next set of FX Menu slots.

Zone "TrackFXMenuSlot"
     TrackFXMenuSlotNavigator
     DisplayUpper|      TrackNameDisplay
     DisplayLower|      FXNameDisplay
     RotaryPush|        GoFXSlot
     BankLeft           FXMenuSlotBank "-1"
     BankRight          FXMenuSlotBank "1"
ZoneEnd

See FX Menu Zones for more information.

SelectedTrackSendNavigator

Selected channel's sends mapped across surface channels (e.g. slot 1 for selected track, slot 2 for selected track). Select a different track to see that track's sends.

Zone "SelectedTrackSend"
     SelectedTrackSendNavigator
     DisplayUpper|	TrackSendNameDisplay
     DisplayLower|	TrackSendVolumeDisplay
     Rotary|            TrackSendVolume
ZoneEnd

See Send Zones for more details.

SelectedTrackReceiveNavigator

Selected channel's receives mapped across surface channels (e.g. slot 1 for selected track, slot 2 for selected track). Select a different track to see that track's receives.

Zone "SelectedTrackReceive"
     SelectedTrackReceiveNavigator
     DisplayUpper|	TrackReceiveNameDisplay
     DisplayLower|	TrackReceiveVolumeDisplay
     RotaryE|           TrackReceiveVolume
ZoneEnd

See Receive Zones for more information.

SelectedTrackFXMenuNavigator

Selected channel's FX Menu mapped across surface channels (e.g. slot 1 for selected track, slot 2 for selected track).

Zone "SelectedTrackFXMenu"
    SelectedTrackFXMenuNavigator
    DisplayUpper|               FXMenuNameDisplay
    RotaryPushA|                GoFXSlot
ZoneEnd

See FX Menu Zones for more information.

SelectedTrackSendSlotNavigator

Navigate up/down Selected Track Send Slots. This is particularly useful for single fader surfaces where you've got one fader and one menu, but still want to be able to use that fader or rotary to control sends. Use the appropriate SendSlotBank action to navigate sends.

Zone "SelectedTrackSendSlot"
     SelectedTrackSendSlotNavigator
     DisplayUpper1                      TrackNameDisplay
     DisplayLower1                      TrackSendNameDisplay
     Fader1Touch+DisplayLower1          TrackSendVolumeDisplay
     Fader1                             TrackSendVolume
     Mute1                              TrackSendMute
     Rotary1                            TrackSendPan
     BankLeft                           SendSlotBank -1
     BankRight                          SendSlotBank 1
ZoneEnd

See Send Zones for more details.

SelectedTrackReceiveSlotNavigator

Navigate up/down Selected Track Receive Slots. This is particularly useful for single fader surfaces where you've got one fader and one menu, but still want to be able to use that fader or rotary to control receives. Use the appropriate ReceiveSlotBank action to navigate receives.

Zone "SelectedTrackReceiveSlot"
     SelectedTrackReceiveSlotNavigator
     DisplayUpper1                      TrackNameDisplay
     DisplayLower1                      TrackReceiveNameDisplay
     Fader1Touch+DisplayLower1          TrackReceiveVolumeDisplay
     Fader1                             TrackReceiveVolume
     Mute1                              TrackReceiveMute
     Rotary1                            TrackReceivePan
     BankLeft                           ReceiveSlotBank -1
     BankRight                          ReceiveSlotBank 1
ZoneEnd

See Receive Zones for more information.

FocusedFXNavigator

Use this navigator for mapping FX when they gain focus in Reaper. See MapFocusedFXToWidgets for more details.

Zone "VST: SPL Transient Designer Plus (Plugin Alliance)"
FocusedFXNavigator 
     RotaryA1 FXParam 2 "Attack"
     RotaryA2 FXParam 3 "Sustain"
ZoneEnd

MasterTrackNavigator

Using a MasterTrackNavigator means all those same actions act in the context of the Master Track. TrackVolume, TrackPan, etc will all affect the Master Track, regardless of which tracks are selected.

Zone “MyWidgets”
    MasterTrackNavigator
    Fader TrackVolume
EndZone