mpeformat Reference

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

mpeformat

Description

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.

Examples

Arguments

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.

Attributes

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

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [4 floats]

Sets the color for the object's text in RGBA format.

textjustification [int]

Sets the justification for the object's text.

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

bang

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.

int

Arguments

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.

float

Arguments

byte [float]
Converted to int.

midievent

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.

mpeevent

Arguments

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.

reset

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
midiformat Prepare data in the form of a MIDI message
midiin Output raw MIDI data
midiparse Interpret raw MIDI data
mpeconfig Configure a MIDI device that supports Multidimensional Polyphonic Expression (MPE) messages
mpeparse Interpret raw MPE MIDI data
polymidiin Output Multidimensional Polyphonic Expression (MPE) MIDI data