store

The "store" contains state and app-wide methods.
Source:

Members

(inner, constant) app

Source:
Properties:
Name Type Description
INITIALIZED Is app initializated and ready to use?
APP_ID
CURRENT_PAGE What page the layout is currently showing. @see layout
Tracks App State

(inner, constant) jack

Source:
Properties:
Name Type Description
JACK_STATUS Jack server status and info
TRANSPORT_STATUS Jack Transport and info
PORTS Audio and midi ports availbale to use
CONNECTIONS Tracks the connection settings @see settings
Tracks several Jack Statuses

Methods

(async, inner) addPluginToRack(pluginName)

Source:
Adds a plugin to the rack. It will reprocess the connections stack, and notify subscribers of __rack__
Parameters:
Name Type Description
pluginName string The plugin name as appears in the plugin catalog JSON file.
Fires:
  • notifySubscribers (rack)

(inner) clearRack()

Source:
"Safely" Removes all plugins from rack.

(inner) connectAll()

Source:
Process connections for each plugin.

(inner) connectLastToMasterOutputs()

Source:
Connect ONLY last plugin to master output(s). If one of them is mono, adjust as necesary.

(inner) connectPlugins(src, dst)

Source:
This function will force connection between 2 plugins. If one of them is mono, adjust as necesary
Parameters:
Name Type Description
src *
dst *

(inner) disconnectAll()

Source:
Disconnects all plugin outputs

(inner) getJackStatus()

Source:
Returns:
Returns JACK state

(inner) moveRackItem(rackIndex, direction, maxopt)

Source:
Moves a plugin in the rack. It will trigger a reconnection among (max 3) affected plugins
Parameters:
Name Type Attributes Default Description
rackIndex number Rack Index of plugin to move.
direction string ["up"|"down"] Direction to move the plugin.
max boolean <optional>
 false By default it will move 1 unit. If this is true, it will position the plugin on the top/bottom of the rack.
Fires:
  • notifySubscribers(rack)

(inner) notifySubscribers(topic, data)

Source:
Notify all subscribers of a given topic.
Parameters:
Name Type Description
topic * Topic to target
data * Data to send.

(inner) processConnections()

Source:
This function will process

(async, inner) reconectAll()

Source:
Disconnects and reconnects every plugin;

(inner) removePluginAt(index)

Source:
Removes a plugin according to the index on the rack.
Parameters:
Name Type Description
index * Rack Index

(inner) setAudioSource(mode, channel, name)

Source:
See:
  • settings
Sets an audio source for a specific channel. It will trigger a total reconnection.
Parameters:
Name Type Description
mode * Mode should be input or output
channel * 'left' or 'right'
name * The name of the jack audio source.
Fires:
  • event:notifySubscribers

(inner) setAudioSourceMode(direction, mode)

Source:
Set Input/Output mode to mono or stereo. This will trigger a complete reconnection of all plugins
Parameters:
Name Type Description
direction * 'input | output
mode * mono | stereo
Fires:
  • notifySubscribers (jack)

(inner) setCurrentPage()

Source:
See:
  • layout
Sets the current Carrousel Page, and notify subscribers.

(inner) setJackStatus(jackStatusopt, transport_statusopt, portsopt, connectionsopt)

Source:
See:
  • jack_client
Sets Jack status and notify subscribers. This function is used in the jack widget polling.
Parameters:
Name Type Attributes Default Description
jackStatus * <optional>
 jack.JACK_STATUS
transport_status * <optional>
 jack.TRANSPORT_STATUS
ports * <optional>
 jack.PORTS
connections * <optional>
 jack.CONNECTIONS

(inner) setSelectedPluginIndex(pluginName)

Source:
Sets the plugin that will be focused to edit.
Parameters:
Name Type Description
pluginName *

(inner) wlog(msg)

Source:
To Do:
  • Move to the widget module.
Logs a message in the log-widget
Parameters:
Name Type Description
msg * message to log.

(inner) wlogError()

Source:
Logs an error message in the log Widget * @param {*} msg