peek Reference

Read values from a buffer object.

peek

Examples

Arguments

buffername [symbol]

Name of the buffer to read samples from.

channels [number]

Optional

Sets the number of output channels, which determines the number of outlets that the peek object will have. If the buffer~ object being referenced by peek has more channels than the number of outputs of peek, the extra channels are not played. If the buffer~ object has fewer channels, the extra peek outputs will output 0.

Inlets

index [number]

The value stored at the specified sample-index is sent out the peek object's outlet.

offset [number]

The buffer channel to read samples from, if a multichannel buffer is in use (starting from 0).

Fixed Attributes

These attributes must be set in the object box and determine the behavior of the object at runtime.

boundmode [enum] (default: ignore)

Set the bound mode for input sample values. This determines how values above or below the number of samples in the referenced buffer are handled.

Possible values:

0 = 'fold'
1 = 'clamp'
2 = 'clip'
3 = 'wrap'
4 = 'mirror'
5 = 'ignore'

buffername [symbol]

Name of the buffer to read samples from.

channelmode [enum] (default: ignore)

Set the bound mode for input channel selection values. This determines how values sent to the right inlet that are above or below the number of channels in the referenced buffer are handled.

Possible values:

0 = 'fold'
1 = 'clamp'
2 = 'clip'
3 = 'wrap'
4 = 'mirror'
5 = 'ignore'

channels [number]

Sets the number of output channels, which determines the number of outlets that the peek object will have. If the buffer~ object being referenced by peek has more channels than the number of outputs of peek, the extra channels are not played. If the buffer~ object has fewer channels, the extra peek outputs will output 0.

indexmode [enum] (default: samples)

Sets the lookup mode for accessing buffer values (default = samples).

Possible values:

0 = 'phase'
1 = 'samples'
2 = 'signal'
3 = 'lookup'
4 = 'wave'

interp [enum] (default: none)

Sets teh type of interpolation to use when reading samples from the buffer

Possible values:

0 = 'linear'
1 = 'cubic'
2 = 'spline'
3 = 'cosine'
4 = 'step'
5 = 'none'

Dynamic Attributes

These attributes can be modified in the code during execution using the set object

buffer [number] (default: 0)

If multiple buffer names are declared to be used, this sets the currently active buffer using an index [0 based].

index [number]

The value stored at the specified sample-index is sent out the peek object's outlet.

offset [number]

The buffer channel to read samples from, if a multichannel buffer is in use (starting from 0).

See Also

Name Description
peek~ Read and write sample values
peek~ Read values from a buffer object.
buffer~ A data buffer for holding audio (or potentially some other) data.
groove~ Variable-rate looping sample playback of a sized buffer
poke Write a sample into an audio buffer.
record~ Record audio into a buffer.
splat~ Mix values into a buffer with linear interpolated overdubbing
wave~ Linear interpolated multi-channel lookup of a buffer.