|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.beadsproject.beads.core.Bead
net.beadsproject.beads.core.UGen
net.beadsproject.beads.ugens.Gain
public class Gain
Gain modifies the gain of a multi-channel audio signal. The gain value can be controlled by an audio signal.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class net.beadsproject.beads.core.UGen |
---|
UGen.OutputInitializationRegime, UGen.OutputPauseRegime |
Field Summary |
---|
Fields inherited from class net.beadsproject.beads.core.UGen |
---|
bufferSize, bufIn, bufOut, context, ins, outputInitializationRegime, outputPauseRegime, 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. |
float |
getGain()
Gets the current gain value. |
UGen |
getGainEnvelope()
Deprecated. As of version 1.0, replaced by setGain(UGen) . |
UGen |
getGainUGen()
Gets the gain UGen, if it exists. |
DataBeadReceiver |
sendData(DataBead db)
The method through which a class receives and parses DataBeads. |
Gain |
setGain(float gain)
Sets the gain to a static float value. |
Gain |
setGain(UGen gainUGen)
Sets a UGen to control the gain amount. |
void |
setGainEnvelope(UGen gainEnvelope)
Deprecated. As of version 1.0, replaced by setGain(UGen) . |
Methods inherited from class net.beadsproject.beads.core.UGen |
---|
addDependent, addInput, addInput, clearDependents, clearInputConnections, containsInput, crossfadeInput, getConnectedInputs, getContext, getEnvelopes, getIns, getNumberOfConnectedUGens, getNumberOfDependents, getOutBuffer, getOuts, getTimeTakenLastUpdate, getValue, getValue, getValueDouble, getValueDouble, initializeOuts, isTimerMode, isUpdated, noInputs, pause, printInBuffers, printInputList, printOutBuffers, removeAllConnections, removeConnection, removeDependent, setOutsToPause, setTimerMode, 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 |
---|
public Gain(AudioContext context, int inouts, UGen gainEnvelope)
context
- the AudioContext.inouts
- the number of inputs (= number of outputs).gainEnvelope
- the gain envelope.public Gain(AudioContext context, int inouts, float gain)
Static
gain envelop with the given
value.
context
- the AudioContext.inouts
- the number of inputs (= number of outputs).gain
- the fixed gain level.public Gain(AudioContext context, int inouts)
Static
gain envelop set to 1.
context
- the AudioContext.inouts
- the number of inputs (= number of outputs).Method Detail |
---|
@Deprecated public UGen getGainEnvelope()
setGain(UGen)
.
@Deprecated public void setGainEnvelope(UGen gainEnvelope)
setGain(UGen)
.
gainEnvelope
- the new gain envelope.public float getGain()
public Gain setGain(float gain)
gain
- The gain value.
public Gain setGain(UGen gainUGen)
gainUGen
- The gain UGen.
public UGen getGainUGen()
public void calculateBuffer()
UGen
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.
calculateBuffer
in class UGen
public DataBeadReceiver sendData(DataBead db)
DataBeadReceiver
Example usage:
public DataBeadReceiver sendData(DataBead db) {
someParameter = db.getFloat("someparameter", defaultValue);
someOtherParameter = db.getUGen("otherparameter");
// etc...
return this;
}
sendData
in interface DataBeadReceiver
db
- The DataBead message.
this
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |