index~
Read from a buffer~ with no interpolation
Description
Use index~ to read from a buffer~ object at a signal-driven sample index with no interpolation on the output.
Discussion
Since the index~ object does no interpolation, it is less useful for general sample playback tasks than play~, groove~ etc. However, it may be more accurate and efficient for special circumstances of using a buffer~ as data storage such as for FFT windowing. Unlike peek~, the buffer~ index to read is specified as a signal.
Arguments
buffer-name[symbol]
optional
Buffer name
buffer-channel-to-index[int]
optional
Buffer channel to read
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]: 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'
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]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
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]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 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]
write-only
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]
write-only
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
In right inlet: Specify the channel to read
- buffer-channel
[int]
float
In right inlet: Converted to int
- buffer-channel
[int]
(mouse)
Double-click to view the buffer~ contents
set
signal
Set sample index
Output
signal
Out left outlet: Samples from the buffer at the sample indices specified by the input. No interpolation is performed if the input sample index is not an integer.
Out right outlet: A signal containing the current buffer channel. This signal can be connected to the right inlet of poke~ to guarantee that index~ will produce output before poke~ consumes it. This technique is known as order forcing .
See Also
| Name | Description |
|---|---|
| buffer~ | Store audio samples |
| buffir~ | buffer-based FIR filter |
| count~ | Count samples elapsed |
| fft~ | Fast Fourier transform |