org.openimaj.audio

Class AudioLooper

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.AudioLooper

All Implemented Interfaces:

Iterable<SampleChunk>

public class AudioLooper
extends AudioStream

A class used to force a specific number of loops of an audio stream. The class can buffer the stream, if you consider that it will be small enough to fit within memory, otherwise it will reset the audio stream at each loop.

Author:

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

Created:

27 Nov 2011

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
AudioLooper(AudioStream stream, int nLoops) Create a new looper that will loop the given stream the given number of times.
AudioLooper(AudioStream stream, int nLoops, boolean cacheStream) Create a new looper that will loop the given stream the given number of times.

Method Summary

Modifier and Type	Method and Description
long	getLength() Returns the length of the audio stream in milliseconds.
SampleChunk	nextSampleChunk() Retrieve the next SampleChunk from the audio stream.
void	reset() Reset the audio stream.

Methods inherited from class org.openimaj.audio.AudioStream

iterator, 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

Constructor Detail

AudioLooper

public AudioLooper(AudioStream stream,
                   int nLoops)

Create a new looper that will loop the given stream the given number of times.

Parameters:

stream - The stream to loop

nLoops - The number of times to loop the stream

AudioLooper

public AudioLooper(AudioStream stream,
                   int nLoops,
                   boolean cacheStream)

Create a new looper that will loop the given stream the given number of times. Whether the stream is cached or not is able to be specified.

Parameters:

stream - The stream to loop

nLoops - The number of loops to do

cacheStream - Whether to cache the stream or not

Method Detail

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()

reset

public void reset()

Reset the audio stream.

Specified by:

reset in class AudioStream

See Also:

AudioStream.reset()

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()