public class AudioInputStream extends InputStream
An audio input stream is an input stream with a specified audio format and length. The length is expressed in sample frames, not bytes. Several methods are provided for reading a certain number of bytes from the stream, or an unspecified number of bytes. The audio input stream keeps track of the last byte that was read. You can skip over an arbitrary number of bytes to get to a later position for reading. An audio input stream may support marks. When you set a mark, the current position is remembered so that you can return to it later.
The AudioSystem class includes many methods that manipulate AudioInputStream objects. For example, the methods let you:
AudioSystem, Clip.open(AudioInputStream)
protected AudioFormat format
The format of the audio data contained in the stream.
protected long frameLength
This stream's length, in sample frames.
protected int frameSize
The size of each frame, in bytes.
protected long framePos
The current position in this stream, in sample frames (zero-based).
public AudioInputStream(InputStream stream,
AudioFormat format,
long length) Constructs an audio input stream that has the requested format and length in sample frames, using audio data from the specified input stream.
stream - the stream on which this AudioInputStream object is basedformat - the format of this stream's audio datalength - the length in sample frames of the data in this streampublic AudioInputStream(TargetDataLine line)
Constructs an audio input stream that reads its data from the target data line indicated. The format of the stream is the same as that of the target data line, and the length is AudioSystem#NOT_SPECIFIED.
line - the target data line from which this stream obtains its data.AudioSystem.NOT_SPECIFIEDpublic AudioFormat getFormat()
Obtains the audio format of the sound data in this audio input stream.
public long getFrameLength()
Obtains the length of the stream, expressed in sample frames rather than bytes.
public int read()
throws IOException Reads the next byte of data from the audio input stream. The audio input stream's frame size must be one byte, or an IOException will be thrown.
read in class InputStream
IOException - if an input or output error occursread(byte[], int, int), read(byte[]),
public int read(byte[] b)
throws IOException Reads some number of bytes from the audio input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
This method will always read an integral number of frames. If the length of the array is not an integral number of frames, a maximum of b.length - (b.length % frameSize)
bytes will be read.
read in class InputStream
b - the buffer into which the data is readIOException - if an input or output error occursread(byte[], int, int), read(), available()
public int read(byte[] b,
int off,
int len)
throws 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.
read in class InputStream
b - the buffer into which the data is readoff - the offset, from the beginning of array b, at which the data will be writtenlen - the maximum number of bytes to readIOException - if an input or output error occursread(byte[]), read(), skip(long), available()
public long skip(long n)
throws IOException Skips over and discards a specified number of bytes from this audio input stream.
skip in class InputStream
n - the requested number of bytes to be skippedIOException - if an input or output error occursread(), available()
public int available()
throws IOException Returns the maximum number of bytes that can be read (or skipped over) from this audio input stream without blocking. This limit applies only to the next invocation of a read or skip method for this audio input stream; the limit can vary each time these methods are invoked. Depending on the underlying stream,an IOException may be thrown if this stream is closed.
available in class InputStream
IOException - if an input or output error occursread(byte[], int, int), read(byte[]), read(), skip(long)
public void close()
throws IOException Closes this audio input stream and releases any system resources associated with the stream.
close in interface Closeable
close in interface AutoCloseable
close in class InputStream
IOException - if an input or output error occurspublic void mark(int readlimit)
Marks the current position in this audio input stream.
mark in class InputStream
readlimit - the maximum number of bytes that can be read before the mark position becomes invalid.reset(), markSupported()
public void reset()
throws IOException Repositions this audio input stream to the position it had at the time its mark method was last invoked.
reset in class InputStream
IOException - if an input or output error occurs.mark(int), markSupported()
public boolean markSupported()
Tests whether this audio input stream supports the mark and reset methods.
markSupported in class InputStream
true if this stream supports the mark and reset methods; false otherwisemark(int), reset()
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.