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

array.stream Reference

Make an array of a certain size

array.stream

Description

array.stream accepts a number in the right inlet which specifies the length of the output array. Following the receipt of this number, the object will collect this number of elements input through the left inlet. After the array-length is complete, and with each subsequent input, the array will be output from the left outlet. A 1 or a 0 will be output from the right outlet depending on whether the array-length has been reached or not. A 1 signifies that the array-length has been reached and that the object is now collecting the stream. Use the clear message to reset the array.

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

Reprocess previously received array and trigger output.

int

Arguments

array-length [int]
If the output array length is negative, elements are added to the front of the output array, otherwise they are added to the end.

float

Arguments

array-length [int/float]
If the output array length is negative, elements are added to the front of the output array, otherwise they are added to the end.

list

Convert an incoming list to an array, then process as described for the array message.

anything

Convert an incoming list to an array, then process as described for the array message.

array

Add a list of elements sequentially (one element at a time) to the output array.

clear

Resets the streaming process.

dictionary

Wrap an incoming dictionary object in an array, then process as described for the array message.

string

Wrap a string object in an array, then process as described for the array message.

See Also

Name Description
array Create or duplicate an array object.
array.group Output an array when it reaches a certain size
array.tuplewise Make an array of a certain size (counting iterations)
zl.iter Successively output lists of specific size
zl.queue Output elements of a list in the order they are received