Message

AbletonEvent

Bases: AttrEnum

CUE_VOL = 'CUE_VOL'

Cue level control

CROSSFADER = 'CROSSFADER'

Crossfader control

DEVICE_BANK = 'DEVICE_BANK'

Select device encoder bank by index

DEVICE_BANK_NEXT = 'DEVICE_BANK_NEXT'

Select next device encoder bank

DEVICE_BANK_PREV = 'DEVICE_BANK_PREV'

Select previous device encoder bank

DEVICE_LOCK = 'DEVICE_LOCK'

Device lock (lock "blue hand")

DEVICE_TOGGLE = 'DEVICE_TOGGLE'

Toggle selected device on/off

ENCODER = 'ENCODER'

Parameters control

FORWARD = 'FORWARD'

Fast forward

LOOP = 'LOOP'

Loop on/off

MASTER_SEL = 'MASTER_SEL'

Master track select

MASTER_VOL = 'MASTER_VOL'

Master track volume

METRONOME = 'METRONOME'

Metronome on/off

NUDGE_UP = 'NUDGE_UP'

Tempo Nudge Up

NUDGE_DOWN = 'NUDGE_DOWN'

Tempo Nudge Down

OVERDUB = 'OVERDUB'

Overdub on/off

PLAY = 'PLAY'

Global play

PUNCH_IN = 'PUNCH_IN'

Punch in

PUNCH_OUT = 'PUNCH_OUT'

Punch out

REC = 'REC'

Global record

REWIND = 'REWIND'

Rewind

SESSION_REC = 'SESSION_REC'

Session record

STOP = 'STOP'

Global stop

TAP_TEMPO = 'TAP_TEMPO'

Tap tempo

TEMPO_CONTROL = 'TEMPO_CONTROL'

Tempo control CC assignment

TRACK_ARM = 'TRACK_ARM'

Track record arm by index

TRACK_LEFT = 'TRACK_LEFT'

Track left

TRACK_RIGHT = 'TRACK_RIGHT'

Track right

TRACK_MUTE = 'TRACK_MUTE'

Track On/Off by index

TRACK_NEXT_8 = 'TRACK_NEXT_8'

Select next 8 tracks to control with track controls

TRACK_PREV_8 = 'TRACK_PREV_8'

Select previous 8 tracks to control with track controls

TRACK_SELECT = 'TRACK_SELECT'

Track select by index

TRACK_SEND_A = 'TRACK_SEND_A'

Track Send A

TRACK_SEND_B = 'TRACK_SEND_B'

Track Send B

TRACK_SOLO = 'TRACK_SOLO'

Track solo by index

TRACK_STOP = 'TRACK_STOP'

Track clip stop by track index

TRACK_VOL = 'TRACK_VOL'

Track Volume

UNSUPPORTED = 'UNSUPPORTED'

Unknown message

AbletonMsg

AbletonMsg(
    type: AbletonEvent,
    index: int | tuple[int, int],
    value: int | bool,
    *,
    source: None | AbletonIn = None
)

AbletonMsg(
    type: AbletonEvent,
    value: int | bool = True,
    *,
    source: None | AbletonIn = None
)

AbletonMsg(
    type: AbletonEvent,
    index_or_value: int | bool = True,
    value: int | bool = None,
    *,
    source: None | AbletonIn = None
)

Bases: Msg

Ableton Live remote script event message

Overloads:

AbletonMsg(
    type: AbletonEvent,
    index: int | tuple[int, int],
    value: int | bool,
    *,
    source: 'None | AbletonIn' = None
)

AbletonMsg(
    type: AbletonEvent,
    value: int | bool, *,
    source: 'None | AbletonIn' = None
)

Parameters:

• type (AbletonEvent) –

  Ableton Live remote script event

• index (int) –

  Track/clip/send index

• value (int | bool, default: None ) –

  Control event value (0-127 or True / False)

• source (None | AbletonIn, default: None ) –

  The AbletonIn instance that generated the message

ctime

ctime: float

Message creation time in "Unix time" format

type

type: AbletonEvent

Ableton Live remote script event

index

index: None | int | tuple[int, int] = None

Track/clip/send index

value

value: int | bool

Control event value

source

source: None | AbletonIn

Input port instance that generated the message

matches

matches(
    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,
) -> bool

Checks if message's attributes match all provided attribute conditions:

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.

Use Not(condition) to invert condition matching.

Returns:

• bool –

  True if all attributes match, False if any does not match