net.beadsproject.beads.ugens
Class Gain

java.lang.Object
  net.beadsproject.beads.core.Bead
      net.beadsproject.beads.core.UGen
          net.beadsproject.beads.ugens.Gain

Direct Known Subclasses:

Breakbeat

public class Gain
extends UGen

Gain modifies the gain of a multi-channel audio signal. The gain value can be controlled by an audio signal.

Author:

ollie

Field Summary

Fields inherited from class net.beadsproject.beads.core.UGen

bufferSize, bufIn, bufOut, context, ins, outs

Constructor Summary

Gain(AudioContext context, int inouts)
Instantiates a new Gain with Static gain envelop set to 1.

Gain(AudioContext context, int inouts, float gain)
Instantiates a new Gain with a Static gain envelop with the given value.

Gain(AudioContext context, int inouts, UGen gainEnvelope)
Instantiates a new Gain.

Method Summary

void	calculateBuffer() Called by the signal chain to update this UGen's ouput data.
UGen	getGainEnvelope() Gets the gain envelope.
void	setGainEnvelope(UGen gainEnvelope) Sets the gain envelope.

Methods inherited from class net.beadsproject.beads.core.UGen

addDependent, addInput, addInput, clearInputConnections, getContext, getIns, getNumberOfConnectedUGens, getOuts, getValue, getValue, noInputs, pause, printInputList, printOutBuffers, removeAllConnections, removeDependent, setValue, update, zeroIns, zeroOuts

Methods inherited from class net.beadsproject.beads.core.Bead

getKillListener, getName, isDeleted, isPaused, kill, message, messageReceived, setKillListener, setName, start, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Gain

public Gain(AudioContext context,
            int inouts,
            UGen gainEnvelope)

Instantiates a new Gain.

Parameters:

context - the AudioContext.

inouts - the number of inputs (= number of outputs).

gainEnvelope - the gain envelope.

Gain

public Gain(AudioContext context,
            int inouts,
            float gain)

Instantiates a new Gain with a Static gain envelop with the given value.

Parameters:

context - the AudioContext.

inouts - the number of inputs (= number of outputs).

gainEnvelope - the fixed gain level.

Gain

public Gain(AudioContext context,
            int inouts)

Instantiates a new Gain with Static gain envelop set to 1.

Parameters:

context - the AudioContext.

inouts - the number of inputs (= number of outputs).

Method Detail

getGainEnvelope

public UGen getGainEnvelope()

Gets the gain envelope.

Returns:

the gain envelope.

setGainEnvelope

public void setGainEnvelope(UGen gainEnvelope)

Sets the gain envelope.

Parameters:

gainEnvelope - the new gain envelope.

calculateBuffer

public void calculateBuffer()

Description copied from class: UGen

Called by the signal chain to update this UGen's ouput data. Subclassses of UGen should implement the UGen's DSP perform routine here. In general this involves grabbing data from UGen.bufIn and putting data into UGen.bufOut in some way. UGen.bufIn and UGen.bufOut are 2D arrays of floats of the form float[numChannels][bufferSize]. The length of the buffers is given by UGen.bufferSize, and the number of channels of the input and output buffers are given by UGen.ins and UGen.outs respectively.

Specified by:

calculateBuffer in class UGen