Home » openjdk-7 » javax.sound » sampled » [javadoc | source]
public class: AudioInputStream [javadoc | source]

All Implemented Interfaces:

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:

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  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(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.
    Also see:
 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 based
    format - the format of this stream's audio data
    length - the length in sample frames of the data in this stream
Method from javax.sound.sampled.AudioInputStream Summary:
available,   close,   getFormat,   getFrameLength,   mark,   markSupported,   read,   read,   read,   reset,   skip
Methods from java.io.InputStream:
available,   close,   mark,   markSupported,   read,   read,   read,   reset,   skip
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.sound.sampled.AudioInputStream Detail:
 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.
 public  void close() throws IOException 
    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() 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.
 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.

 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.

 public  void reset() throws IOException 
    Repositions this audio input stream to the position it had at the time its mark method was last invoked.
 public long skip(long n) throws IOException 
    Skips over and discards a specified number of bytes from this audio input stream.