Minim core
ugens
analysis
Name UGen.UGenInput
Description A UGenInput represents parameter of the UGen that can be controlled by other UGens by patching to it. When not patched, a UGenInput produces a constant value, which can be changed at any time by calling setLastValue.

A UGenInput will have an InputType of either AUDIO or CONTROL. An AUDIO input will always have the same number of channels as the owning UGen, in other words the length of the array returned by getLastValues will have a length equal to channel count. A CONTROL input will always have one channel and its value can be conveniently queried by calling getLastValue().

Examples
/**
  * This sketch demonstrates how to create a simple synthesis chain that 
  * involves controlling the value of a UGenInput with the output of 
  * a UGen. In this case, we patch an Oscil generating a sine wave into 
  * the amplitude input of an Oscil generating a square wave. The result 
  * is known as amplitude modulation.
  * <p>
  * For more information about Minim and additional features, 
  * visit http://code.compartmental.net/minim/
  */

import ddf.minim.*;
import ddf.minim.ugens.*;

Minim minim;
AudioOutput out;
Oscil       wave;
Oscil       mod;

void setup()
{
  size(512, 200, P3D);
  
  minim = new Minim(this);
  
  // use the getLineOut method of the Minim object to get an AudioOutput object
  out = minim.getLineOut();
  
  // create a triangle wave Oscil, set to 440 Hz, at 1.0 amplitude
  // in this case, the amplitude we construct the Oscil with 
  // doesn't matter because we will be patching something to
  // its amplitude input.
  wave = new Oscil( 440, 1.0f, Waves.TRIANGLE );
 
  // create a sine wave Oscil for modulating the amplitude of wave
  mod  = new Oscil( 2, 0.4f, Waves.SINE );
 
  // connect up the modulator
  mod.patch( wave.amplitude );
  
  // patch wave to the output
  wave.patch( out );
}

void draw()
{
  background(0);
  stroke(255);
  
  // draw the waveforms
  for(int i = 0; i < out.bufferSize() - 1; i++)
  {
    line( i, 50 + out.left.get(i)*50, i+1, 50 + out.left.get(i+1)*50 );
    line( i, 150 + out.right.get(i)*50, i+1, 150 + out.right.get(i+1)*50 );
  }
}
Constructors
UGenInput(type);
UGenInput(type, value);
Parameters
type   the InputType of this UGenInput
value   the initial float value used for all last values
Methods
channelCount ( )   Returns how many channels this UGenInput generates.

getIncomingUGen ( )   The incoming UGen is the UGen that is patched to this UGenInput. When this input is ticked, it will tick the incoming UGen and store the result in its last values.

getInputType ( )   Returns the InputType of this UGenInput.

getLastValue ( )   Returns the first value in the array of last values.

getLastValues ( )   Access the last values generated by this input.

getOuterUGen ( )   The outer UGen is the UGen that owns this input. For instance, calling this on the frequency UGenInput member of an Oscil will return the Oscil.

isPatched ( )   Returns true if a UGen is patched to this UGenInput.

printInput ( )   Print information about this UGenInput (for debugging)

setChannelCount ( )   Set the number of channels this input should generate. This will be called by the owning UGen if this input is an AUDIO input.

setIncomingUGen ( )   This method is called when a UGen is patched to this input. Typically you will not call this method directly, use UGen's patch method instead.

setLastValue ( )   Sets all values in the last values array to the provided value.

Usage Web & Application
Related