org.openimaj.audio

Class JavaSoundAudioGrabber

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.AudioGrabber

org.openimaj.audio.JavaSoundAudioGrabber

All Implemented Interfaces:

Iterable<SampleChunk>, Runnable

public class JavaSoundAudioGrabber
extends AudioGrabber

Audio grabber that uses the Java Sound API as a sound source.

Author:

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

Created:

28 Oct 2011

Field Summary

Fields inherited from class org.openimaj.audio.AudioGrabber

listeners

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
JavaSoundAudioGrabber(AudioFormat format) Default constructor

Method Summary

Modifier and Type	Method and Description
protected void	fireAudioAvailable() Fire the event and audio is now available
long	getLength() Returns the length of the audio stream in milliseconds.
boolean	isStopped() Whether the stream is stopped or not.
SampleChunk	nextSampleChunk() Retrieve the next SampleChunk from the audio stream.
void	run() Start the stream grabbing.
void	setFormat(AudioFormat format) Set the audio format of this audio object.
void	setMaxBufferSize(int maxBufferSize) Set the maximum size buffer to be returned.
void	stop() Stop the stream grabbing

Methods inherited from class org.openimaj.audio.AudioGrabber

addAudioGrabberListener, removeAudioGrabberListener, reset

Methods inherited from class org.openimaj.audio.AudioStream

iterator, seek

Methods inherited from class org.openimaj.audio.Audio

getFormat

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

Constructor Detail

JavaSoundAudioGrabber

public JavaSoundAudioGrabber(AudioFormat format)

Default constructor

Parameters:

format - The format to attempt to open the sound line

Method Detail

run

public void run()

Start the stream grabbing.

Specified by:

run in interface Runnable

Specified by:

run in class AudioGrabber

See Also:

AudioGrabber.run()

stop

public void stop()

Stop the stream grabbing

Specified by:

stop in class AudioGrabber

See Also:

AudioGrabber.stop()

isStopped

public boolean isStopped()

Whether the stream is stopped or not.

Specified by:

isStopped in class AudioGrabber

Returns:

TRUE if the stream is stopped; FALSE otherwise

See Also:

AudioGrabber.isStopped()

fireAudioAvailable

protected void fireAudioAvailable()

Fire the event and audio is now available

Specified by:

fireAudioAvailable in class AudioGrabber

setFormat

public void setFormat(AudioFormat format)

Set the audio format of this audio object.

Overrides:

setFormat in class Audio

Parameters:

format - The format of the audio data

See Also:

Audio.setFormat(org.openimaj.audio.AudioFormat)

nextSampleChunk

public SampleChunk nextSampleChunk()

Retrieve the next SampleChunk from the audio stream.

Specified by:

nextSampleChunk in class AudioStream

Returns:

The next sample chunk in the audio stream.

See Also:

AudioStream.nextSampleChunk()

setMaxBufferSize

public void setMaxBufferSize(int maxBufferSize)

Set the maximum size buffer to be returned.

Parameters:

maxBufferSize -

getLength

public long getLength()

Returns the length of the audio stream in milliseconds. If the length is unknown (for a live stream for example), then this method should return -1.

Specified by:

getLength in class AudioStream

Returns:

The length in milliseconds, or -1

See Also:

AudioStream.getLength()