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

live.button Reference

Flash on any message, send a bang

live.button

Description

live.button is used to trigger other messages and processes.

Examples

Arguments

None.

Attributes

active [int] (default: 1)

Toggles the object's active mode. When active is set to 0, mouse action does not cause output and the inactive colors are used.

activebgcolor [4 floats]

When the active attribute is set to 1, this attribute sets the background color displayed when the button is off in RGBA format.

activebgoncolor [4 floats]

When the active attribute is set to 1, this attribute sets the background color displayed when the button is on in RGBA format.

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.

bgcolor [4 floats]

When the active attribute is set to 0, this attribute sets the background color displayed when the button is off in RGBA format.

bgoncolor [4 floats]

When the active attribute is set to 0, this attribute sets the background color displayed when the button is on in RGBA format.

blinktime [int] (default: 100)

Sets the blink time in milliseconds.

bordercolor [4 floats]

Sets the border color of live.button object in RGBA format. Note that this color is only used in the assignment mode within Live.

focusbordercolor [4 floats]

Sets the display color for the focused live.button object's border in RGBA format. Note that this color is only used in assignment mode within Live.

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.

transition [int] (default: 0)

The parameter automation of live.button stores 0 and 1 values. The transition attribute specifies when a bang message will be sent to the outlet.
0 Zero->One: output a bang when the parameter value changes from 0. to 1.
1 One->Zero: output a bang when the parameter value changes from 1. to 0.
2 Both: output a bang when the parameter value changes from 0. to 1. and when it changes from 1. to 0.

Possible values:

0 = 'Zero->One' ( Output a bang on 0. to 1. transitions )
Outputs a bang when the parameter value changes from 0. to 1.

1 = 'One->Zero' ( Output a bang on 1. to 0. transitions )
Outputs a bang when the parameter value changes from 1. to 0.

2 = 'Both' ( Output a bang on 0. to 1. and 1. to 0. transitions )
Outputs a bang when the parameter value changes from 0. to 1. and when it changes from 1. to 0.

Common Box Attributes

Parameter Attributes

Messages

bang

Performs the same function as anything.

int

Arguments

input [int]
Performs the same function as anything.

float

Arguments

input [float]
Performs the same function as anything.

anything

Arguments

input [list]
When any message is received in the inlet, the button flashes briefly and a bang is sent out the outlet.

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

(mouse)

Clicking on the live.button object will cause it to flash briefly and send a bang message out the outlet.

Output

bang

A mouse click or any message in the inlet causes the live.button object to flash and send a bang message.

See Also

Name Description
Max For Live Max For Live
button
trigger
Max Basic Tutorial 2: Bang! Max Basic Tutorial 2: Bang!