Macros

Macro Format

This is the format specification for Mixxx Macros, a feature that allows the recording and reproduction of jumps and particular control changes.

See Mixxx Macros and Mixxx Macros Requirements for background on the project.

Controls

[MacroRecording]

Key/Control	Range	What it does	On-screen feedback
record	binary	Arms Macro recording & stops it	Recording icon
status	0-2, read-only	Indicates whether a Macros is being recorded: 0 = no recording, 1 = recording armed, 2 = recording active	Recording icon
deck?	integer	The deck the Macro is being recorded to (0 if the recording_status != 2)	Toggle Button

[ChannelN]

Key/Control	Range	What it does
macros_show	binary	Whether to show the Macro Rack for this channel
macro_X_activate	binary	If Macro X exists, seek to the first action and start it. If Macro X is unset, start recording for it.
macro_X_status	0-2, read-only	Whether this Macro is currently running
macro_X_enabled	binary	Whether this Macro will automatically be started when the track is loaded
macro_X_loop	binary	Whether this Macro should loop infinitely
macro_X_set	binary	Record a Macro to slot X
macro_X_clear	binary	If Macro X is set, delete it and remove it from the Rack

Storage

A Macro with its Actions is stored in the protobuf format.

A table in the mixxxdb will store the binary blob of the Macro along with its name, the corresponding track and its state (enabled/looped).