Examples
Constructors
- { arguments={name, channels}, inlets={index, channel_offset} }
- { arguments={name}, inlets={index, channel_offset} }
- { arguments={name, channels}, inlets={phase, channel_offset} }
- { arguments={name}, inlets={phase, channel_offset} }
- { arguments={name, channels}, inlets={signal, channel_offset} }
- { arguments={name}, inlets={signal, channel_offset} }
- { arguments={name, channels}, inlets={wave_phase, wave_start, wave_end, channel_offset} }
- { arguments={name}, inlets={wave_phase, wave_start, wave_end, channel_offset} }
Inlets
index
sample index to read
channel_offset
channel_offset (zero-based)
phase
phase to read (between 0 and 1)
signal
value to lookup (between -1 and 1)
wave_phase
phase to read (between start and end indices)
wave_start
wave start index (samples)
wave_end
wave end index (samples)
Attributes
boundmode [enum] (default: ignore)
Handle out-of-range indices: "ignore" returns zero, "wrap" wraps the indices back into the range of the buffer, "fold" and "mirror" wrap the indices back into range by alternating direction, "clip" and "clamp" constrain the indices to the buffer limits.
Possible values:
0 = 'clamp'
1 = 'clip'
2 = 'fold'
3 = 'ignore'
4 = 'mirror'
5 = 'wrap'
channelmode [enum] (default: ignore)
Handle invalid channel indices: "ignore" returns zero, "wrap" wraps the indices back into channels of the buffer, "fold" and "mirror" wrap the indices back into range by alternating direction, "clip" and "clamp" constrain the indices to the channels available.
Possible values:
0 = 'clamp'
1 = 'clip'
2 = 'fold'
3 = 'ignore'
4 = 'mirror'
5 = 'wrap'
channels [int] (default: 1)
Specify the number of channels to read
index [enum] (default: phase)
Specify how to index the buffer: "samples" indexes by sample offset into the buffer, "phase" converts a signal in the range of 0..1 to span the whole buffer, "lookup" or "signal" converts a signal in the range -1..1 to span the whole buffer, "wave" uses two additional inlets to specify start and end indices of a section of the buffer (in samples), and converts a signal in the range of 0..1 to span this section.
Possible values:
0 = 'lookup'
1 = 'phase'
2 = 'samples'
3 = 'signal'
4 = 'wave'
interp [enum] (default: linear)
Specify the interpolation mode: "none" and "step" perform no interpolation, "linear" performs two-point linear interpolation, "cosine" performs two-point cosine interpolation, "cubic" performs four-point cubic interpolation, and "spline" performs four-point Catmull-Rom spline interpolation.
Possible values:
0 = 'cosine'
1 = 'cubic'
2 = 'linear'
3 = 'none'
4 = 'spline'
5 = 'step'
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]
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]
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]
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.
See Also
| Name | Description |
|---|---|
| buffer | A reference to an external buffer~ object |
| channels | The number of channels of a data/buffer object |
| cycle | Sine / wavetable lookup oscillator |
| data | A locally stored array of 64-bit values |
| dim | The length (in samples) of a data/buffer object |
| lookup | Index a data/buffer object using a signal, for waveshaping |
| nearest | Multi-channel lookup a data/buffer object (no interpolation) |
| peek | Read values from a data/buffer object |
| poke | Write values into a data/buffer object |
| sample | Linear interpolated multi-channel lookup of a data/buffer object |
| splat | Mix values into a data/buffer object, with linear interpolated overdubbing |
| wave | Wavetable synthesis using a data/buffer object |