Skip to content

Latest commit

 

History

History
301 lines (215 loc) · 25.5 KB

api-reference.md

File metadata and controls

301 lines (215 loc) · 25.5 KB

MPC 3.10.1.8 script API reference

Every table, function and property a controller script can see on MPC 3.10.1.8 (build 38fdde70994), Live III, with what we know about each. Generated by tools/api_reference.py from the table dump in mpc-launchpad-pro-mk3/docs/LUA-API-DUMP.md by @fuzboxz (captured 2026-11-17 from inside a running script, depth 4). Notes come from FINDINGS and COMMUNITY.

Present is not the same as working. A name here only means the table has it. Several functions error or do nothing when called (see the notes); anything without a note is untested. Property values are what the dump saw on an empty project; read and write them through .value, and most can be listened to with prop:listen(fn, deviceName).

[i] = an indexed table (all entries share the shape shown). dev = your device table.

Device table (dev)

dev

The device table, named after the script file. MPC calls the Handle* and On* functions; you define them.

  • Functions: HandleMIDICC, HandleMIDINoteOff, HandleMIDINoteOn, HandleMIDISysex, HandleTimer, OnLoad, OnUnload, ResetControls
  • Sub-tables: clipMatrixAperture, mappings, midiOut, timer

dev.midiOut

outputIndex = order of the output= lines in the .ini. Sysex payload without F0/F7. Script-sent MIDI doesn't loop back through mappings (COMMUNITY C4).

  • Functions: SendMIDICC, SendMIDINoteOff, SendMIDINoteOn, SendMIDISysex

dev.clipMatrixAperture

The script's own window on the clip matrix (verified FINDINGS 18, 30). Show()/SetLabel() draw it on the MPC screen.

  • Functions: BankDown, BankLeft, BankRight, BankUp, GetActiveMatrix, GetCanMoveDown, GetCanMoveLeft, GetCanMoveRight, GetCanMoveUp, GetColumns, GetFollowOffsetX, GetFollowOffsetY, GetGlobalColumns, GetGlobalRows, GetOriginX, GetOriginY, GetRows, Hide, IsVisible, IsVisibleColumn, IsVisibleRow, MoveDown, MoveLeft, MoveRight, MoveTo, MoveToColumn, MoveToRow, MoveUp, SelectClip, SelectTrack, SetActiveMatrix, SetColumns, SetFollowOffsetX, SetFollowOffsetY, SetFollowsTUI, SetFollowsTUIActiveMatrix, SetGlobalColumns, SetGlobalRows, SetLabel, SetMinX, SetMinY, SetRows, Show, StopClipsOnTrack, ToGlobalColumn, ToGlobalRow, ToLocalColumn, ToLocalRow, TriggerClip, TriggerRow
  • Properties: ActiveMatrix (Normal), CanMoveDown (true), CanMoveLeft (false), CanMoveRight (true), CanMoveUp (false), OriginX (0), OriginY (0)
  • Sub-tables: clipProperties, sceneProperties, trackProperties

dev.clipMatrixAperture.trackProperties

  • Indexed: 0..15

dev.clipMatrixAperture.trackProperties[i]

  • Functions: GetColour, GetName, GetSelected, GetState, GetType
  • Properties: Colour (0), Name, Selected (false), State (0), Type (1:1:0)

dev.clipMatrixAperture.sceneProperties

  • Indexed: 0..15

dev.clipMatrixAperture.sceneProperties[i]

One per scene row; State covers the whole row, including columns outside the window (COMMUNITY C2).

  • Functions: GetColour, GetIsArrangement, GetName, GetSelected, GetState
  • Properties: Colour (65476), IsArrangement (false), Name (1), Selected (false), State (1)

dev.clipMatrixAperture.clipProperties

  • Indexed: 0..15

dev.clipMatrixAperture.clipProperties[c][r]

Per-slot properties, listenable. State enum: 0 NoSlot, 1 Empty, 2 Ready, 3 WillPlay, 4 Playing, 5 WillStopPlaying, 6 WillRecord, 7 Recording, 8 WillStopRecording, 9 WillOverdub, 10 Overdubbing, 11 WillStopOverdubbing (COMMUNITY C2). The dump stops at depth 4, so the slot members aren't listed; Colour, State, Selected are verified.

  • Indexed: 0..15

dev.timer

Start(ms) sets the HandleTimer interval; Now() returns milliseconds (COMMUNITY C8).

  • Functions: Now, Start, Stop

dev.mappings

  • Sub-tables: controlSurface, pads, script, tracks

dev.mappings.script

Only notes/CCs registered here reach HandleMIDI*. Verified on MIDI channels other than the first (COMMUNITY, LCXL3).

  • Functions: AddCCToScript, AddNoteToScript, IsCCMappedToScript, IsNoteMappedToScript, RemoveCCToScript, RemoveNoteToScript, SetHandleSysex

dev.mappings.pads

  • Functions: AddNoteToForcePad, AddNoteToMpcPad, AddNoteToMpcPadQuadrant, AddNoteToVirtualPad, IsForcePadMapped, IsMpcPadMapped, IsMpcPadQuadrantMapped, IsVirtualPadMapped, RemoveNoteToForcePad, RemoveNoteToMpcPad, RemoveNoteToMpcPadQuadrant, RemoveNoteToVirtualPad

dev.mappings.controlSurface

AddCCToControl(ch, cc, "Tap Tempo") takes a control's display name (COMMUNITY C8).

  • Functions: AddCCToControl, AddNoteToControl, IsControlMapped, RemoveCCToControl, RemoveNoteToControl
  • Sub-tables: qlinks

dev.mappings.controlSurface.qlinks

Hand a CC to an MPC Q-link natively. AddInfiniteCCToQLink verified (LCXL3, 16/16 mapped); check with IsQLinkMappedInfinite.

  • Functions: AddAbsoluteCCToQLink, AddInfiniteCCToQLink, IsQLinkMappedAbsolute, IsQLinkMappedInfinite, RemoveAbsoluteCCToQLink, RemoveInfiniteCCToQLink, SetInfiniteCCMagnitude, SetQLinkFineAdjust

dev.mappings.tracks

  • Sub-tables: mutes

dev.mappings.tracks.mutes

  • Functions: AddNoteToTrackMute, IsTrackMuteMappedFromNote, RemoveNoteToTrackMute

Tracks

mpc.tracks

The Get*/Set* functions that take a track index error in every call form tried (FINDINGS 30, 33). Use normalTracks[i] instead. Known to work: GetCount, SizeNormalTracks, SetCurrentTrack (global index, COMMUNITY C7).

  • Functions: CreateTrack, GetAutomationFilterType, GetCount, GetCurrentTrackName, GetGlobalInsertEnabled, GetHasAutomation, GetInsertEnabled, GetMute, GetSendLevel, GetSolo, GetSoloMute, GetTrackCVPort, GetTrackColour, GetTrackGatePort, GetTrackIndependentLength, GetTrackInputChannel, GetTrackInputPort, GetTrackLengthType, GetTrackMidiBankEnable, GetTrackMidiBankLsb, GetTrackMidiBankMsb, GetTrackMidiProgramNumber, GetTrackMidiProgramNumberEnable, GetTrackMonitorState, GetTrackMuteGroupIndex, GetTrackOutputChannel, GetTrackOutputPort, GetTrackPadsFollowTrackColour, GetTrackPan, GetTrackRecordArmed, GetTrackSkipFromRowLaunch, GetTrackTransposition, GetTrackVelocityScale, GetTrackVolume, IsTrackAudio, IsTrackInstrument, IsTrackMaster, IsTrackMidiTriggered, IsTrackMixable, IsTrackPadBased, Remove, RemoveAll, ResetTrackChannelStrip, SetAutomationFilterType, SetCurrentTrack, SetGlobalInsertEnabled, SetInsertEnabled, SetMute, SetSendLevel, SetSolo, SetTrackCVPort, SetTrackColour, SetTrackGatePort, SetTrackIndependentLength, SetTrackInputChannel, SetTrackInputPort, SetTrackMidiBankEnable, SetTrackMidiBankLsb, SetTrackMidiBankMsb, SetTrackMidiProgramNumber, SetTrackMidiProgramNumberEnable, SetTrackMonitorState, SetTrackMuteGroupIndex, SetTrackOutputChannel, SetTrackOutputPort, SetTrackPadsFollowTrackColour, SetTrackPan, SetTrackRecordArmed, SetTrackSkipFromRowLaunch, SetTrackTransposition, SetTrackVelocityScale, SetTrackVolume, Size, SizeMasterTracks, SizeMidiTracks, SizeNonMidiTracks, SizeNormalTracks, TrackAllNotesOff, TrackSupportsLayers, TrackSupportsSampleEditProgram, TrackSupportsSixteenLevels
  • Properties: Count (0)
  • Sub-tables: currentTrack, masterTracks, normalTracks

mpc.tracks.normalTracks

  • Indexed: 0..127
  • Functions: GetCount
  • Properties: Count (0)

mpc.tracks.normalTracks[i]

128 slots whatever the project holds; count with SizeNormalTracks(). Index = global clip-matrix column, but not the MPC UI's track number when non-mixable tracks exist (COMMUNITY C7).

  • Functions: GetColour, GetMute, GetName, GetPan, GetRecArm, GetSend1, GetSend2, GetSend3, GetSend4, GetSolo, GetType, GetVolume, GetVolumeDB, SetColour, SetMute, SetName, SetPan, SetRecArm, SetSend1, SetSend2, SetSend3, SetSend4, SetSolo, SetVolume
  • Properties: Colour (0), Mute (false), Name, Pan (0.5), RecArm (false), Send1 (0.0), Send2 (0.0), Send3 (0.0), Send4 (0.0), Solo (false), Type (Drum), Volume (0.0), VolumeDB (0.0)

mpc.tracks.masterTracks

  • Indexed: 0..127
  • Functions: GetCount
  • Properties: Count (0)

mpc.tracks.masterTracks[i]

Same shape as normalTracks[i]. Presence only.

  • Functions: GetColour, GetMute, GetName, GetPan, GetRecArm, GetSend1, GetSend2, GetSend3, GetSend4, GetSolo, GetType, GetVolume, GetVolumeDB, SetColour, SetMute, SetName, SetPan, SetRecArm, SetSend1, SetSend2, SetSend3, SetSend4, SetSolo, SetVolume
  • Properties: Colour (0), Mute (false), Name, Pan (0.5), RecArm (false), Send1 (0.0), Send2 (0.0), Send3 (0.0), Send4 (0.0), Solo (false), Type (Drum), Volume (0.0), VolumeDB (0.0)

mpc.tracks.currentTrack

Index is global (normal tracks, then master). Plugin-preset calls present; confirm on hardware.

  • Functions: GetColour, GetIndex, GetName, GetPluginPresetIndex, GetPluginPresetName, GetPluginPresetNamePreview, GetType, GetVolume, GetVolumeDB, Next, NextPluginPreset, PrevPluginPreset, Previous, SetName, SetPluginPresetIndex, SetVolume
  • Properties: Colour (0), Index (0), Name, PluginPresetIndex (0), PluginPresetName, Type (Drum), Volume (0.0), VolumeDB (-100.0)
  • Sub-tables: currentInstrument

mpc.tracks.currentTrack.currentInstrument

  • Functions: GetIndex, GetPan, GetVolume, GetVolumeDB, SetPan, SetVolume
  • Properties: Index (0), Pan (0.0), Volume (0.0), VolumeDB (0.0)

Clip matrix

mpc.clipMatrix

  • Functions: AllClipsStopped, ClearRow, ClipIsPlaying, ClipIsRecording, ClipIsStopped, CopyClip, CopyRow, CopyTrack, CreateAudioTrack, CreateCVTrack, CreateClip, CreateDrumTrack, CreateKeygroupTrack, CreateMidiTrack, CreatePluginTrack, DeleteClip, DeleteRow, DeleteTrack, EditClip, EditTrack, FlattenClip, FlattenClipElastique, GetClipColour, GetClipName, GetColumns, GetRows, GetSelectedClipColumn, GetSelectedClipRow, GetTrackColour, GetTrackName, HasClip, InsertRowAndCapture, InsertRows, SelectClip, SelectRow, SelectTrack, SetClipEnd, SetClipLoopEnd, SetClipLoopStart, SetClipName, SetClipStart, SetRowColour, SetRowTempoTrigger, SetTrackName, StopAllClips, StopTrackClips, TrackIsPlaying, TrackIsRecording, TrackIsStopped, TriggerArrangeTrack, TriggerClip, TriggerRow
  • Sub-tables: selectedClip

mpc.clipMatrix.selectedClip

  • Sub-tables: events

mpc.clipMatrix.selectedClip.events

Create/edit/delete only; no way to read or iterate events (FINDINGS 18, 25, 33).

  • Functions: CreateAudioEvent, CreateInstrumentAutomationEvent, CreateNoteEvent, CreateProgramAutomationEvent, CreateSequenceTempoChangeEvent, CreateTrackAutomationEvent, DeleteEvent, GetAudioEventAtTime, GetSize, MoveEvent, SetAudioCoarseTune, SetAudioFadeIn, SetAudioFadeOut, SetAudioFineTune, SetAudioMute, SetAudioReverse, SetAudioVolume, SetAudioWarpEnabled, SetAutomationValue, SetEventEnd, SetEventStart, SetEventTempo, SetNote, SetNoteOnModifier, SetNoteRatchet, SetNoteVelocity, SplitEvents

Master clip matrix

mpc.masterClipMatrix

  • Functions: AllClipsStopped, ClearRow, ClipIsPlaying, ClipIsRecording, ClipIsStopped, CopyClip, CopyRow, CopyTrack, CreateAudioTrack, CreateCVTrack, CreateClip, CreateDrumTrack, CreateKeygroupTrack, CreateMidiTrack, CreatePluginTrack, DeleteClip, DeleteRow, DeleteTrack, EditClip, EditTrack, FlattenClip, FlattenClipElastique, GetClipColour, GetClipName, GetColumns, GetRows, GetSelectedClipColumn, GetSelectedClipRow, GetTrackColour, GetTrackName, HasClip, InsertRowAndCapture, InsertRows, SelectClip, SelectRow, SelectTrack, SetClipEnd, SetClipLoopEnd, SetClipLoopStart, SetClipName, SetClipStart, SetRowColour, SetRowTempoTrigger, SetTrackName, StopAllClips, StopTrackClips, TrackIsPlaying, TrackIsRecording, TrackIsStopped, TriggerArrangeTrack, TriggerClip, TriggerRow
  • Sub-tables: selectedClip

mpc.masterClipMatrix.selectedClip

  • Sub-tables: events

mpc.masterClipMatrix.selectedClip.events

  • Functions: CreateAudioEvent, CreateInstrumentAutomationEvent, CreateNoteEvent, CreateProgramAutomationEvent, CreateSequenceTempoChangeEvent, CreateTrackAutomationEvent, DeleteEvent, GetAudioEventAtTime, GetSize, MoveEvent, SetAudioCoarseTune, SetAudioFadeIn, SetAudioFadeOut, SetAudioFineTune, SetAudioMute, SetAudioReverse, SetAudioVolume, SetAudioWarpEnabled, SetAutomationValue, SetEventEnd, SetEventStart, SetEventTempo, SetNote, SetNoteOnModifier, SetNoteRatchet, SetNoteVelocity, SplitEvents

Aperture (global)

mpc.clipMatrixAperture

  • Functions: BankDown, BankLeft, BankRight, BankUp, GetCanMoveDown, GetCanMoveLeft, GetCanMoveRight, GetCanMoveUp, GetColumns, GetFollowOffsetX, GetFollowOffsetY, GetGlobalColumns, GetGlobalRows, GetOriginX, GetOriginY, GetRows, IsVisible, IsVisibleColumn, IsVisibleRow, MoveDown, MoveLeft, MoveRight, MoveTo, MoveToColumn, MoveToRow, MoveUp, SetFollowOffsetX, SetFollowOffsetY, SetGlobalColumns, SetGlobalRows, SetMinX, SetMinY, ToGlobalColumn, ToGlobalRow, ToLocalColumn, ToLocalRow
  • Properties: CanMoveDown (true), CanMoveLeft (false), CanMoveRight (false), CanMoveUp (false), OriginX (0), OriginY (0)

Sequencer and transport

mpc.sequencer

  • Functions: BarBack, BarForward, EventBack, EventForward, GetBPM, GetCountInEnable, GetEndOrLoop, GetLoop, GetLoopStart, GetMetronomeEnabled, GetOverdubState, GetPlaying, GetRecordState, GetTCPeriod, IsPlaying, IsRecording, JumpByBar, JumpByBeat, JumpByEvent, JumpByPulse, JumpToBeginning, JumpToEnd, JumpToPulse, JumpToSample, Locate, Overdub, Play, PlayStart, PlayheadPosition, Record, RecordOff, SequenceEnd, SequenceStart, SetBPM, SetCountInEnable, SetLoop, SetMetronomeEnabled, StepBack, StepForward, Stop, TogglePlay, TogglePlayStart
  • Properties: Loop (true), MetronomeEnabled (false), OverdubState (0), Playing (false), RecordState (0)
  • Sub-tables: arpeggiator, quantiser, recorderProperties

mpc.sequencer.recorderProperties

  • Functions: EnablePunchIn, SetPunchInEndBBP, SetPunchInStartBBP

mpc.sequencer.arpeggiator

  • Functions: GetAccentProbability, GetAccentVelocity, GetAction, GetAftertouchAction, GetArpIndex, GetEnabled, GetLatch, GetLatchMode, GetNonAccentProbability, GetNonAccentVelocity, GetNoteLength, GetOctaves, GetPatternIndex, GetRhythmIndex, GetSustainPedalLatches, GetSwing, GetVariation, GetVelocity, SetAccentProbability, SetAccentVelocity, SetAction, SetAftertouchAction, SetArpIndex, SetEnabled, SetLatch, SetLatchMode, SetNonAccentProbability, SetNonAccentVelocity, SetNoteLength, SetOctaves, SetPatternIndex, SetRhythmIndex, SetSustainPedalLatches, SetSwing, SetVariation, SetVelocity

mpc.sequencer.quantiser

Verified in LPP3/LCXL3.

  • Functions: GetEnabled, GetShift, GetStrength, GetSwing, GetTimeDivision, GetWindow, SetEnabled, SetShift, SetStrength, SetSwing, SetTimeDivision, SetWindow
  • Properties: Enabled (true)

Sequence and song

mpc.currentSequence

  • Functions: GetBPM, SetBPM, SetCurrentSequence
  • Sub-tables: events

mpc.currentSequence.events

  • Functions: CreateAudioEvent, CreateInstrumentAutomationEvent, CreateNoteEvent, CreateProgramAutomationEvent, CreateSequenceTempoChangeEvent, CreateTrackAutomationEvent, DeleteEvent, GetAudioEventAtTime, GetSize, MoveEvent, SetAudioCoarseTune, SetAudioFadeIn, SetAudioFadeOut, SetAudioFineTune, SetAudioMute, SetAudioReverse, SetAudioVolume, SetAudioWarpEnabled, SetAutomationValue, SetEventEnd, SetEventStart, SetEventTempo, SetNote, SetNoteOnModifier, SetNoteRatchet, SetNoteVelocity, SplitEvents

mpc.song

  • Functions: Clear, DeleteStep, InsertStep, ModifyRepeats, ModifySequence, PushStep, SetCurrentSong, SetName

Control surface

mpc.controlSurface

  • Functions: GetAttachedDevice
  • Sub-tables: acvfStrip, acvmMix, acvmMute, arp, arpLatch, arrange, bank1, bank2, bank3, bank4, barBack, barForward, browser, chop, chord, copy, cursorCentre, cursorDown, cursorLeft, cursorRight, cursorUp, dataDial, dec, emulation, enter, erase, fKey1, fKey2, fKey3, fKey4, fKey5, fKey6, favourites, fullLevel, grid, inc, keyboardControl, keypad10, keypad1, keypad2, keypad3, keypad4, keypad5, keypad6, keypad7, keypad8, keypad9, locate, loopOn, main, matrix, menu, metronome, micSpeaker, mix, mode, mute, nextSeq, noFilter, noteRepeat, octDown, octUp, outputs, overdub, padAssign, padMixer, padMute, padPerform, pads, play, playStart, plusMinus, prePost, program, programEdit, programMixer, programSelect, project, qlink, qlinks, quantizeApply, record, recordToArrange, returns, sample, sampleEdit, sampleEnd, sampleSelect, sampleStart, sampler, save, seqEdit, sequence, shift, sixteenLevel, song, sounds, stem, stepBack, stepForward, stepSeq, stepSeqAudition, stepSeqNext, stepSeqPrev, stepSeqSet, stepSequencer, stop, strip, submixes, tapTempo, tc, tcOnOff, touchFX, touchStrip, trackDec, trackFx, trackInc, trackMixer, trackMute, trackSelect, tracks, tune, undo, usbSelect, window, xyfx, zoom

mpc.controlSurface.qlinks

  • Indexed: 0..15
  • Functions: GetNumQLinks

mpc.controlSurface.qlinks[i]

16, 0-based, column-major on the Live III (FINDINGS 26). GetPosition lags one change. SetPosition only changes the displayed value (COMMUNITY C3); use Touch() + Twist(delta). SetValue is untested.

  • Functions: GetPosition, GetTargetName, GetValue, GetValueString, SetPosition, SetValue, Touch, Twist
  • Properties: TargetName, ValueString

mpc.controlSurface.dataDial

  • Functions: DoublePress, Hold, Press, Release, Twist

mpc.controlSurface.pads

Virtual pad indices are 1-64. Tap may ignore velocity; use Press + Release. No colour listener: poll pads[i].GetColour() (COMMUNITY C8).

  • Indexed: 0..15
  • Functions: EnsurePadVisible, GetCurrentBank, IsPadVisible, IsPressed, IsPressedVirtual, LastHitPad, LightBrightness, LightRGBColor, Press, PressVirtual, Release, ReleaseAll, ReleaseVirtual, SetCurrentBank, Tap, TapVirtual, Velocity, VelocityVirtual
  • Properties: CurrentBank (0)
  • Sub-tables: virtual

mpc.controlSurface.pads[i]

  • Functions: GetColour
  • Properties: Colour (0)

mpc.controlSurface.pads.virtual

  • Indexed: 0..127

mpc.controlSurface.touchStrip

  • Functions: Hold, Move, Release

mpc.controlSurface.stepSequencer

  • Functions: GetCurrentMode, IsPressed, LightBrightness, LightRGBColour, Press, Release, Tap

Buttons (each has Press, Release, Hold, DoublePress): acvfStrip, acvmMix, acvmMute, arp, arpLatch, arrange, bank1, bank2, bank3, bank4, barBack, barForward, browser, chop, chord, copy, cursorCentre, cursorDown, cursorLeft, cursorRight, cursorUp, dec, emulation, enter, erase, favourites, fKey1, fKey2, fKey3, fKey4, fKey5, fKey6, fullLevel, grid, inc, keyboardControl, keypad1, keypad10, keypad2, keypad3, keypad4, keypad5, keypad6, keypad7, keypad8, keypad9, locate, loopOn, main, matrix, menu, metronome, micSpeaker, mix, mode, mute, nextSeq, noFilter, noteRepeat, octDown, octUp, outputs, overdub, padAssign, padMixer, padMute, padPerform, play, playStart, plusMinus, prePost, program, programEdit, programMixer, programSelect, project, qlink, quantizeApply, record, recordToArrange, returns, sample, sampleEdit, sampleEnd, sampler, sampleSelect, sampleStart, save, seqEdit, sequence, shift, sixteenLevel, song, sounds, stem, stepBack, stepForward, stepSeq, stepSeqAudition, stepSeqNext, stepSeqPrev, stepSeqSet, stop, strip, submixes, tapTempo, tc, tcOnOff, touchFX, trackDec, trackFx, trackInc, trackMixer, trackMute, tracks, trackSelect, tune, undo, usbSelect, window, xyfx, zoom

Force buttons

mpc.force

Every Force button, pressable from any device. No LED/state readback (FINDINGS 30).

  • Sub-tables: arp, assignA, assignB, clip, clipStop, copy, crossfader, cursorDown, cursorLeft, cursorRight, cursorUp, dataDial, dec, delete, edit, inc, launch, load, master, matrix, menu, mixer, mute, navigate, note, pads, play, qlink, qlinks, recArm, record, rowLaunch1, rowLaunch2, rowLaunch3, rowLaunch4, rowLaunch5, rowLaunch6, rowLaunch7, rowLaunch8, save, select, shift, solo, stepSeq, stop, stopAll, tap, trackAssign1, trackAssign2, trackAssign3, trackAssign4, trackAssign5, trackAssign6, trackAssign7, trackAssign8, trackSelect1, trackSelect2, trackSelect3, trackSelect4, trackSelect5, trackSelect6, trackSelect7, trackSelect8, undo

mpc.force.pads

  • Functions: IsPressed, LastHitPad, Press, Release, ReleaseAll, Tap, Velocity

mpc.force.qlinks

  • Indexed: 0..15
  • Functions: GetNumQLinks

mpc.force.qlinks[i]

  • Functions: GetPosition, GetTargetName, GetValue, GetValueString, SetPosition, SetValue, Touch, Twist
  • Properties: TargetName, ValueString

mpc.force.crossfader

  • Functions: Move

mpc.force.dataDial

  • Functions: DoublePress, Hold, Press, Release, Twist

Buttons (each has Press, Release, Hold, DoublePress): arp, assignA, assignB, clip, clipStop, copy, cursorDown, cursorLeft, cursorRight, cursorUp, dec, delete, edit, inc, launch, load, master, matrix, menu, mixer, mute, navigate, note, play, qlink, recArm, record, rowLaunch1, rowLaunch2, rowLaunch3, rowLaunch4, rowLaunch5, rowLaunch6, rowLaunch7, rowLaunch8, save, select, shift, solo, stepSeq, stop, stopAll, tap, trackAssign1, trackAssign2, trackAssign3, trackAssign4, trackAssign5, trackAssign6, trackAssign7, trackAssign8, trackSelect1, trackSelect2, trackSelect3, trackSelect4, trackSelect5, trackSelect6, trackSelect7, trackSelect8, undo

Project

mpc.project

  • Functions: AdvanceGlobalAutomationFilterType, GetBPM, GetGlobalAutomationFilterType, ImportMpc2ProjectToClips, ImportMpc2ProjectToSequences, Load, LoadSequence, LoadTrack, New, Save, SaveTrack, SaveTrackFXRack, SetBPM, SetGlobalAutomationFilterType
  • Properties: BPM (128.0), GlobalAutomationFilterType (Read)

Engine and modes

mpc.engine

  • Functions: GetHardwareProduct, GetProduct, Quit, SetUserSetting, SyncThreads, Version

mpc.modeMenu

mpc.engineMode

RequestModeChange(name) takes menu-label names (COMMUNITY C11). Check CurrentPopup before project-scoped calls (COMMUNITY C6).

  • Functions: GetCurrentMode, GetCurrentPopup, RequestModeChange
  • Properties: CurrentMode (Main Mode), CurrentPopup (New Project)

UI

mpc.ui

  • Functions: ShowTUIFeedback
  • Sub-tables: popups

mpc.ui.popups

  • Functions: CloseCurrentPopup, GetButtons, PushButton, ShowInfoPopup

Everything else

mpc

  • Functions: IsDesktop, IsStandalone
  • Sub-tables: clipMatrix, clipMatrixAperture, commandManager, controlSurface, currentSequence, engine, engineMode, exporter, features, filesystem, force, masterClipMatrix, modeMenu, project, samples, sequencer, song, stepSequencerControl, tracks, tui, ui

mpc.tui

  • Functions: MouseDown, MouseDrag, MouseUp

mpc.commandManager

  • Functions: CanRedo, CanUndo, NumCommands, Redo, Reset, Undo, UndoToIndex

mpc.features

UseClipWorkflow tells you whether the clip matrix is in use (COMMUNITY C8).

  • Functions: GetCVModulationFeatureEnabled, GetEnhancedKeygroupsFeatureEnabled, GetEnvelopeFollowersFeatureEnabled, GetSuperWarpFeatureEnabled, GetUseClipWorkflow
  • Properties: CVModulationFeatureEnabled (true), EnhancedKeygroupsFeatureEnabled (true), EnvelopeFollowersFeatureEnabled (true), SuperWarpFeatureEnabled (true), UseClipWorkflow (true)

mpc.exporter

  • Functions: ExportClip, ExportSequence, ExportSong

mpc.samples

  • Functions: AddSample, GetSampleMetadata, GetSampleNames, RemoveAll, RemoveSample

mpc.filesystem

mpc.stepSequencerControl