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

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

Fields

Modifier and Type	Field and Description
AudioBuffer	left The AudioBuffer containing the left channel samples.
AudioBuffer	mix The AudioBuffer containing the mix of the left and right channels.
AudioBuffer	right The AudioBuffer containing the right channel samples.

Fields inherited from class ddf.minim.Controller

BALANCE, GAIN, MUTE, PAN, SAMPLE_RATE, VOLUME

Constructor Summary

Constructors

Constructor and Description
AudioSource(ddf.minim.spi.AudioOut istream) Constructs an AudioSource that will subscribe to the samples in stream.

Method Summary

Modifier and Type	Method and Description
void	addEffect(AudioEffect effect) Deprecated.
void	addListener(AudioListener listener) Add an AudioListener to this sound generating object, which will have its samples method called every time this object generates a new buffer of samples.
int	bufferSize() The internal buffer size of this sound object.
void	clearEffects() Deprecated.
void	close() Closes this source, making it unavailable.
void	disableEffect(AudioEffect effect) Deprecated.
void	disableEffect(int i) Deprecated.
int	effectCount() Deprecated.
void	effects() Deprecated.
void	enableEffect(AudioEffect effect) Deprecated.
void	enableEffect(int i) Deprecated.
AudioEffect	getEffect(int i) Deprecated.
javax.sound.sampled.AudioFormat	getFormat() Returns an AudioFormat object that describes the audio properties of this sound generating object.
boolean	hasEffect(AudioEffect e) Deprecated.
boolean	isEffected() Deprecated.
boolean	isEnabled(AudioEffect effect) Deprecated.
void	noEffects() Deprecated.
void	removeEffect(AudioEffect effect) Deprecated.
AudioEffect	removeEffect(int i) Deprecated.
void	removeListener(AudioListener listener) Removes an AudioListener that was previously added to this sound object.
float	sampleRate() Returns the sample rate of this sound object.
int	type() The type is an int describing the number of channels this sound object has.

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 AudioBuffer containing the left channel samples. If this is a mono sound, it contains the single channel of audio.

right

public final AudioBuffer right

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

mix

public final AudioBuffer mix

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

Constructor Detail

AudioSource

public AudioSource(ddf.minim.spi.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 this source, making it unavailable.

addEffect

public void addEffect(AudioEffect effect)

Deprecated.

Description copied from interface: Effectable

Adds an effect to the effects chain.

Specified by:

addEffect in interface Effectable

Parameters:

effect - the AudioEffect to add

clearEffects

public void clearEffects()

Deprecated.

Description copied from interface: Effectable

Removes all effects from the effect chain.

Specified by:

clearEffects in interface Effectable

disableEffect

public void disableEffect(int i)

Deprecated.

Description copied from interface: Effectable

disables the i^th effect in the effect chain.

Specified by:

disableEffect in interface Effectable

Parameters:

i - the index of the effect to disable

disableEffect

public void disableEffect(AudioEffect effect)

Deprecated.

Description copied from interface: Effectable

Disables effect if it is in the chain.

Specified by:

disableEffect in interface Effectable

Parameters:

effect - the AudioEffect to disable

effectCount

public int effectCount()

Deprecated.

Description copied from interface: Effectable

Returns the number of effects in the chain.

Specified by:

effectCount in interface Effectable

Returns:

the number of effects in the chain

effects

public void effects()

Deprecated.

Description copied from interface: Effectable

Enables all effects currently attached to this. If you want to enable only a single effect, use Effectable.enableEffect(int).

Specified by:

effects in interface Effectable

hasEffect

public boolean hasEffect(AudioEffect e)

Deprecated.

Description copied from interface: Effectable

Returns true if effect is in the chain.

Specified by:

hasEffect in interface Effectable

Parameters:

e - the effec to check for

Returns:

true if effect is attached to this

enableEffect

public void enableEffect(int i)

Deprecated.

Description copied from interface: Effectable

Enables the i^th effect in the effect chain.

Specified by:

enableEffect in interface Effectable

Parameters:

i - the index of the effect to enable

enableEffect

public void enableEffect(AudioEffect effect)

Deprecated.

Description copied from interface: Effectable

Enables effect if it is in the chain.

Specified by:

enableEffect in interface Effectable

Parameters:

effect - the AudioEffect to enable

getEffect

public AudioEffect getEffect(int i)

Deprecated.

Description copied from interface: Effectable

Returns the ith effect in the effect chain. This method is not required to do bounds checking and may throw an ArrayOutOfBoundsException if i is larger than Effectable.effectCount().

Specified by:

getEffect in interface Effectable

Parameters:

i - which effect to return

Returns:

the requested effect

isEffected

public boolean isEffected()

Deprecated.

Description copied from interface: Effectable

Returns true if at least one effect in the chain is enabled.

Specified by:

isEffected in interface Effectable

Returns:

true if at least one effect in the effects chain is enabled

isEnabled

public boolean isEnabled(AudioEffect effect)

Deprecated.

Description copied from interface: Effectable

Returns true if effect is in the chain and is also enabled.

Specified by:

isEnabled in interface Effectable

Parameters:

effect - the AudioEffect to check the status of

Returns:

true if effect is in the chain and is enabled

noEffects

public void noEffects()

Deprecated.

Description copied from interface: Effectable

Disables all effects currently attached to this. If you want to disable only a single effect, use Effectable.disableEffect(int).

Specified by:

noEffects in interface Effectable

removeEffect

public void removeEffect(AudioEffect effect)

Deprecated.

Description copied from interface: Effectable

Removes effect from the effects chain.

Specified by:

removeEffect in interface Effectable

Parameters:

effect - the AudioEffect to remove

removeEffect

public AudioEffect removeEffect(int i)

Deprecated.

Description copied from interface: Effectable

Removes and returns the ith effect in the effect chain.

Specified by:

removeEffect in interface Effectable

Parameters:

i - which effect to remove

Returns:

the removed AudioEffect

addListener

public void addListener(AudioListener listener)

Add an AudioListener to this sound generating object, which will have its samples method called every time this object generates a new buffer of samples.

Specified by:

addListener in interface Recordable

Parameters:

listener - the AudioListener that will listen to this

bufferSize

public int bufferSize()

The internal buffer size of this sound object. The left, right, and mix AudioBuffers of this object will be this large, and sample buffers passed to AudioListeners added to this object will be this large.

Specified by:

bufferSize in interface Recordable

Returns:

int: the internal buffer size of this sound object, in sample frames.

getFormat

public javax.sound.sampled.AudioFormat getFormat()

Returns an AudioFormat object that describes the audio properties of this sound generating object. This is often useful information when doing sound analysis or some synthesis, but typically you will not need to know about the specific format.

Specified by:

getFormat in interface Recordable

Returns:

an AudioFormat describing this sound object.

removeListener

public void removeListener(AudioListener listener)

Removes an AudioListener that was previously added to this sound object.

Specified by:

removeListener in interface Recordable

Parameters:

listener - the AudioListener that should stop listening to this

type

public int type()

The type is an int describing the number of channels this sound object has.

Specified by:

type in interface Recordable

Returns:

Minim.MONO if this is mono, Minim.STEREO if this is stereo

sampleRate

public float sampleRate()

Returns the sample rate of this sound object.

Specified by:

sampleRate in interface Recordable

Returns:

the sample rate of this sound object.