Skip to content

_Framework.DeviceComponent (runtime)

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

Functions

best_of_parameter_bank(device, device_bob_dict={'AudioEffectGroupDevice': (('Macro 1', 'Macro 2', 'Macro 3', 'Macro 4', 'Macro 5', 'Macro 6', 'Macro 7', 'Macro 8'),), 'MidiEffectGroupDevice': (('Macro 1', 'Macro 2', 'Macro 3', 'Macro 4', 'Macro 5', 'Macro 6', 'Macro 7', 'Macro 8'),), 'InstrumentGroupDevice': (('Macro 1', 'Macro 2', 'Macro 3', 'Macro 4', 'Macro 5', 'Macro 6', 'Macro 7', 'Macro 8'),), 'DrumGroupDevice': (('Macro 1', 'Macro 2', 'Macro 3', 'Macro 4', 'Macro 5', 'Macro 6', 'Macro 7', 'Macro 8'),), 'InstrumentImpulse': (('Global Time', 'Global Transpose', '1 Transpose', '2 Transpose', '3 Transpose', '4 Transpose', '5 Transpose', '6 Transpose'),), 'Operator': (('Filter Freq', 'Filter Res', 'A Coarse', 'A Fine', 'B Coarse', 'B Fine', 'Osc-B Level', 'Volume'),), 'UltraAnalog': (('F1 Freq', 'F1 Resonance', 'OSC1 Shape', 'OSC1 Octave', 'OSC2 Shape', 'OSC2 Octave', 'OSC2 Detune', 'Volume'),), 'OriginalSimpler': (('Filter Freq', 'Filter Res', 'S Start', 'S Length', 'Ve Attack', 'Ve Release', 'Transpose', 'Volume'),), 'MultiSampler': (('Filter Freq', 'Filter Res', 'Fe < Env', 'Fe Decay', 'Ve Attack', 'Ve Release', 'Transpose', 'Volume'),), 'MidiArpeggiator': (('Synced Rate', 'Free Rate', 'Transp. Steps', 'Transp. Dist.', 'Gate', 'Tranpose Key', 'Velocity Decay', 'Velocity Target'),), 'LoungeLizard': (('M Stiffness', 'M Force', 'Noise Amount', 'F Tine Vol', 'F Tone Vol', 'F Release', 'P Symmetry', 'Volume'),), 'StringStudio': (('Filter Freq', 'Filter Reso', 'Filter Type', 'Exciter Type', 'E Pos', 'String Decay', 'Str Damping', 'Volume'),), 'Collision': (('Res 1 Brightness', 'Res 1 Type', 'Mallet Stiffness', 'Mallet Noise Amount', 'Res 1 Inharmonics', 'Res 1 Decay', 'Res 1 Tune', 'Volume'),), 'MidiChord': (('Shift1', 'Shift2', 'Shift3', 'Shift4', 'Shift5', 'Velocity5', 'Shift6', 'Velocity6'),), 'MidiNoteLength': (('Sync On', 'Time Length', 'Synced Length', 'Gate', 'On/Off-Balance', 'Decay Time', 'Decay Key Scale', ''),), 'MidiPitcher': (('Pitch', 'Range', 'Lowest', '', '', '', '', ''),), 'MidiRandom': (('Chance', 'Choices', 'Scale', 'Sign', '', '', '', ''),), 'MidiScale': (('Base', 'Transpose', 'Range', 'Lowest', '', '', '', ''),), 'MidiVelocity': (('Drive', 'Compand', 'Random', 'Mode', 'Out Hi', 'Out Low', 'Range', 'Lowest'),), 'AutoFilter': (('Frequency', 'Resonance', 'Filter Type', 'Env. Modulation', 'LFO Amount', 'LFO Waveform', 'LFO Frequency', 'LFO Phase'),), 'AutoPan': (('Frequency', 'Phase', 'Shape', 'Waveform', 'Sync Rate', 'Offset', 'Width (Random)', 'Amount'),), 'BeatRepeat': (('Grid', 'Interval', 'Offset', 'Gate', 'Pitch', 'Pitch Decay', 'Variation', 'Chance'),), 'Chorus': (('LFO Amount', 'LFO Rate', 'Delay 1 Time', 'Delay 1 HiPass', 'Delay 2 Time', 'Delay 2 Mode', 'Feedback', 'Dry/Wet'),), 'Compressor2': (('Threshold', 'Ratio', 'Attack', 'Release', 'Model', 'Knee', 'Dry/Wet', 'Output Gain'),), 'Corpus': (('Brightness', 'Resonance Type', 'Material', 'Inharmonics', 'Decay', 'Ratio', 'Tune', 'Dry Wet'),), 'Eq8': (('1 Frequency A', '1 Gain A', '2 Frequency A', '2 Gain A', '3 Frequency A', '3 Gain A', '4 Frequency A', '4 Gain A'),), 'FilterEQ3': (('GainLo', 'GainMid', 'GainHi', 'FreqLo', 'LowOn', 'MidOn', 'HighOn', 'FreqHi'),), 'Erosion': (('Frequency', 'Width', 'Mode', 'Amount', '', '', '', ''),), 'FilterDelay': (('2 Filter Freq', '2 Filter Width', '2 Beat Delay', '2 Feedback', '1 Volume', '3 Volume', '2 Volume', 'Dry'),), 'Flanger': (('Hi Pass', 'Delay Time', 'Frequency', 'Sync Rate', 'LFO Amount', 'Env. Modulation', 'Feedback', 'Dry/Wet'),), 'FrequencyShifter': (('Coarse', 'Fine', 'Mode', 'Ring Mod Frequency', 'Drive On/Off', 'Drive', 'Wide', 'Dry/Wet'),), 'GrainDelay': (('Frequency', 'Pitch', 'Time Delay', 'Beat Swing', 'Random', 'Spray', 'Feedback', 'DryWet'),), 'Looper': (('State', 'Speed', 'Reverse', 'Quantization', 'Monitor', 'Song Control', 'Tempo Control', 'Feedback'),), 'MultibandDynamics': (('Above Threshold (Low)', 'Above Ratio (Low)', 'Above Threshold (Mid)', 'Above Ratio (Mid)', 'Above Threshold (High)', 'Above Ratio (High)', 'Master Output', 'Amount'),), 'Overdrive': (('Filter Freq', 'Filter Width', 'Drive', 'Tone', 'Preserve Dynamics', '', '', 'Dry/Wet'),), 'Phaser': (('Frequency', 'Feedback', 'Poles', 'Env. Modulation', 'Color', 'LFO Amount', 'LFO Frequency', 'Dry/Wet'),), 'Redux': (('Bit Depth', 'Sample Mode', 'Sample Hard', 'Sample Soft', 'Bit On', '', '', ''),), 'Saturator': (('Drive', 'Type', 'Base', 'Frequency', 'Width', 'Depth', 'Output', 'Dry/Wet'),), 'Resonator': (('Decay', 'I Note', 'II Pitch', 'III Pitch', 'IV Pitch', 'V Pitch', 'Global Gain', 'Dry/Wet'),), 'StereoGain': (('Left Inv', 'Right Inv', 'Channel Mode', 'Stereo Width', 'Mono', 'Balance', 'Gain', 'Mute'),), 'Tube': (('Drive', 'Bias', 'Envelope', 'Tone', 'Attack', 'Release', 'Output', 'Dry/Wet'),), 'Reverb': (('Decay Time', 'Room Size', 'Predelay', 'In Filter Freq', 'Reflect Level', 'Diffuse Level', 'Stereo Image', 'Dry/Wet'),), 'Vinyl': (('Tracing Freq.', 'Tracing Width', 'Tracing Drive', 'Crackle Density', 'Pinch Freq.', 'Pinch Width', 'Pinch Drive', 'Crackle Volume'),), 'Gate': (('Threshold', 'Return', 'FlipMode', 'LookAhead', 'Attack', 'Hold', 'Release', 'Floor'),), 'Vocoder': (('Formant Shift', 'Attack Time', 'Release Time', 'Unvoiced Level', 'Gate Threshold', 'Filter Bandwidth', 'Envelope Depth', 'Dry/Wet'),), 'Amp': (('Amp Type', 'Bass', 'Middle', 'Treble', 'Presence', 'Gain', 'Volume', 'Dry/Wet'),), 'Cabinet': (('Cabinet Type', 'Microphone Position', 'Microphone Type', 'Dual Mono', '', '', '', 'Dry/Wet'),), 'GlueCompressor': (('Threshold', 'Ratio', 'Attack', 'Release', 'Peak Clip In', 'Range', 'Makeup', 'Dry/Wet'),), 'Pedal': (('Type', 'Gain', 'Output', 'Bass', 'Mid', 'Treble', 'Sub', 'Dry/Wet'),), 'DrumBuss': (('Drive', 'Drive Type', 'Crunch', 'Boom Amt', 'Trim', 'Damping Freq', 'Output Gain', 'Dry/Wet'),), 'Echo': (('L Division', 'R Division', 'L Time', 'R Time', 'Input Gain', 'Feedback', 'Stereo Width', 'Dry Wet'),), 'InstrumentVector': (('Osc 1 Pos', 'Osc 1 Transp', 'Osc 2 Pos', 'Osc 2 Transp', 'Filter 1 Freq', 'Filter 1 Res', 'Global Mod Amount', 'Volume'),)})

device_parameters_to_map(device)

device_to_appoint(device)

liveobj_valid(obj)

parameter_bank_names(device, bank_name_dict={'AudioEffectGroupDevice': ('Macros', 'Macros 2'), 'MidiEffectGroupDevice': ('Macros', 'Macros 2'), 'InstrumentGroupDevice': ('Macros', 'Macros 2'), 'DrumGroupDevice': ('Macros', 'Macros 2'), 'InstrumentImpulse': ('Pad 1', 'Pad 2', 'Pad 3', 'Pad 4', 'Pad 5', 'Pad 6', 'Pad 7', 'Pad 8'), 'Operator': ('Oscillator A', 'Oscillator B', 'Oscillator C', 'Oscillator D', 'LFO', 'Filter', 'Pitch Modulation', 'Routing'), 'UltraAnalog': ('Oscillators', 'Filters', 'Filter Envelopes', 'Filter Modulation', 'Volume Envelopes', 'Mix', 'Output'), 'OriginalSimpler': ('Amplitude', 'Filter', 'LFO', 'Pitch Modifiers'), 'MultiSampler': ('Volume', 'Filter', 'Filter Envelope', 'LFO 1', 'LFO 2', 'LFO 3', 'Oscillator', 'Pitch'), 'MidiArpeggiator': ('Style', 'Pitch/Velocity'), 'LoungeLizard': ('Mallet and Tine', 'Tone and Damper', 'Pickup', 'Modulation', 'Global'), 'StringStudio': ('Exciter and String', 'Damper', 'Termination and Pickup', 'Body', 'Vibrato', 'Filter', 'Envelope and LFO', 'Global'), 'Collision': ('Mallet', 'Noise', 'Resonator 1, Set A', 'Resonator 1, Set B', 'Resonator 2, Set A', 'Resonator 2, Set B'), 'MidiChord': ('Shift', 'Shift %'), 'BeatRepeat': ('Repeat Rate', 'Gate/Pitch'), 'Compressor2': ('Compression', 'Output', 'Side Chain'), 'Corpus': ('Amount', 'Body', 'Tune'), 'Eq8': ('Band On/Off', 'Frequency', 'Gain', 'Resonance', 'Filter Type', 'Output', 'EQs 3-5'), 'FilterDelay': ('Input L Filter', 'Input L+R Filter', 'Input R Filter'), 'Flanger': ('Frequency Controls', 'LFO / S&H'), 'Gate': ('Gate', 'Side Chain'), 'MultibandDynamics': ('Global', 'Low Band', 'Mid Band', 'High Band', 'Split Frequencies', 'Side Chain'), 'Phaser': ('Frequency Controls', 'LFO / S&H'), 'Saturator': ('General Controls', 'Waveshaper Controls'), 'Resonator': ('General / Mode I', 'Modes II-IV'), 'Reverb': ('Reflections', 'Diffusion Network', 'Global'), 'Vocoder': ('Global', 'Filters/Voicing', 'Carrier'), 'Amp': ('Global', 'Dual Mono'), 'GlueCompressor': ('Compression', 'Side Chain'), 'AutoFilter': ('Filter', 'Filter Extra', 'Side Chain'), 'StereoGain': ('General Controls', 'Low Frequency'), 'DrumBuss': ('Drive', 'Gain'), 'Echo': ('Sync', 'Time', 'Gate/Ducking', 'Noise/Wobble', 'Gain', 'Filter', 'Reverb', 'Modulation'), 'Pedal': ('General', 'Eq'), 'InstrumentVector': ('Oscillator 1', 'Oscillator 2', 'Filter 1', 'Filter 2', 'Amp Envelope', 'Envelope 2/3', 'LFO 1/2', 'Global')})

select_and_appoint_device(song, device_to_select, ignore_unmapped_macros=True)

subject_slot(events, *a, **k)

subject_slot_group(event, *a, **k)

Classes

class ButtonElement(InputControlElement, ButtonElementMixin)

Properties

  • _last_sent_value
  • mapping_sensitivity
  • resource
  • suppress_script_forwarding

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, is_momentary, msg_type, channel, identifier, skin=<_Framework.Skin.Skin object at 0x162cc2940>, undo_step_handler=<_Framework.ButtonElement.DummyUndoStepHandler object at 0x162cc29e8>, *a, **k)

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

_do_send_value(self, value, channel=None)
_get_mapping_sensitivity(self)
_get_suppress_script_forwarding(self)
_mapping_feedback_values(self)
_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_report_value(self, value, is_input)
_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)
_send_delayed_messages(self)
_set_mapping_sensitivity(self, sensitivity)
_set_skin_light(self, value)
_set_suppress_script_forwarding(self, value)
_status_byte(self, channel)
_verify_value(self, value)
add_value_listener(self, slot, identify_sender=False, *a, **k)
begin_gesture(self)
clear_send_cache(self)
clear_value_listeners(self)
connect_to(self, parameter)
disconnect(self)
end_gesture(self)
force_next_send(self)
identifier_bytes(self)
install_connections(self, install_translation, install_mapping, install_forwarding)
is_momentary(self)
is_pressed(self)
mapped_parameter(self)
message_channel(self)
message_identifier(self)
message_map_mode(self)
message_sysex_identifier(self)
message_type(self)
needs_takeover(self)
notify_ownership_change(self, client, grabbed, element_ownership_handler=None)
notify_value(self, *a, **k)
original_channel(self)
original_identifier(self)
receive_value(self, value)
release_parameter(self)
remove_value_listener(self, slot)
reset(self)
reset_state(self)
script_wants_forwarding(self)
send_midi(self, message)
send_value(self, value, force=False, channel=None)
set_channel(self, channel)
set_feedback_delay(self, delay)
set_identifier(self, identifier)
set_light(self, value)
set_needs_takeover(self, needs_takeover)
set_report_values(self, report_input, report_output)
turn_off(self)
turn_on(self)
use_default_message(self)
value_has_listener(self, slot)
value_listener_count(self)

Attributes

  • _has_resource = False - bool(x) -> bool
  • _has_task_group = False - bool(x) -> bool
  • _input_signal_listener_count = 0 - int([x]) -> integer
  • _resource = <_Framework.Util.lazy_attribute object at 0x162c99550>
  • _tasks = <_Framework.Util.lazy_attribute object at 0x162c995f8>
  • canonical_parent = None
  • name = '' - str(object='') -> str
  • num_delayed_messages = 1 - int([x]) -> integer
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <_Framework.Util.lazy_attribute object at 0x162c91b00>
  • send_depends_on_forwarding = True - bool(x) -> bool

class ControlSurfaceComponent(ControlManager, Subject)

class DeviceBankRegistry(Subject)

Methods

__init__(self, *a, **k)

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

_find_device_bank_key(self, device)
add_device_bank_listener(self, slot, identify_sender=False, *a, **k)
clear_device_bank_listeners(self)
compact_registry(self)
device_bank_has_listener(self, slot)
device_bank_listener_count(self)
disconnect(self)
get_device_bank(self, device)
notify_device_bank(self, *a, **k)
remove_device_bank_listener(self, slot)
set_device_bank(self, device, bank)

class DeviceComponent(ControlSurfaceComponent, Subject)

class DisplayDataSource

Properties

  • separator

Methods

__init__(self, display_string='', separator=None, adjust_string_fn=<function adjust_string at 0x162fc3510>, *a, **k)

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

_adjust_string_fn(original, length)

partial(func, args, *keywords) - new function with partial application of the given arguments and keywords.

_get_separator(self)
_set_separator(self, separator)
adjust_string(self, width)
clear(self)
display_string(self)
set_display_string(self, new_string)
set_update_callback(self, update_callback)
update(self)

Attributes

  • _separator = '' - str(object='') -> str

class Subject(Disconnectable)

Methods

__init__(self, /, *args, **kwargs)

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

disconnect(self)