org.openimaj.audio.reader

Class OneSecondClipReader

java.lang.Object

org.openimaj.audio.reader.OneSecondClipReader

All Implemented Interfaces:

InputStreamObjectReader<List<SampleBuffer>>, ObjectReader<List<SampleBuffer>,InputStream>

public class OneSecondClipReader
extends Object
implements InputStreamObjectReader<List<SampleBuffer>>

This class reads an input stream that contains audio data, and returns a list of SampleBuffers that each contain 1 second of audio. The number of samples in each sample buffer may not be the same, as the length of the buffers is calculated from the format of the audio in the stream.

Version:

$Author$, $Revision$, $Date$

Author:

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

Created:

7 May 2013

Constructor Summary

Constructors

Constructor and Description
OneSecondClipReader()

Method Summary

Modifier and Type	Method and Description
boolean	canRead(InputStream stream, String name) Returns true if the stream can be read, or false otherwise.
List<SampleBuffer>	read(InputStream stream) Read an object from the source

Methods inherited from class java.lang.Object

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

Constructor Detail

OneSecondClipReader

public OneSecondClipReader()

Method Detail

read

public List<SampleBuffer> read(InputStream stream)
                        throws IOException

Read an object from the source

Specified by:

read in interface ObjectReader<List<SampleBuffer>,InputStream>

Parameters:

stream - the source

Returns:

the object

Throws:

IOException - if an error occurs

See Also:

ObjectReader.read(java.lang.Object)

canRead

public boolean canRead(InputStream stream,
                       String name)

Returns true if the stream can be read, or false otherwise.

Typically implementations will read just the first few bytes from the stream to determine if the data can be read. This method is not normally called directly; rather, IOUtils.canRead(InputStreamObjectReader, java.io.BufferedInputStream, String) should be used instead as it is capable of resetting the stream to its initial condition.

Specified by:

canRead in interface InputStreamObjectReader<List<SampleBuffer>>

Specified by:

canRead in interface ObjectReader<List<SampleBuffer>,InputStream>

Parameters:

stream - the input stream

name - the name of the file behind the stream (can be null).

Returns:

true if this InputStreamObjectReader can read the stream; false otherwise.

See Also:

InputStreamObjectReader.canRead(java.io.InputStream, java.lang.String)