javax.sound.sampled.spi

Class AudioFileReader


public abstract class AudioFileReader
extends Object

This abstract class defines the interface to audio file readers. A concrete provider subclass will implement the methods declared here. These methods can be used to determine the format of files, and to retrieve an AudioInputStream for a file.
Since:
1.3

Constructor Summary

AudioFileReader()
The default constructor.

Method Summary

abstract AudioFileFormat
getAudioFileFormat(File file)
Return the format of the given file as deduced by this provider.
abstract AudioFileFormat
getAudioFileFormat(InputStream is)
Return the format of the given input stream as deduced by this provider.
abstract AudioFileFormat
getAudioFileFormat(URL url)
Return the format of the given URL as deduced by this provider.
abstract AudioInputStream
getAudioInputStream(File file)
Return an AudioInputStream for the given file.
abstract AudioInputStream
getAudioInputStream(InputStream is)
Return an AudioInputStream wrapping the given input stream.
abstract AudioInputStream
getAudioInputStream(URL url)
Return an AudioInputStream for the given URL.

Methods inherited from class java.lang.Object

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

Constructor Details

AudioFileReader

public AudioFileReader()
The default constructor. Note that this class is abstract and thus not directly instantiable.

Method Details

getAudioFileFormat

public abstract AudioFileFormat getAudioFileFormat(File file)
            throws UnsupportedAudioFileException,
                   IOException
Return the format of the given file as deduced by this provider. If the format of the file is not recognized, throws an exception. This will also throw an exception if there is an I/O error when reading the file.
Parameters:
file - the file to examine
Returns:
the audio file format
Throws:
UnsupportedAudioFileException - if the file's format is not recognized
IOException - if there is an I/O error while reading the file

getAudioFileFormat

public abstract AudioFileFormat getAudioFileFormat(InputStream is)
            throws UnsupportedAudioFileException,
                   IOException
Return the format of the given input stream as deduced by this provider. If the format of the stream is not recognized, throws an exception. This will also throw an exception if there is an I/O error when reading the stream. Note that providers typically use mark and reset on the stream when examining the data, and as a result an IOException may be thrown if the stream does not support these.
Parameters:
is - the stream to examine
Returns:
the audio file format
Throws:
UnsupportedAudioFileException - if the stream's format is not recognized
IOException - if there is an I/O error while reading the stream

getAudioFileFormat

public abstract AudioFileFormat getAudioFileFormat(URL url)
            throws UnsupportedAudioFileException,
                   IOException
Return the format of the given URL as deduced by this provider. If the format of the URL is not recognized, throws an exception. This will also throw an exception if there is an I/O error when reading the URL.
Parameters:
url - the URL to examine
Returns:
the audio file format
Throws:
UnsupportedAudioFileException - if the URL's format is not recognized
IOException - if there is an I/O error while reading the URL

getAudioInputStream

public abstract AudioInputStream getAudioInputStream(File file)
            throws UnsupportedAudioFileException,
                   IOException
Return an AudioInputStream for the given file. The file is assumed to hold valid audio data.
Parameters:
file - the file to read
Returns:
an AudioInputStream for the file
Throws:
UnsupportedAudioFileException - if the file's type is not recognized
IOException - if there is an error while reading the file

getAudioInputStream

public abstract AudioInputStream getAudioInputStream(InputStream is)
            throws UnsupportedAudioFileException,
                   IOException
Return an AudioInputStream wrapping the given input stream. The stream is assumed to hold valid audio data.
Parameters:
is - the input stream to wrap
Returns:
an AudioInputStream for the stream
Throws:
UnsupportedAudioFileException - if the stream's type is not recognized
IOException - if there is an error while reading the stream

getAudioInputStream

public abstract AudioInputStream getAudioInputStream(URL url)
            throws UnsupportedAudioFileException,
                   IOException
Return an AudioInputStream for the given URL. The URL is assumed to hold valid audio data.
Parameters:
url - the URL to read
Returns:
an AudioInputStream for the URL
Throws:
UnsupportedAudioFileException - if the URL's type is not recognized
IOException - if there is an error while reading the URL

Audio file reader API 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.