mpeconfig

Configure a MIDI device that supports Multidimensional Polyphonic Expression (MPE) messages

Description

The mpeconfig object is used to set up and configure zones for interpreting incoming MIDI to MPE devices.

Examples

Arguments

None.

Attributes

chanrange [int] (default: 15)

The channel range specifies the number of channels following the zone master channel. (e.g. 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).

masterchan [int] (default: 1)

The zone master channel specifies the first channel for the currently defined zone.

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.

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 [float]

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

textjustification [int]

Text Justification

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

The bang message causes a zone to be defined based on the current settings of masterchan and chanrange. You can have a maximum of 7 zones.

clear

The clear message clears all currently configured zones and returns them to their default state.

createzone

Arguments

master-channel [int]
note-bend-range [int]
The word createzone, followed by a list of two integers that define the Master channel and the Note bend range, will define a zone. No bang message is required when using this message. You can have a maximum of 7 zones configured in any way you wish amongst the 16 channels.

masterbendrange

Arguments

max-bend-range [int]
The word masterbendrange, followed by an integer that specifies the maximum pitch bend range in semitones, will set the pitch bend range for all zones. that define the Master channel and the Note bend range, will define a zone. No bang message is required when using this message.

notebendrange

Arguments

max-bend-range [int]
The word notebandrange, followed by an integer that specifies the maximum pitch bend range in semitones, will set the pitch bend range for a specified master channel.

Note: If no master channel is set using a @masterchan attribute, the notebandrange message must always be preceded by a masterchan message to select a master channel, and followed by a bang message to define the zone.

See Also

Name Description
midiin Output raw MIDI data
midiformat Prepare data in the form of a MIDI message
midiparse Interpret raw MIDI data
mpeformat Prepare data in the form of a Multidimensional Polyphonic Expression (MPE) MIDI message
mpeparse Interpret raw MPE MIDI data
polymidiin Output Multidimensional Polyphonic Expression (MPE) MIDI data