net.beadsproject.beads.ugens

Class SignalReporter

java.lang.Object

net.beadsproject.beads.core.Bead

net.beadsproject.beads.core.UGen

net.beadsproject.beads.ugens.SignalReporter

public class SignalReporter
extends UGen

An easy way to monitor a signal; useful for debugging signal chains.

Version:

0.9.3

Author:

Benito Crawford

Nested Class Summary

Nested classes/interfaces inherited from class net.beadsproject.beads.core.UGen

UGen.OutputInitializationRegime, UGen.OutputPauseRegime

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name

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

bufferSize, bufIn, bufOut, context, ins, outputInitializationRegime, outputPauseRegime, outs

Constructor Summary

Constructors

Constructor and Description
SignalReporter(AudioContext context, float reportInterval, java.lang.String name) Constructor for a SignalReporter that calls Object.notify() at the specified interval, with the specified name.

Method Summary

Modifier and Type	Method and Description
void	calculateBuffer() Called by the signal chain to update this UGen's ouput data.
float	getInterval() Gets the report interval.
void	notify(long count, float value) Called regularly according to the interval length; by default, it outputs a report (System.out.println)that includes the name, report #, and first value of the current input signal frame.
void	resetCount() Resets the current report # to 0.
void	setInterval(float reportInterval) Sets the report interval.

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

Field Detail

name

protected java.lang.String name

Constructor Detail

SignalReporter

public SignalReporter(AudioContext context,
                      float reportInterval,
                      java.lang.String name)

Constructor for a SignalReporter that calls Object.notify() at the specified interval, with the specified name.

Parameters:

context - The audio context.

reportInterval - The interval between reports, in milliseconds.

name - The SignalReporter name (used in reports).

Method Detail

setInterval

public void setInterval(float reportInterval)

Sets the report interval.

Parameters:

reportInterval - The report interval in milliseconds.

getInterval

public float getInterval()

Gets the report interval.

Returns:

The report interval in milliseconds.

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

notify

public void notify(long count,
                   float value)

Called regularly according to the interval length; by default, it outputs a report (System.out.println)that includes the name, report #, and first value of the current input signal frame. This can be overridden to provide other functionality.

Parameters:

count - The current report #.

value - The first value in the input signal frame.

resetCount

public void resetCount()

Resets the current report # to 0.