Skip to content

Ableton Live MIDI Remote Scripts — Unofficial Docs & Tools

ableton.v2.control_surface.components.drum_group (runtime)

`ableton.v2.control_surface.components.drum_group` (runtime)¶

Live 12 — Live Object Model & framework reference (descriptions and signatures).

Module constants¶

BASE_DRUM_RACK_NOTE = 36

Functions¶

`clamp(val, minv, maxv)`¶

`depends(**dependencies)`¶

`find_if(predicate, seq)`¶

`first(seq)`¶

`listens(event_path, *a, **k)`¶

`listens_group(event_name, *a, **k)`¶

`liveobj_changed(obj, other)`¶

`liveobj_valid(obj)`¶

Classes¶

class `ButtonControl(ButtonControlBase)`¶

Properties¶

double_clicked
pressed
pressed_delayed
released
released_delayed
released_immediately
value

Methods¶

`State(color='DefaultButton.On', *a, **k)`¶

`init(self, *a, **k)`¶

Initialize self. See help(type(self)) for accurate signature.

`_clear_state(self, manager)`¶

`_get_state(self, manager, state_factory=None)`¶

`_make_control_state(self, manager)`¶

Attributes¶

DELAY_TIME = 0.3 - Convert a string or number to a floating point number, if possible.
DOUBLE_CLICK_TIME = 0.5 - Convert a string or number to a floating point number, if possible.
REPEAT_RATE = 0.1 - Convert a string or number to a floating point number, if possible.
_extra_args = [] - Built-in mutable sequence.
_extra_kws = {} - dict() -> new empty dictionary

class `DrumGroupComponent(PlayableComponent, SlideComponent, Slideable)`¶

Properties¶

application
assigned_drum_pads
has_assigned_pads
height
is_root
layer
max_pitch
min_pitch
parent
position
song
width

Methods¶

`init(self, translation_channel=None, set_pad_translations=None, *a, **k)`¶

Initialize self. See help(type(self)) for accurate signature.

`_add_child(self, component)`¶

`_button_coordinates_to_pad_index(self, first_note, coordinates)`¶

`_button_should_be_enabled(self, button)`¶

`_can_set_pad_translations(self)`¶

`_color_for_pad(self, pad)`¶

`_create_and_set_pad_translations(self)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_note_translation_for_button(self, button)`¶

`_on_matrix_pressed(self, button)`¶

`_on_matrix_released(self, button)`¶

`_on_selected_drum_pad_changed(self)`¶

`_pad_for_button(self, button)`¶

`_release_all_layers(self)`¶

`_reset_selected_pads(self)`¶

`_scroll_page(self, sign)`¶

`_scroll_position(self, delta)`¶

`_set_button_control_properties(self, button)`¶

`_set_control_pads_from_script(self, takeover_pads)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_assigned_drum_pads(self)`¶

`_update_button_color(self, button)`¶

`_update_control_from_script(self)`¶

`_update_drum_pad_listeners(self)`¶

`_update_is_enabled(self)`¶

`_update_led_feedback(self)`¶

`_update_note_translations(self)`¶

`_update_selected_drum_pad(self)`¶

`add_children(self, *a)`¶

`add_contents_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_control(self, name, control)`¶

`add_enabled_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_page_length_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_page_offset_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_position_count_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_position_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_pressed_pads_listener(self, slot, identify_sender=False, *a, **k)`¶

`can_scroll_down(self)`¶

`can_scroll_page_down(self)`¶

`can_scroll_page_up(self)`¶

`can_scroll_up(self)`¶

`contents(self, index)`¶

`contents_has_listener(self, slot)`¶

`contents_listener_count(self)`¶

`contents_range(self, pmin, pmax)`¶

`control_notifications_enabled(self)`¶

`delete_pitch(self, drum_pad)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`enabled_has_listener(self, slot)`¶

`enabled_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`is_enabled(self, explicit=False)`¶

`notify_contents(self, *a, **k)`¶

`notify_enabled(self, *a, **k)`¶

`notify_page_length(self, *a, **k)`¶

`notify_page_offset(self, *a, **k)`¶

`notify_position(self, *a, **k)`¶

`notify_position_count(self, *a, **k)`¶

`notify_pressed_pads(self, *a, **k)`¶

`on_enabled_changed(self)`¶

`page_length_has_listener(self, slot)`¶

`page_length_listener_count(self)`¶

`page_offset_has_listener(self, slot)`¶

`page_offset_listener_count(self)`¶

`position_count_has_listener(self, slot)`¶

`position_count_listener_count(self)`¶

`position_has_listener(self, slot)`¶

`position_listener_count(self)`¶

`pressed_pads_has_listener(self, slot)`¶

`pressed_pads_listener_count(self)`¶

`quantize_pitch(self, note)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(self, *a, **k)`¶

`remove_contents_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`remove_page_length_listener(self, slot)`¶

`remove_page_offset_listener(self, slot)`¶

`remove_position_count_listener(self, slot)`¶

`remove_position_listener(self, slot)`¶

`remove_pressed_pads_listener(self, slot)`¶

`scroll_down(self)`¶

`scroll_page_down(self)`¶

`scroll_page_up(self)`¶

`scroll_up(self)`¶

`select_drum_pad(self, drum_pad)`¶

`set_accent_button(self, button)`¶

`set_drum_group_device(self, drum_group_device)`¶

`set_enabled(self, enable)`¶

`set_full_velocity(self, full_velocity)`¶

`set_matrix(self, matrix)`¶

`set_scroll_down_button(self, button)`¶

`set_scroll_page_down_button(self, button)`¶

`set_scroll_page_up_button(self, button)`¶

`set_scroll_up_button(self, button)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_DrumGroupComponent__on_chains_changed = None
_DrumGroupComponent__on_drum_pads_scroll_position_changed = None
_DrumGroupComponent__on_mute_changed = None
_DrumGroupComponent__on_selected_drum_pad_changed = None
_DrumGroupComponent__on_solo_changed = None
_DrumGroupComponent__on_visible_drum_pads_changed = None
_SlideComponent__on_position_changed = None
_has_task_group = False - bool(x) -> bool
_layer = None
canonical_parent = None
delete_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x13c400c10>
is_private = False - bool(x) -> bool
matrix = <ableton.v2.base.util.Mixin_MatrixControl_PlayableControl object at 0x13c402190>
mute_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x11af9ca50>
name = '' - str(object='') -> str
page_length = 4 - int([x]) -> integer
page_offset = 1 - int([x]) -> integer
position_count = 32 - int([x]) -> integer
pressed_pads = [] - Built-in mutable sequence.
quantize_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x13c4031d0>
select_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x13c402390>
solo_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x13c401310>

class `PlayableComponent(Component)`¶

Properties¶

application
height
is_root
layer
parent
song
width

Methods¶

`init(self, *a, **k)`¶

Initialize self. See help(type(self)) for accurate signature.

`_add_child(self, component)`¶

`_button_should_be_enabled(self, button)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_note_translation_for_button(self, button)`¶

`_on_matrix_pressed(self, button)`¶

`_on_matrix_released(self, button)`¶

`_release_all_layers(self)`¶

`_reset_selected_pads(self)`¶

`_set_button_control_properties(self, button)`¶

`_set_control_pads_from_script(self, takeover_pads)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_button_color(self, button)`¶

`_update_control_from_script(self)`¶

`_update_is_enabled(self)`¶

`_update_led_feedback(self)`¶

`_update_note_translations(self)`¶

`add_children(self, *a)`¶

`add_control(self, name, control)`¶

`add_enabled_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_pressed_pads_listener(self, slot, identify_sender=False, *a, **k)`¶

`control_notifications_enabled(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`enabled_has_listener(self, slot)`¶

`enabled_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`is_enabled(self, explicit=False)`¶

`notify_enabled(self, *a, **k)`¶

`notify_pressed_pads(self, *a, **k)`¶

`on_enabled_changed(self)`¶

`pressed_pads_has_listener(self, slot)`¶

`pressed_pads_listener_count(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(self, *a, **k)`¶

`remove_enabled_listener(self, slot)`¶

`remove_pressed_pads_listener(self, slot)`¶

`set_accent_button(self, button)`¶

`set_enabled(self, enable)`¶

`set_full_velocity(self, full_velocity)`¶

`set_matrix(self, matrix)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_has_task_group = False - bool(x) -> bool
_layer = None
canonical_parent = None
is_private = False - bool(x) -> bool
matrix = <ableton.v2.base.util.Mixin_MatrixControl_PlayableControl object at 0x13c402190>
name = '' - str(object='') -> str
pressed_pads = [] - Built-in mutable sequence.
select_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x13c402390>

class `SlideComponent(Component, Scrollable)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, slideable=None, *a, **k)`¶

Initialize self. See help(type(self)) for accurate signature.

`_add_child(self, component)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_scroll_page(self, sign)`¶

`_scroll_position(self, delta)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`add_children(self, *a)`¶

`add_control(self, name, control)`¶

`add_enabled_listener(self, slot, identify_sender=False, *a, **k)`¶

`can_scroll_down(self)`¶

`can_scroll_page_down(self)`¶

`can_scroll_page_up(self)`¶

`can_scroll_up(self)`¶

`control_notifications_enabled(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`enabled_has_listener(self, slot)`¶

`enabled_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`is_enabled(self, explicit=False)`¶

`notify_enabled(self, *a, **k)`¶

`on_enabled_changed(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(self, *a, **k)`¶

`remove_enabled_listener(self, slot)`¶

`scroll_down(self)`¶

`scroll_page_down(self)`¶

`scroll_page_up(self)`¶

`scroll_up(self)`¶

`set_enabled(self, enable)`¶

`set_scroll_down_button(self, button)`¶

`set_scroll_page_down_button(self, button)`¶

`set_scroll_page_up_button(self, button)`¶

`set_scroll_up_button(self, button)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_SlideComponent__on_position_changed = None
_has_task_group = False - bool(x) -> bool
_layer = None
canonical_parent = None
is_private = False - bool(x) -> bool
name = '' - str(object='') -> str

class `Slideable(EventObject)`¶

Properties¶

page_length
page_offset
position
position_count

Methods¶

`init(self, *a, **k)`¶

Initialize self. See help(type(self)) for accurate signature.

`add_contents_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_page_length_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_page_offset_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_position_count_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_position_listener(self, slot, identify_sender=False, *a, **k)`¶

`contents(self, position)`¶

`contents_has_listener(self, slot)`¶

`contents_listener_count(self)`¶

`contents_range(self, pmin, pmax)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`notify_contents(self, *a, **k)`¶

`notify_page_length(self, *a, **k)`¶

`notify_page_offset(self, *a, **k)`¶

`notify_position(self, *a, **k)`¶

`notify_position_count(self, *a, **k)`¶

`page_length_has_listener(self, slot)`¶

`page_length_listener_count(self)`¶

`page_offset_has_listener(self, slot)`¶

`page_offset_listener_count(self)`¶

`position_count_has_listener(self, slot)`¶

`position_count_listener_count(self)`¶

`position_has_listener(self, slot)`¶

`position_listener_count(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(self, *a, **k)`¶

`remove_contents_listener(self, slot)`¶

`remove_page_length_listener(self, slot)`¶

`remove_page_offset_listener(self, slot)`¶

`remove_position_count_listener(self, slot)`¶

`remove_position_listener(self, slot)`¶

`unregister_disconnectable(self, slot)`¶