Description

The live.menu object can be used to display text associated with incoming numbers and provide a general user interface. Item numbering starts from zero (0).

Examples

Arguments

None.

Attributes

active [int] (default: 1)

Toggles the object's active mode. When the active attribute is set to 0, the mouse action does not cause output and the inactive colors are used. The default is 1 (on).

activebgcolor [4 floats]

Sets the background color of the display when the active attribute is set to 1.

annotation_name [symbol] (default: )

The string that is prepended to annotations. This shows up in the Info pane in Live, and the clue window in Max.

appearance [int] (default: 0)8.0.0

Defines the display style.

Possible values:

0 = 'Default'
The text appears with the boundaries of the text box. All attributes, except those with 'lcd' in the name, are functional.

1 = 'LCD'
The text appears with the boundaries of the text box. To adjust the colors of the object you must use the attributes with 'lcd' in the name, such as inactivelcdcolor, lcdbgcolor, and lcdcolor.

bordercolor [4 floats]

Sets the display color for the live.menu object's border in RGBA format.

focusbordercolor [4 floats]

Sets the border color in RGBA format to be used when the live.menu has the focus.

hltcolor [4 floats]

Sets the highlight color in RGBA format to be used when you select an item with the mouse.

hlttextcolor [4 floats]

Sets the highlight text color in RGBA format to be used when you select an item with the mouse.

inactivelcdcolor [4 floats]8.0.0

Sets the text and highlight color when the appearance attribute is set to 1:LCD, and the active attribute is set to 0.

lcdbgcolor [4 floats]8.0.0

Sets the background color of the display when the appearance attribute is set to 1:LCD.

lcdcolor [4 floats]8.0.0

Sets the text and highlight color when the appearance attribute is set to 1:LCD.

parameter_mappable [int] (default: 1)

When parameter_mappable is enabled, the object will be available for mapping to keyboard or MIDI input using the Mappings feature.

pictures [64 symbols]

Sets the paths of any pictures used when the usepicture attribute is set to 1. Bitmap images such as PNG or vectorized images (SVG) can be used.

remapsvgcolors [int] (default: 0)8.0.0

Sets the color that the SVG image will use. When usepicture is set to 1, and remapsvgcolors is set to 0, the color supplied by the SVG file are used; if set to 1, the color attributes for the appropriate display mode are used.

textcolor [4 floats]

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

tricolor [4 floats]

Sets the triangle color in RGBA format.

usepicture [int] (default: 0)

Toggles the use of the pictures instead of text display. Note that you need to provide enough pictures by setting the pictures attribute properly.

usesvgviewbox [int] (default: 0)8.0.0

Sets the viewbox for the svg files when usepicture is set to 1. If usesvgviewbox is set to 0, Max determines the viewbox; if set to 1, uses the viewbox flag supplied by the svg file.

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.

hidden [int] (default: 0)

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 [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.

Parameter Attributes

Order

Typeint

Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.

Parameter Mode Enable

Typeint

Parameter Mode Enable (not available from Parameters window)

Link to Scripting Name

Typeint

When checked, the Scripting Name is linked to the Long Name attribute.

Long Name

Typesymbol

The long name of the parameter. This name must be unique per patcher hierarchy.

Short Name

Typesymbol

Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.

Type

Typeint

Specifies the data type. The data types used in Max for Live are:

Float Int Enum (enumerated list) Blob

Note: By convention, the Live application uses floating point numbers for its calculations; the native integer representation is limited to a range of 0-255 (similar to the char data type used in Jitter). When working with Live UI objects whose integer values are likely to be outside of the 0-255 range, the Type attribute should be set to Float, and the Unit Style attribute should be set to Int.

Range/Enum

Typelist

When used with an integer or floating point data type, this field is used to specify the minimum and maximum values of the parameter. When used with an enumerated list (Enum) data type, this field contains a space-delimited list of the enumerated values (if list items contain a space or special characters, the name should be enclosed in double quotes).

Modulation Mode

Typeint

Sets the Modulation Mode used by the Live application. The modulation modes are:

None Unipolar Bipolar Additive Absolute

Modulation Range

Typelist

This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.

Initial Enable

Typeint

When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).

Initial

Typelist

Sets the initial value to be stored and used when the Initial Enable attribute is checked.

Custom Units

Typesymbol

Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").

Exponent

Typefloat

When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.

Steps

Typeint

The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.

Parameter Visibility

Typeint

For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.

Update Limit (ms)

Typeint

Speed limits values triggered by automation.

Defer Automation Output

Typeint

Defers values triggered by automation.

Messages

bang

Sends the current item out the outlets.

int

Arguments

item-index
[int]

An integer specifies a menu item to be displayed, and causes the live.menu object to display that item and output information about its index and the symbol associated with that menu index. Menu item numbering starts at 0.

float

Arguments

item-index
[float]

Converted to int.

assign

Arguments

assign-input
[float]

The word assign, followed by a floating point value, causes that value to be stored and displayed and sent out the live.menu object's outlet. If the Parameter Visibility attribute is set to Stored Only, the assign message will not add the new value to the Live application’s undo chain.

init

Restore and output the initial value.

(mouse)

Clicking with the mouse lets you select a menu item to be displayed and outputs information about its index and the symbol associated with that menu index.

outputvalue

Sends the current value out the outlet.

rawfloat

Arguments

input-value
[float]

A raw normalized value (between 0. and 1.) received in the inlet is converted to a real value, stored, displayed by live.menu, and the current item is sent out the outlets.

set

Arguments

item index
[float]

The word set, followed by a number, specifies a menu item to be displayed by the live.menu object without triggering any output.

setsymbol

Arguments

menu item
[list]

The word setsymbol, followed by a message, selects a menu item to be displayed by name without triggering any output.

symbol

Arguments

menu item
[list]

The word symbol, followed by a message, selects a menu item to be displayed by name. If the item is found, the menu item is displayed and information about its index and the symbol associated with that menu index.

Output

anything

Out middle outlet: The text of the selected menu item is sent out as a message.

float

Out right outlet: When an output is triggered, a raw normalized value (between 0. and 1.) is sent out this outlet.

int

Out left outlet: The number of the selected menu item is sent out. Menu items are numbered beginning with 0.