A newer version of Max is available. Click here to access the latest version of the documentation

mpeformat Reference

Prepare data in the form of a Multidimensional Polyphonic Expression (MPE) MIDI message



Numbers received in the inlets from midiformat objects are routed as MPE-compatible MIDI messages. In addition, the object outputs mpeevent messages for use with instruments hosted by the vst~ object.



channels [int]

An argument can be used to set the number of MIDI input channels. The number of inlets will be one more than the argument value, since the leftmost inlet is a global MIDI input. If no argument is specified, one Zone Master Channel input and 15 channel inputs will be created.


chanrange [int] (default: 1)

The channel range specifies the number of channels following the Zone Master Channel (15 by default. masterchannel 1, chanrage 15 will be all 16 channels, and masterchannel 1, chanrange 5 will be master channel 1 and the zone will run until the end of channel 6). The default value of the attribute is the same value as the first argument to the mpeformat object (i.e. the number of input channels). If you set the attribute's value as an argument (e.g. @chanrange 4, you will set the number of inlets the object has, as well.

Note: You can set this attribute to a value between 1 and the Channel range if this change only effects the config MIDI message received from a mpeconfig object.

masterchan [int] (default: 1)

Sets the first MIDI channel to be addressed. All other channels number from there.

zone [int] (default: 1)

Sets the MPE MIDI Zone ID.

Common Box Attributes



bang message to the leftmost inlet will send out the MPE configuration message for the current state of this object out the mpeformat object's left outlet.



byte [int]
Numbers received in the other inlets are used as data for MIDI messages and routed to the input channel corresponding to the inlet.



byte [float]
Converted to int.


In any inlet: The MIDI Event Message. The message is a list composed of the symbol midievent, followed by a list of integers which specify the MIDI event type and value.



MPE message [list]
In any inlet: The MPE event message is a list composed of the symbol mpeevent, followed by 6 integers which specify the Zone Master Channel, Zone Index, Voice Number, Channel Number, MIDI Message Number, and Data.


The message reset resets an individual voice (if received in a voice inlet) or all voices (if received in the leftmost inlet).

See Also

Name Description