skip to content

Pads

An instrument optimized for drums and other rhythmic or non-melodic patterns.

class
Pads
extends
Sampler
tag
<pads-blam>
see

Props

name type default description
bank string

By default, the sample bank for the element will be a descendant Bank element. Or you can supply an id for a remote Bank element.

out string

An id for the next element in the signal chain. If not supplied this defaults to a descendant Chain element or (if no Chain is included) the ancestor Audio element.

gain (`AudioParam`) number 1

The gain level for samples played by this element. All subsequent gain settings in the signal chain are relative to this.

detune (`AudioParam`) number 0

Maps to the buffer’s detune parameter. Set the detune value in cents. 100 means a half step (semitone) up and -100 means a half step (semitone) down.

length number null

Foreshorten the sample. The value, in beats, represents the new length. Can be randomized using a Blam element for interesting effects.

start number 0

Where, in beats, to start the sample playback. Maps to the start method’s offset prop. Where reverse is applied, the position is moved to the opposite end of the sample.

mute boolean false

Sets the gain to zero. To avoid popping sounds, it slopes the gain using the choke value, if set, or 0.01 seconds.

choke boolean|number false

Whether to stop the previous sound when a new sound starts. Important for emulating instruments like bass. If set as a Boolean attribute, the gain of the previous sample is rapidly sloped to 0 over 0.01 seconds. Set an explicit value to adjust this.

reverse boolean|number false

Whether to play the reversed version of the sample. Set as a Boolean, there's a 100% chance. Set with a number/float sets the probability. For example, reverse="0.25" means a a 25% chance the sample will be played in reverse. It can only do so where the <sample-blam> element has reverse set (meaning the reversed sample was created).

robin boolean false

By default, samples are played at random and the same sample is never played twice in a row. With robin set, samples are cycled through in order.

Events

type description
sounds

Fired when all of the associated Bank element’s buffers are ready for playing.

blam

Fired whenever a sound (buffer) is played.

Methods

name args description
play

cipher: The number (not zero-based) or id of the specific sound. Where undefined, either a random sound or the next sound is played, depending on whether robin is true, time: When, relative to the context’s currentTime, to play the sound. Immediately, if not set.

Plays one of the associated Bank’s sounds.

Examples

Examples that use the Pads element: