org.openimaj.audio

Class AudioStream

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

All Implemented Interfaces:

Iterable<SampleChunk>

Direct Known Subclasses:

AudioGrabber, AudioLooper, AudioMixer, AudioProcessor, MemoryAudioSource, Synthesizer, XuggleAudio

public abstract class AudioStream
extends Audio
implements Iterable<SampleChunk>

Represents an audio stream that can be read chunk-by-chunk.

Author:

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

Created:

8 Jun 2011

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
AudioStream()

Method Summary

Modifier and Type	Method and Description
abstract long	getLength() Returns the length of the audio stream in milliseconds.
Iterator<SampleChunk>	iterator()
abstract SampleChunk	nextSampleChunk() Retrieve the next SampleChunk from the audio stream.
abstract void	reset() Reset the audio stream.
void	seek(long timestamp) Seeks the audio to the given timestamp.

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

Constructor Detail

AudioStream

public AudioStream()

Method Detail

nextSampleChunk

public abstract SampleChunk nextSampleChunk()

Retrieve the next SampleChunk from the audio stream.

Returns:

The next sample chunk in the audio stream.

reset

public abstract void reset()

Reset the audio stream.

getLength

public abstract 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.

Returns:

The length in milliseconds, or -1

seek

public void seek(long timestamp)

Seeks the audio to the given timestamp. The timestamp of the audio should be checked after calling seek() as the seek method may not succeed if the stream does not support seeking.

Parameters:

timestamp - The timestamp to seek to

iterator

public Iterator<SampleChunk> iterator()

Specified by:

iterator in interface Iterable<SampleChunk>