array.tobuffer Reference

Write array object values to an audio buffer

array.tobuffer

Description

Values are assumed to be between -1 and 1. If the array contains multichannel data, each channel should be wrapped inside of a subarray (e.g. [ [ -1, 0, 1 ], [ -1, 0, -1 ] ]).

Arguments

buffer-name [symbol]

The name of the target buffer~ object

Attributes

buffername [symbol] (default: )

The name of the target buffer~ object

channelstart [int] (default: 0)

The 0-based channel index to which to write array values.

framelength [int] (default: -1)

The number of samples (per channel) to write from the array values.

frameoffset [int] (default: 0)

The 0-based frame offset to which to write array values.

resize [int] (default: 0)

When enabled, the buffer will be resized to accommodate the incoming data.

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

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

float

Convert an incoming floating-point number to an array, then process as described for the array message.

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

The buffer~ object expects floating-point values between -1 and 1.

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.frombuffer Read audio buffer values into an array object.
peek~ Read and write sample values
poke~ Write sample values to a buffer by index