org.openimaj.audio

Class AudioGrabber

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.AudioGrabber

All Implemented Interfaces:

Iterable<SampleChunk>, Runnable

Direct Known Subclasses:

JavaSoundAudioGrabber

public abstract class AudioGrabber
extends AudioStream
implements Runnable

An abstract class for objects that are able to act as audio grabbers. Audio grabbers should be able to provide streams of audio data, hence they extend the AudioStream abstract class. Obviously, if using an audio grabber in the context of an audio stream (for processing or whatever), it cannot be guaranteed that the audio grabber will buffer sampled between calls of AudioStream.nextSampleChunk().

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

28 Oct 2011

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AudioGrabberListener>	listeners A list of listeners for samples

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
AudioGrabber()

Method Summary

Modifier and Type	Method and Description
void	addAudioGrabberListener(AudioGrabberListener l) Add an audio grabber listener to this audio grabber.
protected abstract void	fireAudioAvailable() Fire the event and audio is now available
abstract boolean	isStopped() Whether the stream is stopped or not.
void	removeAudioGrabberListener(AudioGrabberListener l) Remove an audio grabber listener from this audio grabber.
void	reset() Does nothing by default for an audio grabber.
abstract void	run() Start the stream grabbing.
abstract void	stop() Stop the stream grabbing

Methods inherited from class org.openimaj.audio.AudioStream

getLength, iterator, nextSampleChunk, seek

Methods inherited from class org.openimaj.audio.Audio

getFormat, setFormat

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

listeners

protected List<AudioGrabberListener> listeners

A list of listeners for samples

Constructor Detail

AudioGrabber

public AudioGrabber()

Method Detail

run

public abstract void run()

Start the stream grabbing.

Specified by:

run in interface Runnable

See Also:

Runnable.run()

stop

public abstract void stop()

Stop the stream grabbing

isStopped

public abstract boolean isStopped()

Whether the stream is stopped or not.

Returns:

TRUE if the stream is stopped; FALSE otherwise

fireAudioAvailable

protected abstract void fireAudioAvailable()

Fire the event and audio is now available

addAudioGrabberListener

public void addAudioGrabberListener(AudioGrabberListener l)

Add an audio grabber listener to this audio grabber.

Parameters:

l - The listener to add.

removeAudioGrabberListener

public void removeAudioGrabberListener(AudioGrabberListener l)

Remove an audio grabber listener from this audio grabber.

Parameters:

l - The audio grabber listener to remove.

reset

public void reset()

Does nothing by default for an audio grabber.

Specified by:

reset in class AudioStream

See Also:

AudioStream.reset()