be.tarsos.dsp.io

Interface TarsosDSPAudioInputStream

All Known Implementing Classes:

JVMAudioInputStream, UniversalAudioInputStream

public interface TarsosDSPAudioInputStream

Decouples the audio input stream

Author:

Joren Six

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this audio input stream and releases any system resources associated with the stream.
TarsosDSPAudioFormat	getFormat()
long	getFrameLength()
int	read(byte[] b, int off, int len) Reads up to a specified maximum number of bytes of data from the audio stream, putting them into the given byte array.
long	skip(long bytesToSkip) Skip a number of bytes before reading the remaining bytes.

Method Detail

skip

long skip(long bytesToSkip)
          throws java.io.IOException

Skip a number of bytes before reading the remaining bytes.

Parameters:

bytesToSkip - The number of bytes to skip.

Returns:

The number of bytes skipped.

Throws:

java.io.IOException - If the underlying if an input or output error occurs #see read

read

int read(byte[] b,
       int off,
       int len)
         throws java.io.IOException

Reads up to a specified maximum number of bytes of data from the audio stream, putting them into the given byte array.

This method will always read an integral number of frames. If len does not specify an integral number of frames, a maximum of len - (len % frameSize) bytes will be read.

Parameters:

b - the buffer into which the data is read

off - the offset, from the beginning of array b, at which the data will be written

len - the maximum number of bytes to read

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached

Throws:

java.io.IOException - if an input or output error occurs

See Also:

skip(long)

close

void close()
           throws java.io.IOException

Closes this audio input stream and releases any system resources associated with the stream.

Throws:

java.io.IOException - if an input or output error occurs

getFormat

TarsosDSPAudioFormat getFormat()

Returns:

The format of the underlying audio

getFrameLength

long getFrameLength()