Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.sound.sampled

Class AudioInputStream

Implemented Interfaces:
Closeable
public class AudioInputStream
extends InputStream
This is an InputStream which is specialized for reading audio files. In particular it only allows operations to act on a multiple of the audio stream's frame size.
Since:
1.3

Field Summary

protected AudioFormat
format
The format of the audio stream.
protected long
frameLength
The length of the audio stream in frames.
protected long
framePos
The current frame position, starting from frame zero.
protected int
frameSize
The size of a frame in bytes.

Constructor Summary

AudioInputStream(InputStream is, AudioFormat fmt, long length)
Create a new AudioInputStream given an underlying InputStream, the audio format, and the length of the data in frames.
AudioInputStream(TargetDataLine line)
Create a new AudioInputStream given a TargetDataLine.

Method Summary

int
available()
Return the number of bytes available to be read from the underlying stream.
void
close()
Close the stream.
AudioFormat
getFormat()
Get the format associated with this stream.
long
getFrameLength()
Get the length of this stream in frames.
void
mark(int limit)
boolean
markSupported()
Return true if the underlying stream supports mark and reset, false otherwise.
int
read()
Read a single byte from the underlying stream.
int
read(byte[] buf)
int
read(byte[] buf, int offset, int length)
void
reset()
long
skip(long n)

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

format

protected AudioFormat format
The format of the audio stream.

frameLength

protected long frameLength
The length of the audio stream in frames.

framePos

protected long framePos
The current frame position, starting from frame zero.

frameSize

protected int frameSize
The size of a frame in bytes.

Constructor Details

AudioInputStream

public AudioInputStream(InputStream is,
                        AudioFormat fmt,
                        long length)
Create a new AudioInputStream given an underlying InputStream, the audio format, and the length of the data in frames. The frame size is taken from the format.
Parameters:
is - the underlying input stream
fmt - the format of the data
length - the length of the data in frames

AudioInputStream

public AudioInputStream(TargetDataLine line)
Create a new AudioInputStream given a TargetDataLine. The audio format and the frame size are taken from the line.
Parameters:
line - the TargetDataLine

Method Details

available

public int available()
            throws IOException
Return the number of bytes available to be read from the underlying stream. This wrapper method ensures that the result is always a multiple of the frame size.
Overrides:
available in interface InputStream

close

public void close()
            throws IOException
Close the stream.
Specified by:
close in interface Closeable
Overrides:
close in interface InputStream

getFormat

public AudioFormat getFormat()
Get the format associated with this stream.
Returns:
the AudioFormat

getFrameLength

public long getFrameLength()
Get the length of this stream in frames. Note that this may be AudioSystem#NOT_SPECIFIED.
Returns:
the length of the stream in frames

mark

public void mark(int limit)
Overrides:
mark in interface InputStream

markSupported

public boolean markSupported()
Return true if the underlying stream supports mark and reset, false otherwise.
Overrides:
markSupported in interface InputStream

read

public int read()
            throws IOException
Read a single byte from the underlying stream. If the frame size is set, and is not one byte, an IOException will be thrown.
Overrides:
read in interface InputStream

read

public int read(byte[] buf)
            throws IOException
Overrides:
read in interface InputStream

read

public int read(byte[] buf,
                int offset,
                int length)
            throws IOException
Overrides:
read in interface InputStream

reset

public void reset()
            throws IOException
Overrides:
reset in interface InputStream

skip

public long skip(long n)
            throws IOException
Overrides:
skip in interface InputStream
Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About