| |
|
| java.lang.Object
 java.io.InputStream
javax.sound.sampled.AudioInputStream
| AudioInputStream | | public class AudioInputStream extends InputStream (Code) | | 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:
- obtain an
audio input stream from an external audio file, stream, or URL
- write an external file from an audio input stream
- convert an audio input stream to a different audio format
author:
David Rivas
author:
Kara Kytle
author:
Florian Bomers
version:
1.40, 07/05/05
See Also: AudioSystem
See Also: Clip.open(AudioInputStream)
See Also: Clip.open(AudioInputStream)
since:
1.3 |
| Field Summary | |
| protected AudioFormat | format
The format of the audio data contained in the stream. | | protected long | frameLength
This stream's length, in sample frames. | | protected long | framePos
The current position in this stream, in sample frames (zero-based). | | protected int | frameSize
The size of each frame, in bytes. |
| Constructor Summary | |
| 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. | | public | AudioInputStream(TargetDataLine line)
Constructs an audio input stream that reads its data from the target
data line indicated. |
| Method Summary | |
| public int | available()
Returns the maximum number of bytes that can be read (or skipped over) from this
audio input stream without blocking. | | public void | close()
Closes this audio input stream and releases any system resources associated
with the stream. | | public 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 void | mark(int readlimit)
Marks the current position in this audio input stream. | | public boolean | markSupported()
Tests whether this audio input stream supports the mark and
reset methods. | | public int | read()
Reads the next byte of data from the audio input stream. | | public int | read(byte[] b)
Reads some number of bytes from the audio input stream and stores them into
the buffer array b. | | public 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. | | public void | reset()
Repositions this audio input stream to the position it had at the time its
mark method was last invoked. | | public long | skip(long n)
Skips over and discards a specified number of bytes from this
audio input stream. |
| format | | protected AudioFormat format(Code) | | The format of the audio data contained in the stream.
|
| frameLength | | protected long frameLength(Code) | | This stream's length, in sample frames.
|
| framePos | | protected long framePos(Code) | | The current position in this stream, in sample frames (zero-based).
|
| frameSize | | protected int frameSize(Code) | | The size of each frame, in bytes.
|
| AudioInputStream | | public AudioInputStream(InputStream stream, AudioFormat format, long length)(Code) | | Constructs an audio input stream that has the requested format and length in sample frames,
using audio data from the specified input stream.
Parameters:
stream - the stream on which this AudioInputStreamobject is based
Parameters:
format - the format of this stream's audio data
Parameters:
length - the length in sample frames of the data in this stream |
| AudioInputStream | | public AudioInputStream(TargetDataLine line)(Code) | | 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.
Parameters:
line - the target data line from which this stream obtains its data.
See Also: AudioSystem.NOT_SPECIFIED |
| available | | public int available() throws IOException(Code) | | 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.
the number of bytes that can be read from this audio input stream without blocking
throws:
IOException - if an input or output error occurs
See Also: AudioInputStream.read(byte[],int,int)
See Also: AudioInputStream.read(byte[])
See Also: AudioInputStream.read()
See Also: AudioInputStream.skip |
| close | | public void close() throws IOException(Code) | | Closes this audio input stream and releases any system resources associated
with the stream.
throws:
IOException - if an input or output error occurs |
| getFormat | | public AudioFormat getFormat()(Code) | | Obtains the audio format of the sound data in this audio input stream.
an audio format object describing this stream's format |
| getFrameLength | | public long getFrameLength()(Code) | | Obtains the length of the stream, expressed in sample frames rather than bytes.
the length in sample frames |
| markSupported | | public boolean markSupported()(Code) | | Tests whether this audio input stream supports the mark and
reset methods.
true if this stream supports the markand reset methods; false otherwise
See Also: AudioInputStream.mark
See Also: AudioInputStream.reset |
| read | | public int read(byte[] b) throws IOException(Code) | | 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.
Parameters:
b - the buffer into which the data is read the total number of bytes read into the buffer, or -1 if thereis no more data because the end of the stream has been reached
throws:
IOException - if an input or output error occurs
See Also: AudioInputStream.read(byte[],int,int)
See Also: AudioInputStream.read()
See Also: AudioInputStream.available |
| read | | public int read(byte[] b, int off, int len) throws IOException(Code) | | 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
Parameters:
off - the offset, from the beginning of array b, at whichthe data will be written
Parameters:
len - the maximum number of bytes to read the total number of bytes read into the buffer, or -1 if thereis no more data because the end of the stream has been reached
throws:
IOException - if an input or output error occurs
See Also: AudioInputStream.read(byte[])
See Also: AudioInputStream.read()
See Also: AudioInputStream.skip
See Also: AudioInputStream.available |
|
|
|