RNBO Objects & Operators wave~
Open Help

wave~

Linear interpolated multi-channel lookup of a buffer.

Description

wave~ reads from a portion of a buffer~ to produce a repeating waveform, given a signal input that goes between 0. and 1. (for example, using a phasor~ ) to define the position in the buffer.

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 wave~ object will have. If the buffer~ object being played by wave~ has more channels than the number of outputs of wave~ , the extra channels are not played. If the buffer~ object has fewer channels, the extra wave~ signal outputs are 0.

start [auto]

Optional

Set the start point of the wavetable. By default, the start point is 0. If you want to set a non-zero start point but retain the sample end as the waveform end point, use only a single typed-in argument after the buffer name. The wave~ object uses the buffer's sampling rate to determine loop points.

end [auto]

Optional

Set the end point of the wavetable. By default, the end point is the end of the sample. If a signal is connected to the end point (right) inlet, the initial waveform end point is ignored.

offset [auto]

Optional

Channel offset (zero-based).

Inlets

phase [auto]

Read through the buffer used by wave~ by sending values between 0. and 1. to the input. This can be acheived by using an object like phasor~ .

start [auto]

Set the start point of the wavetable. By default, the start point is 0. If you want to set a non-zero start point but retain the sample end as the waveform end point, use only a single typed-in argument after the buffer name. The wave~ object uses the buffer's sampling rate to determine loop points.

end [auto]

Set the end point of the wavetable. By default, the end point is the end of the sample. If a signal is connected to the end point (right) inlet, the initial waveform end point is ignored.

offset [auto]

Channel offset (zero-based).

Outlets

out [signal]

The output signal read from the wavetable.

outindex [signal]

Index (in samples).

out1 [signal]

The output signal read from the wavetable.

Fixed Attributes

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

boundmode [enum] (default: wrap)

Set the bound mode for input sample values 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: wrap)

Set the bound mode for input channel values Possible values:

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

channels [number] (default: 1)

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

indexmode [enum] (default: wave)

Set the lookup mode for values in the buffer Possible values:

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

interp [enum] (default: linear)

Set the 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].

end [auto]

Set the end point of the wavetable. By default, the end point is the end of the sample. If a signal is connected to the end point (right) inlet, the initial waveform end point is ignored.

offset [auto]

Channel offset (zero-based).

phase [auto]

Read through the buffer used by wave~ by sending values between 0. and 1. to the input. This can be acheived by using an object like phasor~ .

start [auto]

Set the start point of the wavetable. By default, the start point is 0. If you want to set a non-zero start point but retain the sample end as the waveform end point, use only a single typed-in argument after the buffer name. The wave~ object uses the buffer's sampling rate to determine loop points.

See Also

Name Description
buffer~ A data buffer for holding audio (or potentially some other) data.
lookup~ Index a buffer object using a signal, for waveshaping.
peek~ Read values from a buffer object.
groove~ Variable-rate looping sample playback of a sized buffer
declick~ declick~