Class MembraneSynth

MembraneSynth makes kick and tom sounds using a single oscillator with an amplitude envelope and frequency ramp. A Tone.OmniOscillator is routed through a Tone.AmplitudeEnvelope to the output. The drum quality of the sound comes from the frequency envelope applied during MembraneSynth.triggerAttack(note). The frequency envelope starts at note * .octaves and ramps to note over the duration of .pitchDecay.

Example

const synth = new Tone.MembraneSynth().toDestination();
synth.triggerAttackRelease("C2", "8n");

Hierarchy (view full)

Constructors

Properties

context: BaseContext

The context belonging to the node.

debug: boolean = false

Set this debug flag to log all events that happen in this class.

detune: Signal<"cents">

The detune signal

The envelope

frequency: Signal<"frequency">

The frequency signal

input: undefined

The instrument only has an output

name: string = "MembraneSynth"
octaves: number

The number of octaves the pitch envelope ramps.

Min

0.5

Max

8

onsilence: onSilenceCallback

Invoked when the release has finished and the output is silent.

oscillator: OmniOscillator<any>

The oscillator.

output: OutputNode
pitchDecay: Unit.Time

The amount of time the frequency envelope takes.

Min

0

Max

0.5

portamento: 0 = 0

Portamento is ignored in this synth. use pitch decay instead.

volume: Param<"decibels">

The volume of the output in decibels.

Example

const amSynth = new Tone.AMSynth().toDestination();
amSynth.volume.value = -6;
amSynth.triggerAttackRelease("G#3", 0.2);
version: string = version

The version number semver

Accessors

  • get blockTime(): number
  • The number of seconds of 1 processing block (128 samples)

    Returns number

    Example

    console.log(Tone.Destination.blockTime);
    
  • get channelCount(): number
  • channelCount is the number of channels used when up-mixing and down-mixing connections to any inputs to the node. The default value is 2 except for specific nodes where its value is specially determined.

    Returns number

  • set channelCount(channelCount): void
  • Parameters

    • channelCount: number

    Returns void

  • get channelCountMode(): ChannelCountMode
  • channelCountMode determines how channels will be counted when up-mixing and down-mixing connections to any inputs to the node. The default value is "max". This attribute has no effect for nodes with no inputs.

    • "max" - computedNumberOfChannels is the maximum of the number of channels of all connections to an input. In this mode channelCount is ignored.
    • "clamped-max" - computedNumberOfChannels is determined as for "max" and then clamped to a maximum value of the given channelCount.
    • "explicit" - computedNumberOfChannels is the exact value as specified by the channelCount.

    Returns ChannelCountMode

  • set channelCountMode(channelCountMode): void
  • Parameters

    • channelCountMode: ChannelCountMode

    Returns void

  • get channelInterpretation(): ChannelInterpretation
  • channelInterpretation determines how individual channels will be treated when up-mixing and down-mixing connections to any inputs to the node. The default value is "speakers".

    Returns ChannelInterpretation

  • set channelInterpretation(channelInterpretation): void
  • Parameters

    • channelInterpretation: ChannelInterpretation

    Returns void

  • get disposed(): boolean
  • Indicates if the instance was disposed. 'Disposing' an instance means that all of the Web Audio nodes that were created for the instance are disconnected and freed for garbage collection.

    Returns boolean

  • get numberOfInputs(): number
  • The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

    Returns number

    Example

    const node = new Tone.Gain();
    console.log(node.numberOfInputs);
  • get numberOfOutputs(): number
  • The number of outputs of the AudioNode.

    Returns number

    Example

    const node = new Tone.Gain();
    console.log(node.numberOfOutputs);

Methods

  • Connect the output of this node to the rest of the nodes in series.

    Parameters

    Returns this

    Example

    const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/handdrum-loop.mp3");
    player.autostart = true;
    const filter = new Tone.AutoFilter(4).start();
    const distortion = new Tone.Distortion(0.5);
    // connect the player to the filter, distortion and then to the master output
    player.chain(filter, distortion, Tone.Destination);
  • connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode

    Parameters

    • destination: InputNode

      The output to connect to

    • outputNum: number = 0

      The output to connect from

    • inputNum: number = 0

      The input to connect to

    Returns this

  • connect the output of this node to the rest of the nodes in parallel.

    Parameters

    Returns this

    Example

    const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/conga-rhythm.mp3");
    player.autostart = true;
    const pitchShift = new Tone.PitchShift(4).toDestination();
    const filter = new Tone.Filter("G5").toDestination();
    // connect a node to the pitch shift and filter in parallel
    player.fan(pitchShift, filter);
  • Set multiple properties at once with an object.

    Parameters

    Returns this

    Example

    const filter = new Tone.Filter().toDestination();
    // set values using an object
    filter.set({
    frequency: "C6",
    type: "highpass"
    });
    const player = new Tone.Player("https://tonejs.github.io/audio/berklee/Analogsynth_octaves_highmid.mp3").connect(filter);
    player.autostart = true;
  • Set the note at the given time. If no time is given, the note will set immediately.

    Parameters

    Returns this

    Example

    const synth = new Tone.Synth().toDestination();
    synth.triggerAttack("C4");
    // change to F#6 in one quarter note from now.
    synth.setNote("F#6", "+4n");
  • Sync the instrument to the Transport. All subsequent calls of triggerAttack and triggerRelease will be scheduled along the transport.

    Returns this

    Example

    const fmSynth = new Tone.FMSynth().toDestination();
    fmSynth.volume.value = -6;
    fmSynth.sync();
    // schedule 3 notes when the transport first starts
    fmSynth.triggerAttackRelease("C4", "8n", 0);
    fmSynth.triggerAttackRelease("E4", "8n", "8n");
    fmSynth.triggerAttackRelease("G4", "8n", "4n");
    // start the transport to hear the notes
    Tone.Transport.start();
  • Convert the incoming time to seconds. This is calculated against the current TransportClass bpm

    Parameters

    Returns number

    Example

    const gain = new Tone.Gain();
    setInterval(() => console.log(gain.toSeconds("4n")), 100);
    // ramp the tempo to 60 bpm over 30 seconds
    Tone.getTransport().bpm.rampTo(60, 30);
  • Convert the class to a string

    Returns string

    Example

    const osc = new Tone.Oscillator();
    console.log(osc.toString());
  • Trigger the attack of the note optionally with a given velocity.

    Parameters

    • note: Unit.Frequency | FrequencyClass<number>

      The note to trigger.

    • Optional time: Unit.Time

      When the note should start.

    • velocity: number = 1

      The velocity determines how "loud" the note will be.

    Returns this

    Example

    const synth = new Tone.Synth().toDestination();
    // trigger the note a half second from now at half velocity
    synth.triggerAttack("C4", "+0.5", 0.5);
  • Trigger the attack and then the release after the duration.

    Parameters

    • note: Unit.Frequency

      The note to trigger.

    • duration: Unit.Time

      How long the note should be held for before triggering the release. This value must be greater than 0.

    • Optional time: Unit.Time

      When the note should be triggered.

    • Optional velocity: number

      The velocity the note should be triggered at.

    Returns this

    Example

    const synth = new Tone.Synth().toDestination();
    // trigger "C4" for the duration of an 8th note
    synth.triggerAttackRelease("C4", "8n");
  • Trigger the release portion of the envelope.

    Parameters

    • Optional time: Unit.Time

      If no time is given, the release happens immediately.

    Returns this

    Example

    const synth = new Tone.Synth().toDestination();
    synth.triggerAttack("C4");
    // trigger the release a second from now
    synth.triggerRelease("+1");