Class AudioInputStreamDecoder

java.lang.Object

net.avadeaux.klipspringer.codec.AudioInputStreamDecoder

All Implemented Interfaces:

Closeable, AutoCloseable, AudioDecoder

public class AudioInputStreamDecoder
extends Object
implements AudioDecoder

Audio decoder that reads from an AudioInputStream. This allows obtaining an AudioDecoder for any format supported by the standard Java Sound system by wrapping a stream obtained for instance by AudioSystem.getAudioInputStream(File).

Nested Class Summary

Nested classes/interfaces inherited from interface net.avadeaux.klipspringer.codec.AudioDecoder

AudioDecoder.PictureTarget, AudioDecoder.Target

Constructor Summary

Constructors

Constructor	Description
AudioInputStreamDecoder(AudioInputStream stream, AudioDecoder.Target target)	Sets up for sending data from the given AudioInputStream to the given target.

Method Summary

Modifier and Type	Method	Description
void	close()	See Closeable.close().
boolean	decodeAll(long fromSampleNo)	Sends audio data to the target, one block at the time, starting from the given sample frame (zero to start at the beginning).
void	decodeMetadata()	Decodes metadata and sends it to the target, without writing any blocks.
boolean	reusable()	Returns false, indicating that decodeAll can be called at most once.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.avadeaux.klipspringer.codec.AudioDecoder

quality

Constructor Details

AudioInputStreamDecoder

public AudioInputStreamDecoder(AudioInputStream stream,
 AudioDecoder.Target target)

Sets up for sending data from the given AudioInputStream to the given target.

Method Details

reusable

public boolean reusable()

Returns false, indicating that decodeAll can be called at most once.

Specified by:

reusable in interface AudioDecoder

close

public void close()
           throws IOException

Description copied from interface: AudioDecoder

See Closeable.close().

Specified by:

close in interface AudioDecoder

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

decodeMetadata

public void decodeMetadata()
                    throws IOException

Description copied from interface: AudioDecoder

Decodes metadata and sends it to the target, without writing any blocks. Must be called at most once, and never after decodeAll. If this is not called, metadata gets sent to the target by decodeAll.

Specified by:

decodeMetadata in interface AudioDecoder

Throws:

IOException

decodeAll

public boolean decodeAll(long fromSampleNo)
                  throws IOException

Description copied from interface: AudioDecoder

Sends audio data to the target, one block at the time, starting from the given sample frame (zero to start at the beginning). If AudioDecoder.decodeMetadata() has not been called, metadata is sent to the target before the first block. Returns when the input is exhausted (in which case it returns true) or the target aborts decoding by returning false from write (in which case this method returns false). In either case, if this decoder is AudioDecoder.reusable(), decodeAll may be called again to once more decode part of the same file.

Specified by:

decodeAll in interface AudioDecoder

Throws:

IOException