poke~ Reference

Write sample values to a buffer by index

poke~

Description

poke~ allows you to write samples into a buffer~ at sample locations specified by a signal.

Examples

Write into a buffer~ using either signals or numbers

Arguments

buffer-object-name [symbol]

Obligatory. Names the buffer~ where poke~ will write its incoming samples.

channel-number [int]

Optional

Sets the channel number of a multichannel buffer~ where the samples will be written. The default channel is 1.

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

int

Arguments

value/sample-index [int]
In left inlet: Converted to float.

In middle inlet: Sets the sample index for writing subsequent sample values coming in the left inlet. If there is a signal connected to this inlet, a float is ignored.

float

Arguments

value/sample-index/channel-number [float]
Like the peek~ object, poke~ can write float values into a buffer~. Note, however, that the left two inlets are reversed on the poke~ object compared to the peek~ object.

In left inlet: Sets the value to be written into the buffer~ at the specified sample index. If the sample index is not -1, the value is written.

In middle inlet: Converted to int.

In right inlet: Converted to int.

list

Arguments

value, sample-index, and channel-number [list]
In left inlet: A list of two or more values will write the first value at the sample index specified by the second value. If a third value is present, it specifies the audio channel within the buffer~ for writing the sample value.

(mouse)

Double-clicking on poke~ opens an editing window where you can view the contents of its associated buffer~ object.

set

Arguments

buffer-object-name [symbol]
The word set, followed by the name of a buffer~, changes the buffer~ where poke~ will write its incoming samples.

signal

In left inlet: Signal values you want to write into a buffer~.

In middle inlet: The sample index where values from the signal in the left inlet will be written. If the signal coming into the middle inlet has a value of -1, no samples are written.

See Also

Name Description
Working with Video in Jitter Working with Video in Jitter
buffer~ Store audio samples
buffir~ buffer-based FIR filter
peek~ Read and write sample values