peek~
MSP Reference
Open Help

peek~

Read and write sample values

Description

Use peek~ to read and write sample values to a named buffer~. Unlike related objects index~ and poke~, values and indices are specified as Max messages, and the object will function even when the audio is not turned on.

Examples

Peek at samples in a buffer~, and/or set the value of the samples

Arguments

buffer-name [symbol]

Buffer name

buffer-channel [int]

Optional

Buffer channel to read/write

clipping-enable-flag [int]

Optional

If set to 1, then values written to the buffer~ will be clipped to within -1.0 to 1.0. See the clip message.

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.

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 [float]

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

textjustification [int]

Text Justification

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

int

Arguments

sample-index [int]
The value stored at the specified sample-index is sent out the peek~ object's outlet. However, if a value has just been received in the middle inlet, peek~ stores that value in the buffer~ at the specified sample index instead. If the sample-index is out of range for the buffer~, no data is read or written.

float

Arguments

sample-index/buffer-channel [float]
Floating-point values are converted to int values.

In left inlet: Set the sample to be stored.
In right inlet: Set the buffer channel.

list

Arguments

sample-index [int]
value [number]
buffer-channel [int]
The value is stored in the buffer~ at the specified sample-index and buffer-channel. If the buffer-channel is omitted, the most recent channel is used. If the sample-index is out of range for the buffer~, no data is written.

clip

Arguments

clipping-enable-flag [int]
If set to 1, then values written to the buffer~ will be clipped to within -1.0 to 1.0. Disable by setting to 0.

(mouse)

Double-click to view the buffer~ contents

set

Arguments

buffer-name [symbol]
Set buffer~ to read/write

Output

float

The sample value in a buffer~, located at the table index specified by a float or int received in the left inlet, is sent out the peek~ object's outlet.

See Also

Name Description
buffer~ Store audio samples
buffir~ buffer-based FIR filter
index~ Read from a buffer~ with no interpolation
poke~ Write sample values to a buffer by index
table Store and edit an array of numbers