A newer version of Max is available. Click here to access the latest version of the documentation

splat Reference

Mix values into a data/buffer object, with linear interpolated overdubbing

splat

Examples

Constructors

  • { arguments={name, value, position, channel, overdub}, inlets={} }
  • { arguments={name, value, position, channel}, inlets={overdub} }
  • { arguments={name, position, channel}, inlets={value, overdub} }
  • { arguments={name, channel}, inlets={value, position, overdub} }
  • { arguments={name}, inlets={value, position, channel, overdub} }

Inlets

value

Typefloat

value to write

position

Typefloat

position to write (units depend on @index attribute)

channel

Typeint

channel to write (zero-based)

overdub

Typefloat

overdub mix: amount of original signal to preserve

Attributes

boundmode [enum] (default: wrap)

g/s(set)

Handle out-of-range indices: "ignore" prevents writing, "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 = 'ignore'
2 = 'wrap'
3 = 'clip'
4 = 'fold'
5 = 'mirror'

channelmode [enum] (default: clamp)

g/s(set)

Handle invalid channel indices: "ignore" prevents writing, "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 = 'ignore'
2 = 'wrap'
3 = 'clip'
4 = 'fold'
5 = 'mirror'

index [enum] (default: samples)

g/s(set)

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.

Possible values:

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

overdubmode [enum] (default: mix)

g/s(set)

How overdubbing is applied: "mix" crossfades between current and new sample according to the overdub factor, "accum" scales the new sample by the overdub factor and adds it to the current sample.

Possible values:

0 = 'accum'
1 = 'mix'

Common Box Attributes

See Also

Name Description
buffer
channels
cycle
data
dim
lookup
nearest
peek
poke
sample
splat
wave