Skip to content

_Framework.ControlSurface

Module constants

  • logger
  • CS_LIST_KEY = 'control_surfaces'

Classes

class ControlSurface(Subject, SlotManager)

Bases: Subject, SlotManager

Attributes

  • received_midi = ()
  • _tasks

__init__(self, c_instance, *a, **k)

components(self)

root_components(self)

_get_tasks(self)

application(self)

song(self)

disconnect(self)

_control_surfaces(self)

can_lock_to_devices(self)

lock_to_device(self, device)

unlock_from_device(self, device)

restore_bank(self, bank_index)

suggest_input_port(self)

suggest_output_port(self)

suggest_map_mode(self, cc_no, channel)

suggest_needs_takeover(self, cc_no, channel)

supports_pad_translation(self)

set_highlighting_session_component(self, session_component)

highlighting_session_component(self)

show_message(self, message)

log_message(self, *message)

instance_identifier(self)

connect_script_instances(self, instanciated_scripts)

request_rebuild_midi_map(self)

build_midi_map(self, midi_map_handle)

toggle_lock(self)

port_settings_changed(self)

refresh_state(self)

update(self)

update_display(self)

receive_midi(self, midi_bytes)

is_sysex_message(self, midi_bytes)

_do_receive_midi(self, midi_bytes)

get_recipient_for_nonsysex_midi_message(self, midi_bytes)

handle_nonsysex(self, midi_bytes)

handle_sysex(self, midi_bytes)

set_device_component(self, device_component)

suppressing_rebuild_requests(self)

_set_suppress_rebuild_requests(self, suppress_requests)

set_pad_translations(self, pad_translations)

set_enabled(self, enable)

schedule_message(self, delay_in_ticks, callback, parameter)

_process_remaining_scheduled_messages(self)

set_feedback_channels(self, channels)

set_controlled_track(self, track)

release_controlled_track(self)

_register_control(self, control)

_register_component(self, component)

_disconnect_and_unregister_all_components(self)

component_guard(self)

in_component_guard(self)

_component_guard(self)

call_listeners(self, listeners)

accumulating_midi_messages(self)

get_control_by_name(self, control_name)

_send_midi(self, midi_event_bytes, optimized)

_flush_midi_messages(self)

_do_send_midi(self, midi_event_bytes)

_install_mapping(self, midi_map_handle, control, parameter, feedback_delay, feedback_map)

_install_forwarding(self, midi_map_handle, control)

_translate_message(self, type, from_identifier, from_channel, to_identifier, to_channel)

_set_session_highlight(self, track_offset, scene_offset, width, height, include_return_tracks)

_on_track_list_changed(self)

_on_scene_list_changed(self)

_on_selected_track_changed(self)

_on_selected_scene_changed(self)

_toggle_lock(self)

_refresh_displays(self)

class OptimizedControlSurface(ControlSurface)

Bases: ControlSurface

__init__(self, *a, **k)

_component_guard(self)

_register_control(self, control)

Functions

_scheduled_method(method)

publish_control_surface(control_surface)

get_control_surfaces()