AudioSource

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 AudioSource

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

All Implemented Interfaces:: Effectable, Recordable

Direct Known Subclasses:: AudioInput, AudioOutput, AudioPlayer, AudioSample

public class AudioSource
extends Controller
implements Effectable, Recordable
extends Controller
implements Effectable, Recordable

An AudioSource is a kind of wrapper around an AudioStream. An AudioSource will add its AudioBuffers as listeners on the stream so that you can access the stream's samples without having to implement AudioListener yourself. It also provides the Effectable and Recordable interface. Because an AudioStream must be closed when you are finished with it, you must remember to call close() on any AudioSources you obtain from Minim, such as AudioInputs, AudioOutputs, and AudioPlayers.

Author:: Damien Di Fede

Field Summary
`AudioBuffer`	`left` The buffer containing the left channel samples.
`AudioBuffer`	`mix` The buffer containing the mix of the left and right channels.
`AudioBuffer`	`right` The buffer containing the right channel samples.

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

Constructor Summary
`AudioSource(AudioOut istream)` Constructs an `AudioSource` that will subscribe to the samples in `stream`.

Method Summary
`void`	`addEffect(AudioEffect effect)` Adds an effect to the effects chain.
`void`	`addListener(AudioListener listener)` Adds a listener who will be notified each time this receives or creates a new buffer of samples.
`int`	`bufferSize()` Returns the buffer size being used by this.
`void`	`clearEffects()` Removes all effects from the effect chain.
`void`	`close()` Closes the `AudioStream` this was constructed with.
`void`	`disableEffect(AudioEffect effect)` Disables `effect` if it is in the chain.
`void`	`disableEffect(int i)` disables the `i`^th effect in the effect chain.
`int`	`effectCount()` Returns the number of effects in the chain.
`void`	`effects()` Enables all effects currently attached to this.
`void`	`enableEffect(AudioEffect effect)` Enables `effect` if it is in the chain.
`void`	`enableEffect(int i)` Enables the `i`^th effect in the effect chain.
`AudioEffect`	`getEffect(int i)` Returns the `i^th` effect in the effect chain.
`javax.sound.sampled.AudioFormat`	`getFormat()` Returns the format of this recordable audio.
`boolean`	`hasEffect(AudioEffect e)` Returns true if `effect` is in the chain.
`boolean`	`isEffected()` Returns true if at least one effect in the chain is enabled.
`boolean`	`isEnabled(AudioEffect effect)` Returns true if `effect` is in the chain and is also enabled.
`void`	`noEffects()` Disables all effects currently attached to this.
`void`	`removeEffect(AudioEffect effect)` Removes `effect` from the effects chain.
`AudioEffect`	`removeEffect(int i)` Removes and returns the `i^th` effect in the effect chain.
`void`	`removeListener(AudioListener listener)` Removes the listener from the list of listeners.
`float`	`sampleRate()` Returns the sample rate of this recordable audio.
`int`	`type()` Returns either Minim.MONO or Minim.STEREO

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

left

public final AudioBuffer left

The buffer containing the left channel samples. If this is a mono AudioSource, it contains the single channel of audio.

right

public final AudioBuffer right

The buffer containing the right channel samples. If this is a mono AudioSource, right contains the same samples as left.

mix

public final AudioBuffer mix

The buffer containing the mix of the left and right channels. If this is a mono AudioSource, mix contains the same samples as left.

Constructor Detail

AudioSource

public AudioSource(AudioOut istream)

Constructs an AudioSource that will subscribe to the samples in stream. It is expected that the stream is using a DataLine for playback. If it is not, calls to Controller's methods will result in a NullPointerException.

Parameters:: istream - the AudioStream to subscribe to and wrap

Method Detail

close

public void close()

Closes the AudioStream this was constructed with.