live.miditool.in Reference

Retrieve notes and contextual data of MIDI clips in Live. Designed for use in a MIDI Tool Generator or MIDI Tool Transformation.

live.miditool.in

Description

The live.miditool.in object is used in a MIDI Tool Generator or MIDI Tool Transformation and is responsible for retrieving note and contextual information of the currently selected clip in Live. In combination with the live.miditool.out object, you can develop a generative or transformative process that can be controlled and triggered from the Tool Tabs.

Discussion

The live.miditool.in object is an essential building block of a Max for Live MIDI Tool and can only be used in an AMXD with the Note Generator or Note Transformation type. It will not work in an Audio Effect, MIDI Effect or Instrument device.

When live.miditool.in receives a bang it will start a new apply cycle or continue an existing one. Starting an apply cycle will retrieve the notes and contextual information of the currently selected clip. The notes are sent out the left outlet as a dictionary, and the contextual information is sent out the right outlet as a dictionary. Performing a user interaction outside of the MIDI Tool, for example, selecting a different clip, will cause the apply cycle to stop. The next time a bang is received, a new apply cycle will start. Continuation of the apply cycle will return the notes and contextual information of the clip from when you began the cycle and won't reflect the updated state of the clip if you modified it in the previous cycle. If you click the "Apply" button in the Tool Tabs, a cycle is started and ended in one interaction.

Arguments

None.

Attributes

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

A bang will continue or start an iteration of the apply cycle. In either case, a dictionary of notes is provided from the left outlet, and another dictionary of contextual information is provided from the right outlet.

(MIDI)

TEXT_HERE

See Also

Name Description
Live API Overview Live API Overview
Live Object Model LOM - The Live Object Model
live.miditool.out Set or replace notes of MIDI clips in Live. Designed for use in a MIDI Tool Generator or MIDI Tool Transformation.
live.object Perform operations on Live objects
live.path Navigate to objects in the Live application
live.observer Monitor changes in Live objects
Using the Live API Creating Devices that use the Live API
The LiveAPI JavaScript Object (jsliveapi) The LiveAPI Object