Skip to content

Ports

AbletonIn 

AbletonIn(proxy_midi_port_name: str, *, virtual: bool = False)

Bases: MidiIn

Receives MIDI messages from Ableton Live remote script and produces AbletonMsg objects.

Parameters:

  • proxy_midi_port_name (str) –

    The name of proxy MIDI input port enabled in Ableton Live

  • virtual (bool, default: False ) –

    Create virtual port (Linux and macOS only)

is_enabled 

is_enabled: bool

True if port is listening messages / ready to send messages

calls 

calls: list[None | tuple[tuple, dict], list[SubscribedCall]]

Message match arguments and callables that will be called with matching incoming messages. None conditions matches any message.

name 

name: str

MIDI port name

attached_passthrough_outs 

attached_passthrough_outs: list[MidiOut] = []

MidiOut ports attached as pass-through ports which will send all incoming messages as soon as they arrive before sending them to calls

passthrough_out 

passthrough_out(midi_output: MidiOut) -> None

Attach MidiOut as a pass-through port to send all incoming messages as soon as they arrive, before sending them to calls. This can greatly reduce latency.

Parameters:

subscribe 

subscribe(
    type: None | Container[AbletonEvent] | AbletonEvent = None,
    index: (
        None | Container[int, tuple[int, int]] | int | tuple[int, int]
    ) = None,
    value: None | Container[int] | int | bool = None,
) -> Callable

Decorator to subscribe a callable to the input's messages.

Decorator without arguments subscribes a callable to all the input's messages.

Decorator with arguments subscribes a callable to the input's messages that match conditions set by arguments. It works the same way as message's matches method:

  1. If condition is None or omitted it matches anything.

  2. If condition equals attribute it matches the attribute.

  3. If condition is a container and contains the attribute it matches the attribute.

Examples
  1. Calls function for all MIDI port's messages: 
    @midi_input_instance.subscribe
def function(msg: MidiMsg) -> None:
    pass
  2. Calls function for OSC messages from specific address: 
    @osc_input_instance.subscribe(address='/live/song/get/track_data')
def function(msg: OscMsg) -> None:
    pass
  3. Call object instance method for MIDI port's "note on" and "note off" messages: 
    midi_input_instance.subscribe((MidiType.NOTE_ON, MidiType.NOTE_OFF))(object.method)

Returns:

  • Callable –

    Subscribed callable.

AbletonOut 

AbletonOut(proxy_midi_port_name: str, *, virtual: bool = False)

Bases: MidiOut

Sends AbletonMsg objects as MIDI message to Ableton Live remote script.

Parameters:

  • proxy_midi_port_name (str) –

    The name of proxy MIDI output port enabled in Ableton Live

  • virtual (bool, default: False ) –

    Create virtual port (Linux and macOS only)

is_enabled 

is_enabled: bool

True if port is listening messages / ready to send messages

name 

name: str

MIDI port name

send 

send(msg: AbletonMsg) -> None

Send message to Ableton remote script.

Parameters: