+- shoop_control.constants.LoopMode_[Unknown,Stopped,Playing,Recording,PlayingDryThroughWet,RecordingDryIntoWet]
Constants to represent the various modes a loop can be in or transitioned to.
+
+- shoop_control.constants.Loop_[DontWaitForSync,DontAlignToSyncImmediately]
Special values to pass to loop functions.
+
+- shoop_control.loop_count(loop_selector) -> int
Count the amount of loops given by the selector.
+
+- shoop_control.loop_get_mode(loop_selector) -> list[LoopMode]
Get the current mode of the specified loops.
+
+- shoop_control.loop_get_next_mode(loop_selector) -> list[ LoopMode or nil ]
For the specified loops, get the upcoming mode transition, if any.
+
+- shoop_control.loop_get_next_mode_delay(loop_selector) -> list[ int or nil ]
For the specified loops, get the upcoming mode transition delay in cycles, if any.
+
+- shoop_control.loop_get_length(loop_selector) -> list[int]
Get the length of the specified loops in samples.
+
+- shoop_control.loop_get_which_selected() -> [[x1,y1],[x2,y2],…]
Get the coordinates of all currently selected loops.
+
+- shoop_control.loop_get_all() -> [[x1,y1],[x2,y2],…]
Get the coordinates of all loops.
+
+- shoop_control.loop_get_which_targeted() -> [x,y] | nil
Get the coordinates of the currently targeted loop, or None if none are targeted.
+
+- shoop_control.loop_get_by_mode(mode) -> [[x1,y1],[x2,y2],…]
Get the coordinates of all loops with the given mode.
+
+- shoop_control.loop_get_by_track(track) -> [[x1,y1],[x2,y2],…]
Get the coordinates of all loops with the given mode.
+
+- shoop_control.loop_get_gain(loop_selector) -> list[float]
Get the output audio gain of the specified loops as a gain factor.
+
+- shoop_control.loop_get_gain(loop_selector) -> list[float]
Get the output audio gain fader position as a fraction of its total range (0-1) of the given loop.
+
+- shoop_control.loop_set_gain(loop_selector, gain)
Set the output audio gain of the specified loops as a gain factor.
+
+- shoop_control.loop_set_gain(loop_selector)
Set the output audio gain fader position as a fraction of its total range (0-1) of the given loop.
+
+- shoop_control.loop_get_balance(loop_selector) -> list[float]
Get the output audio balance of the specified stereo loops.
+
+- shoop_control.loop_transition(loop_selector, mode, maybe_cycles_delay, maybe_align_to_sync_at)
Transition the given loops. Pass shoop_control.constants.Loop_DontWaitForSync and shoop_control.constants.Loop_DontAlignToSyncImmediately to maybe_cycles_delay and maybe_align_to_sync_at respectively, to disable them.
+
+- shoop_control.loop_trigger(loop_selector, mode)
Trigger the loop with the given mode. Equivalent to pressing the loop’s button in the UI. That means the way the trigger is interpreted also depends on the global controls for e.g. sync.
+
+- shoop_control.loop_trigger_grab(loop_selector, mode)
Trigger a ringbuffer grab on the given loop. Equivalent to pressing the grab button.
+
+- shoop_control.loop_record_n(loop_selector, n_cycles, cycles_delay)
Record the given loops for N cycles synchronously.
+
+- shoop_control.loop_record_with_targeted(loop_selector)
Record the given loops in sync with the currently targeted loop.
+
+- shoop_control.loop_set_balance(loop_selector, balance)
Set the audio output balance for the specified loops.
+
+- shoop_control.loop_select(loop_selector, deselect_others)
Select the specified loops. If deselect_others is true, all other loops are deselected.
+
+- shoop_control.loop_toggle_selected(loop_selector)
Toggle selection on the specified loops.
+
+- shoop_control.loop_target(loop_selector)
Target the specified loop. If the selector specifies more than one loop, a single loop in the set is chosen arbitrarily. If nil or no loop is passed, the targeted loop is cleared.
+
+- shoop_control.loop_toggle_targeted(loop_selector)
Target the specified loop or untarget it if already targeted. If the selector specifies more than one loop, a single loop in the set is chosen arbitrarily. If nil or no loop is passed, the targeted loop is cleared.
+
+- shoop_control.loop_clear(loop_selector)
Clear the given loops.
+
+- shoop_control.loop_clear_all()
Clear all loops.
+
+- shoop_control.loop_adopt_ringbuffers(loop_selector, reverse_cycle_start, cycles_length, go_to_cycle, go_to_mode)
For all channels in the given loops, grab the data currently in the ringbuffer and set it as the content (i.e. after-the-fact-recording or “grab”). reverse_cycle_start sets the start offset for playback. 0 means to play what was being recorded in the current sync loop cycle, 1 means start from the previous cycle, etc. go_to_cycle and go_to_mode can control the cycle and mode the loop will have right after adopting. cycles_length sets the loop length.
+
+- shoop_control.loop_compose_add_to_end(loop_selector, loop_selector, parallel)
Add a loop to the a composition. The first argument is the singular target loop in which the composition is stored. If empty, a composition is created. The second argument is the loop that should be added. The third argument is whether the addition should be parallel to the existing composition. If false, the loop is added to the end.
+
+- shoop_control.track_get_gain(track_selector) -> list[float]
Get the gain of the given track(s) as a gain factor.
+
+- shoop_control.track_get_balance(track_selector) -> list[float]
Get the balance of the given track(s) as a value between -1 and 1.
+
+- shoop_control.track_get_gain_fader(track_selector) -> list[float]
Get the gain of the given track(s) as a fraction of its total range (0-1).
+
+- shoop_control.track_get_input_gain(track_selector) -> list[float]
Get the input gain of the given track(s) as a gain factor.
+
+- shoop_control.track_get_input_gain_fader(track_selector) -> list[float]
Get the input gain of the given track(s) as a fraction of its total range (0-1).
+
+- shoop_control.track_get_muted(track_selector) -> list[bool]
Get whether the given track(s) is/are muted.
+
+- shoop_control.track_set_muted(track_selector, bool)
Set whether the given track is muted.
+
+- shoop_control.track_get_input_muted(track_selector) -> list[bool]
Get whether the given tracks’ input(s) is/are muted.
+
+- shoop_control.track_set_input_muted(track_selector, muted)
Set whether the given track’s input is muted.
+
+- shoop_control.track_set_gain(track_selector, vol)
Set the given track’s gain as a gain factor.
+
+- shoop_control.track_set_balance(track_selector, val)
Set the given track’s balance as a value between -1 and 1.
+
+- shoop_control.track_set_gain_fader(track_selector, vol)
Set the given track’s gain as a fraction of its total range (0-1).
+
+- shoop_control.track_set_input_gain(track_selector, vol)
Set the given track’s input gain as a gain factor.
+
+- shoop_control.track_set_input_gain_fader(track_selector, vol)
Set the given track’s input gain as a fraction of its total range (0-1).
+
+- shoop_control.set_apply_n_cycles(n)
Set the amount of sync loop cycles future actions will be executed for. Setting to 0 will disable this - actions will be open-ended.
+
+- shoop_control.get_apply_n_cycles(n)
Get the amount of sync loop cycles future actions will be executed for. 0 means disabled.
+
+- shoop_control.set_solo(val)
Set the global “solo” control state.
+
+- shoop_control.get_solo() -> bool
Get the global “solo” control state.
+
+- shoop_control.set_sync_active(val)
Set the global “sync_active” control state.
+
+- shoop_control.get_sync_active() -> bool
Get the global “sync_active” control state.
+
+- shoop_control.set_play_after_record(val)
Set the global “play_after_record” control state.
+
+- shoop_control.get_play_after_record() -> bool
Get the global “play_after_record” control state.
+
+- shoop_control.set_default_recording_action(val)
Set the global “default recording action” control state. Valid values are ‘record’ or ‘grab’ - others are ignored.
+
+- shoop_control.get_default_recording_action() -> string
Get the global “default recording action” control state (‘record’ or ‘grab’).
+
+
+
+
+- shoop_control.constants.Key_[…]
Keyboard key identifiers. Equal to Qt.Key_* (see Qt documentation).
+
+- shoop_control.constants.KeyEventType_[Pressed,Released]
Keyboard event type identifier.
+
+- shoop_control.auto_open_device_specific_midi_control_input(device_name_filter_regex, message_callback)
Instruct the application to automatically open a MIDI control input port if a device matching the regex appears, and connect to it. Also registers a callback for received MIDI events on such a port. See midi_callback for details.
+
+- shoop_control.auto_open_device_specific_midi_control_output(device_name_filter_regex, opened_callback, connected_callback, msg_rate_limit_hz)
Instruct the application to automatically open a MIDI control output port if a device matching the regex appears, and connect to it. Also registers callbacks for when the port is opened and connected. This callbacks just pass a port object which has a ‘send’ method to send bytes. “msg_rate_limit_hz” can be used to limit the rate at which messages will be sent to the port. Some devices become unstable if sent too fast. Setting this to 0 disables the limit.
+
+- shoop_control.register_keyboard_event_cb(callback)
Register a callback for keyboard events. See keyboard_callback for details.
+
+- midi_callback(message : midi_message, port : midi_control_port)
Callback type for MIDI control message received. See midi_message and midi_control_port types for details.
+
+- keyboard_callback(event_type : shoop.constants.KeyEventType_[Pressed, Released], key : shoop.constants.Key_[…], modifiers : shoop.constants.[Shift,Control,Alt]Modifier)
Callback type for keyboard events.
+
+- type midi_message
MIDI message type. Fields are: bytes (array of message bytes), note, channel, cc, value, program, velocity (only those fields which apply to the particular message).
+
+- type loop_callback
Loop event callback type. The callback takes arguments (coords, event), where coords is [x, y] coordinates of the event, and event is a table containing fields ‘mode’ (mode), ‘selected’ (bool), ‘targeted’ (bool) and ‘length’ (int). Coordinates map to the loop grid. Only the sync loop has a special location [-1,0].
+
+- type global_event_callback
Global event callback type. The callback takes arguments (event), where event can be one of: ‘control_change’ (a global control has changed, use other interfaces to re-check them)
+
+- shoop_control.register_loop_event_cb(callback)
Register a callback for loop events. See loop_callback for details.
+
+- shoop_control.register_global_event_cb(callback)
Register a callback for global events, e.g. global controls changes. See global_event_callback for details.
+
+- shoop_control.one_shot_timer_cb(callback, time_ms)
Register a callback to happen after the given amount of ms, once.
+
+
+
+
+
+
+
+
+
+
+
+
![component backend [
+ libshoopdaloop (C++ back-end)
+]
+component frontend [
+ shoopdaloop (QML front-end)
+]
+collections extensions [
+ Front-end Extensions (Python + PySide6)
+]
+interface interface [
+ libshoopdaloop C API
+]
+component scripting [
+ LUA scripts
+]
+
+backend - interface
+extensions ..> interface : uses
+frontend - extensions
+frontend ..> scripting : embeds](_images/plantuml-119690f1134cbd4a37cdee1ecb337275d4b688ed.png)
+
+
+
+
+
+
+
+
+