ableton.v3.control_surface.banking_util (runtime)

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

Module constants

• BANK_FORMAT = 'Bank %d'
• BANK_NAME_JOIN_STR = ' and '
• BANK_PARAMETERS_KEY = 'Parameters'
• DEFAULT_BANK_SIZE = 8

Functions

all_parameters(device)

ceil(x, /)

Return the ceiling of x as an Integral.

This is the smallest integer >= x.

create_parameter_bank(device, banking_info)

liveobj_valid(obj)

Classes

class BankingInfo(BankingInfo)

Properties

• bank_size
• num_simultaneous_banks

Methods

__init__(self, bank_definitions, bank_size=8, *a, **k)

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

device_bank_count(self, device, **k)

device_bank_definition(self, device)

device_bank_names(self, device, bank_name_join_str=' and ', **k)

has_bank_count(self, device)

has_bank_names(self, device)

has_main_bank(self, device)

class BankingInfoBase

Methods

__init__(self, bank_definitions)

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

device_bank_count(self, device, **k)

device_bank_definition(self, device)

device_bank_names(self, device, **k)

has_bank_count(self, device)

has_bank_names(self, device)

has_main_bank(self, device)

class DescribedDeviceParameterBank(DescribedDeviceParameterBank)

Properties

• device
• index
• name
• parameters

Methods

__init__(self, device=None, banking_info=None, *a, **k)

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

_adjust_index(self, index)

_calc_name(self)

_collect_parameters(self)

_content_slots(self)

_current_parameter_slots(self)

_get_index(self)

_is_index_valid(self, index)

_set_index(self, index)

_setup_dynamic_slots(self)

_update_parameters(self)

add_parameters_listener(self, slot, identify_sender=False, *a, **k)

bank_count(self)

disconnect(self)

disconnect_disconnectable(self, slot)

find_disconnectable(self, predicate)

has_disconnectable(self, slot)

notify_parameters(self, *a, **k)

parameters_has_listener(self, slot)

parameters_listener_count(self)

register_disconnectable(self, slot)

register_disconnectables(self, disconnectables)

register_slot(self, *a, **k)

remove_parameters_listener(self, slot)

unregister_disconnectable(self, slot)

Attributes

• _on_parameter_name_changed = None
• _on_parameters_changed = None
• _on_slot_content_changed = None

class DescribedDeviceParameterBankBase(DeviceParameterBank)

Properties

• device
• index
• name
• parameters

Methods

__init__(self, device=None, banking_info=None, *a, **k)

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

_adjust_index(self, index)

_calc_name(self)

_collect_parameters(self)

_content_slots(self)

_current_parameter_slots(self)

_get_index(self)

_is_index_valid(self, index)

_set_index(self, index)

_setup_dynamic_slots(self)

_update_parameters(self)

add_parameters_listener(self, slot, identify_sender=False, *a, **k)

bank_count(self)

disconnect(self)

disconnect_disconnectable(self, slot)

find_disconnectable(self, predicate)

has_disconnectable(self, slot)

notify_parameters(self, *a, **k)

parameters_has_listener(self, slot)

parameters_listener_count(self)

register_disconnectable(self, slot)

register_disconnectables(self, disconnectables)

register_slot(self, *a, **k)

remove_parameters_listener(self, slot)

unregister_disconnectable(self, slot)

Attributes

• _on_parameter_name_changed = None
• _on_parameters_changed = None
• _on_slot_content_changed = None

class DeviceParameterBank(DeviceParameterBank)

Properties

• device
• index
• name
• parameters

Methods

__init__(self, size=None, device=None, banking_info=None, *a, **k)

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

_adjust_index(self, index)

_calc_name(self)

_collect_parameters(self)

_get_index(self)

_is_index_valid(self, index)

_set_index(self, index)

_update_parameters(self)

add_parameters_listener(self, slot, identify_sender=False, *a, **k)

bank_count(self)

disconnect(self)

disconnect_disconnectable(self, slot)

find_disconnectable(self, predicate)

has_disconnectable(self, slot)

notify_parameters(self, *a, **k)

parameters_has_listener(self, slot)

parameters_listener_count(self)

register_disconnectable(self, slot)

register_disconnectables(self, disconnectables)

register_slot(self, *a, **k)

remove_parameters_listener(self, slot)

unregister_disconnectable(self, slot)

Attributes

• _on_parameters_changed = None

class DeviceParameterBankBase(EventObject)

Properties

• device
• index
• name
• parameters

Methods

__init__(self, size=None, device=None, banking_info=None, *a, **k)

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

_adjust_index(self, index)

_calc_name(self)

_collect_parameters(self)

_get_index(self)

_is_index_valid(self, index)

_set_index(self, index)

_update_parameters(self)

add_parameters_listener(self, slot, identify_sender=False, *a, **k)

bank_count(self)

disconnect(self)

disconnect_disconnectable(self, slot)

find_disconnectable(self, predicate)

has_disconnectable(self, slot)

notify_parameters(self, *a, **k)

parameters_has_listener(self, slot)

parameters_listener_count(self)

register_disconnectable(self, slot)

register_disconnectables(self, disconnectables)

register_slot(self, *a, **k)

remove_parameters_listener(self, slot)

unregister_disconnectable(self, slot)

Attributes

• _on_parameters_changed = None

class MaxDeviceParameterBank(MaxDeviceParameterBank)

Properties

• device
• index
• name
• parameters

Methods

__init__(self, *a, **k)

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

_adjust_index(self, index)

_calc_name(self)

_collect_parameters(self)

_get_index(self)

_get_parameters_for_bank_index(self, bank_index)

_is_index_valid(self, index)

_set_index(self, index)

_update_parameters(self)

add_parameters_listener(self, slot, identify_sender=False, *a, **k)

bank_count(self)

disconnect(self)

disconnect_disconnectable(self, slot)

find_disconnectable(self, predicate)

has_disconnectable(self, slot)

notify_parameters(self, *a, **k)

parameters_has_listener(self, slot)

parameters_listener_count(self)

register_disconnectable(self, slot)

register_disconnectables(self, disconnectables)

register_slot(self, *a, **k)

remove_parameters_listener(self, slot)

unregister_disconnectable(self, slot)

Attributes

• _on_bank_parameters_changed = None
• _on_parameters_changed = None

class MaxDeviceParameterBankBase(DeviceParameterBank)

Properties

• device
• index
• name
• parameters

Methods

__init__(self, *a, **k)

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

_adjust_index(self, index)

_calc_name(self)

_collect_parameters(self)

_get_index(self)

_is_index_valid(self, index)

_set_index(self, index)

_update_parameters(self)

add_parameters_listener(self, slot, identify_sender=False, *a, **k)

bank_count(self)

disconnect(self)

disconnect_disconnectable(self, slot)

find_disconnectable(self, predicate)

has_disconnectable(self, slot)

notify_parameters(self, *a, **k)

parameters_has_listener(self, slot)

parameters_listener_count(self)

register_disconnectable(self, slot)

register_disconnectables(self, disconnectables)

register_slot(self, *a, **k)

remove_parameters_listener(self, slot)

unregister_disconnectable(self, slot)

Attributes

• _on_bank_parameters_changed = None
• _on_parameters_changed = None