ddf.minim.ugens

Class LiveInput

java.lang.Object

ddf.minim.ugens.UGen

ddf.minim.ugens.LiveInput

public class LiveInput
extends UGen

LiveInput is a way to wrap an input stream with the UGen interface so that you can easily route incoming audio through a UGen graph. You can get an AudioStream that is reading an input from Minim by calling Minim.getInputStream.

Author:

Damien Di Fede

Nested Class Summary

Nested classes/interfaces inherited from class ddf.minim.ugens.UGen

UGen.InputType, UGen.UGenInput

Constructor Summary

Constructors

Constructor and Description
LiveInput(AudioStream inputStream) Constructs a LiveInput that will read from inputStream.

Method Summary

Modifier and Type	Method and Description
void	close() Calling close will close the AudioStream that this wraps, which is proper cleanup for using the stream.
protected void	uGenerate(float[] channels) Implement this method when you extend UGen.

Methods inherited from class ddf.minim.ugens.UGen

addInput, getLastValues, patch, patch, patch, printInputs, removeInput, sampleRate, sampleRateChanged, setAudioChannelCount, setSampleRate, tick, unpatch, unpatch

Methods inherited from class java.lang.Object

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

Constructor Detail

LiveInput

public LiveInput(AudioStream inputStream)

Constructs a LiveInput that will read from inputStream.

Parameters:

inputStream -

Method Detail

close

public void close()

Calling close will close the AudioStream that this wraps, which is proper cleanup for using the stream.

uGenerate

protected void uGenerate(float[] channels)

Description copied from class: UGen

Implement this method when you extend UGen. It will be called when your UGen needs to generate one sample frame of audio. It is expected that you will assign values to the array and not simply modify the existing values. In the case where you write a UGen that takes audio input and modifies it, the pattern to follow is to have the first UGenInput you create be your audio input and then in uGenerate you will use the getLastValues method of your audio UGenInput to retrieve the audio you want to modify, which you will then modify however you need to, assigning the result to the values in channels.

Specified by:

uGenerate in class UGen

Parameters:

channels - an array representing one sample frame.