net.beadsproject.beads.ugens
Class Plug

java.lang.Object
  extended by net.beadsproject.beads.core.Bead
      extended by net.beadsproject.beads.core.UGen
          extended by net.beadsproject.beads.ugens.Plug

public class Plug
extends UGen

A simple UGen that just forwards its inputs to its outputs. Can be used to isolate 1 or more channels from a multi-channel UGen's output, or to collect several signals together.

Version:
0.9.5
Author:
Benito Crawford

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
Plug(AudioContext context)
          Constructor for a one-channel Plug using the specified audio context.
Plug(AudioContext context, int channels)
          Constructor for a Plug with the specified number of channels, using the specified audio context.
Plug(AudioContext context, UGen sourceUGen)
          Constructor for a mono Plug that takes input from the specified source UGen.
Plug(AudioContext context, UGen sourceUGen, int sourceOutputChannel)
          Constructor for a mono Plug that takes input from the specified output channel of a source UGen.
 
Method Summary
 void calculateBuffer()
          Called by the signal chain to update this UGen's ouput data.
 
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

Plug

public Plug(AudioContext context)
Constructor for a one-channel Plug using the specified audio context.

Parameters:
context - The audio context.

Plug

public Plug(AudioContext context,
            UGen sourceUGen)
Constructor for a mono Plug that takes input from the specified source UGen.

Parameters:
context - The audio context.
souceUGen - The source UGen.

Plug

public Plug(AudioContext context,
            UGen sourceUGen,
            int sourceOutputChannel)
Constructor for a mono Plug that takes input from the specified output channel of a source UGen.

Parameters:
context - The audio context.
souceUGen - The source UGen.
sourceOutputChannel - The channel from the source UGen to take as input.

Plug

public Plug(AudioContext context,
            int channels)
Constructor for a Plug with the specified number of channels, using the specified audio context.

Parameters:
context - The audio context.
channels - The number of channels.
Method Detail

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