AudioOutput

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ddf.minim
Class AudioOutput

java.lang.Object
  ddf.minim.Controller
      ddf.minim.AudioSource
          ddf.minim.AudioOutput

All Implemented Interfaces:: Effectable, Polyphonic, Recordable

public class AudioOutput
extends AudioSource
implements Polyphonic
extends AudioSource
implements Polyphonic

An AudioOutput is used to generate audio with AudioSignals. Well, strictly speaking, the AudioSynthesizer it is constructed with generates the signals and AudioOutput merely delegates to the synth when signals are added. You can get an AudioOutput from Minim by calling one of the getLineOut methods.

Author:: Damien Di Fede

Field Summary
`Summer`	`bus`
`NoteManager`	`noteManager`

Fields inherited from class ddf.minim.AudioSource
`left, mix, right`

Fields inherited from class ddf.minim.Controller
`BALANCE, GAIN, MUTE, PAN, SAMPLE_RATE, VOLUME`

Constructor Summary
`AudioOutput(AudioOut synthesizer)` Constructs an `AudioOutput` that will subscribe its buffers to `synthesizer` and be able to control the `DataLine` the synthesizer uses for output.

Method Summary
`void`	`addSignal(AudioSignal signal)` Adds an signal to the signals chain.
`void`	`clearSignals()` Removes all signals from the signal chain.
`void`	`disableSignal(AudioSignal signal)` Disables `signal` if it is in the chain.
`void`	`disableSignal(int i)` disables the `i`^th signal in the signal chain.
`void`	`enableSignal(AudioSignal signal)` Enables `signal` if it is in the chain.
`void`	`enableSignal(int i)` Enables the `i`^th signal in the signal chain.
`AudioSignal`	`getSignal(int i)` Returns the `i^th` signal in the signal chain.
`boolean`	`hasSignal(AudioSignal signal)`
`boolean`	`isEnabled(AudioSignal signal)` Returns true if `signal` is in the chain and is also enabled.
`boolean`	`isSounding()` Returns true if at least one signal in the chain is enabled.
`void`	`noSound()` Disables all signals currently attached to this.
`void`	`pauseNotes()`
`void`	`playNote()`
`void`	`playNote(float hz)`
`void`	`playNote(float startTime, float hz)`
`void`	`playNote(float startTime, float duration, float hz)`
`void`	`playNote(float startTime, float duration, Instrument instrument)` Play a note startTime seconds from now, for the given duration, using the given instrument.
`void`	`playNote(float startTime, float duration, java.lang.String pitchName)`
`void`	`playNote(float startTime, java.lang.String pitchName)`
`void`	`playNote(java.lang.String pitchName)`
`void`	`removeSignal(AudioSignal signal)` Removes `signal` from the signals chain.
`AudioSignal`	`removeSignal(int i)` Removes and returns the `i^th` signal in the signal chain.
`void`	`resumeNotes()`
`void`	`setDurationFactor(float durationFactor)`
`void`	`setNoteOffset(float noteOffset)`
`void`	`setTempo(float tempo)`
`int`	`signalCount()` Returns the number of signals in the chain.
`void`	`sound()` Enables all signals currently attached to this.

Methods inherited from class ddf.minim.AudioSource
`addEffect, addListener, bufferSize, clearEffects, close, disableEffect, disableEffect, effectCount, effects, enableEffect, enableEffect, getEffect, getFormat, hasEffect, isEffected, isEnabled, noEffects, removeEffect, removeEffect, removeListener, sampleRate, type`

Methods inherited from class ddf.minim.Controller
`balance, gain, getBalance, getControl, getControls, getGain, getPan, getVolume, hasControl, isMuted, mute, pan, printControls, setBalance, setGain, setPan, setVolume, shiftBalance, shiftGain, shiftPan, shiftVolume, unmute, volume`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

noteManager

public final NoteManager noteManager

bus

public final Summer bus

Constructor Detail

AudioOutput

public AudioOutput(AudioOut synthesizer)

Constructs an AudioOutput that will subscribe its buffers to synthesizer and be able to control the DataLine the synthesizer uses for output. If the synth does not have an associated DataLine, then calls to Controller's methods will result in a NullPointerException.

Parameters:: synthesizer - the AudioSynthesizer to subscribe to

Method Detail