RNBO Objects & Operators poke
Open Help

poke

Write a sample into an audio buffer.

Description

Write sample values to a named buffer~ 's index locations when specified by a value.

Arguments

buffername [symbol]

The name of the buffer~ where rnbo_poke will write its incoming samples.

Inlets

value [number, list, signal]

Values to write into a buffer~ .

index [number]

Sample Position of buffer~ to write values to.

channel [number]

Channel to write to

overdub [number]

Overdub specifies what percentage of the value stored at an index is preserved the next time a value is received at that index. (0.-1.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)

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.

  • 'fold'
  • 'clamp'
  • 'clip'
  • 'wrap'
  • 'mirror
  • 'ignore'
Possible values:

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

buffername [symbol]

The name of the buffer~ where rnbo_poke will write its incoming samples.

channelmode [enum] (default: ignore)

channelmode Possible values:

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

indexmode [enum] (default: samples)

indexmode Possible values:

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

overdubmode [enum] (default: accum)

overdubmode Possible values:

0 = 'mix'
1 = 'accum'

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

channel [number]

Channel to write to

index [number]

Sample Position of buffer~ to write values to.

overdub [number]

Overdub specifies what percentage of the value stored at an index is preserved the next time a value is received at that index. (0.-1.0)

value [number, list, signal]

Values to write into a buffer~ .

See Also

Name Description
poke~
poke~ Write a sample into an audio buffer.
buffer~ A data buffer for holding audio (or potentially some other) data.
splat~ Mix values into a buffer with linear interpolated overdubbing
peek Read values from a buffer object.
record~ Record audio into a buffer.