Scope SDK Modules

The ScopeSync package includes two modules that can be used in the Scope SDK. These wrap the ScopeSync .dll module and ScopeOSC .dll modules to provide access to all of the ScopeSync functionality.

ScopeSync Controller

This module is the main controller for ScopeSync and allows a developer to launch a ScopeSync GUI panel, position it on the screen and interact with the fixed parameters that are built in. Behind the scenes these fixed parameters are using Parameter Group 0, so this cannot be used for user parameters.

It is generally expected that a ScopeSync Controller will be connected to at least one ParamGroup module, but it’s possible to use an additional ScopeSync Controller with the same settings as a previous one if it is using a different Configuration UID. This allows multiple GUI panels for a single device, which has a variety of possible use-cases, e.g. having a dedicated device GUI as well as GUIs that look like hardware MIDI controllers.

ScopeSync Controller Module Pads

Short nameLong nameIn/OutDescription
DUIDDevice UIDInNeed to check this one...
EnabOSC EnabledInSwitches on the OSC functionality for all of the OSC Sender and Receiver modules inside the ScopeSync Controller
ExteExtenderInThis is a 16 element array, which contains data that passes on configuration information to ScopeSync ParamGroup modules. For example, it supplies the IP address and host for a remote plugin instance of ScopeSync as well as the local listening port for Scope. These are extracted from ScopeSync User Settings. In the case where a user supplies a host name instead of an IP address, this is looked up in DNS, so an IP address can be sent to the OSC Sender modules
ShowShow/Hide PanelIn + OutUsed to manage the show/hide state of the GUI panel. 0 = hidden, 1 = shown. Patch this in wherever makes sense to launch the GUI from. Output will be set to 0 when a user closes the window.
PresShow/Hide PresetIn + OutConnected to a Layout Button or Slider named "Show Preset Window". Patch this in to show/hide a preset window for your device. 0 = hidden, 1 = shown.
PatcShow/Hide PatchIn + OutConnected to a Layout Button or Slider named "Show Patch Window". Patch this in to show/hide the Patch window for your device. This mostly makes sense for Modular module usage, where this will be used to show the modular patch containing the ScopeSync controller. 0 = hidden, 1 = shown.
MonoMono EffectIn + OutConnected to a Layout Button or Slider named "Mono Effect". Patch this in to toggle whether the device should be in Mono or Stereo. 0 = Stereo, 1 = Mono
BypaBypass EffectIn + OutConnected to a Layout Button or Slider named "BypassEffect". Patch this in to toggle whether the device should be bypassed. 0 = not-bypassed, 1 = bypassed
ShPrShow/Hide Shell Preset WindowIn + OutConnected to a Layout Button or Slider named "Show Shell Preset Window". Patch this in to show/hide a preset window for a modular shell. Only really applies when ScopeSync is being launched in a Modular module. 0 = hidden, 1 = shown.
VoicVoice CountIn + OutConnected to a Layout Button or Slider named "Voice Count". Patch this in to set the Voice Count for your device.
ChanMIDI ChannelIn + OutConnected to a Layout Button or Slider named "MIDI Channel". Patch this in to set the MIDI Channel for your device.
DeviDevice TypeIn + OutConnected to a Layout Button, Slider or Tabbed Component named "Device Type". If you are using the standard ScopeSync GUI header, this will determine which buttons are made visible (using a Tabbed Component to show the right set):
1 - No extra buttons
2 - PRESET - Only show Preset button
3 - PRESETFX - Show Mono & Bypass buttons, as well as Preset button
4 - BCPRESET - As for 2, with the addition of a Patch Window button
5 - BSPRESETFX - As for 3, with the addition of a Patch Window button
ActiMIDI ActivityIn + OutConnected to a Layout Button or Slider named "MIDI Activity". Patch this in to show MIDI activity for your device.

ScopeSync ParamGroup

This module provides access to the parameters in a single Parameter Group. It should be linked up to a ScopeSync controller using the Extender array pad, which will pass on various settings, including network parameters, e.g. how to contact a plugin instance of ScopeSync. Only other setting is to tell it which Parameter Group it should handle, using the PmGp input pad.

Leave a Reply

Your email address will not be published. Required fields are marked *