java.lang.Object
javax.sound.midi.spi.MidiFileReader
A
MidiFileReader supplies MIDI file-reading services. Classes
implementing this interface can parse the format information from one or more
types of MIDI file, and can produce a Sequence object from files of
these types.- Since:
- 1.3
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract MidiFileFormatgetMidiFileFormat(File file) Obtains the MIDI file format of theFileprovided.abstract MidiFileFormatgetMidiFileFormat(InputStream stream) Obtains the MIDI file format of the input stream provided.abstract MidiFileFormatgetMidiFileFormat(URL url) Obtains the MIDI file format of theURLprovided.abstract SequencegetSequence(File file) Obtains a MIDI sequence from theFileprovided.abstract SequencegetSequence(InputStream stream) Obtains a MIDI sequence from the input stream provided.abstract SequencegetSequence(URL url) Obtains a MIDI sequence from theURLprovided.
-
Constructor Details
-
MidiFileReader
protected MidiFileReader()Constructor for subclasses to call.
-
-
Method Details
-
getMidiFileFormat
public abstract MidiFileFormat getMidiFileFormat(InputStream stream) throws InvalidMidiDataException, IOException Obtains the MIDI file format of the input stream provided. The stream must point to valid MIDI file data. In general, MIDI file readers may need to read some data from the stream before determining whether they support it. These parsers must be able to mark the stream, read enough data to determine whether they support the stream, and, if not, reset the stream's read pointer to its original position. If the input stream does not support this, this method may fail with anIOException.- Parameters:
stream- the input stream from which file format information should be extracted- Returns:
- a
MidiFileFormatobject describing the MIDI file format - Throws:
InvalidMidiDataException- if the stream does not point to valid MIDI file data recognized by the systemIOException- if an I/O exception occursNullPointerException- ifstreamisnull- See Also:
-
getMidiFileFormat
public abstract MidiFileFormat getMidiFileFormat(URL url) throws InvalidMidiDataException, IOException Obtains the MIDI file format of theURLprovided. TheURLmust point to valid MIDI file data.- Parameters:
url- theURLfrom which file format information should be extracted- Returns:
- a
MidiFileFormatobject describing the MIDI file format - Throws:
InvalidMidiDataException- if theURLdoes not point to valid MIDI file data recognized by the systemIOException- if an I/O exception occursNullPointerException- ifurlisnull
-
getMidiFileFormat
public abstract MidiFileFormat getMidiFileFormat(File file) throws InvalidMidiDataException, IOException Obtains the MIDI file format of theFileprovided. TheFilemust point to valid MIDI file data.- Parameters:
file- theFilefrom which file format information should be extracted- Returns:
- a
MidiFileFormatobject describing the MIDI file format - Throws:
InvalidMidiDataException- if theFiledoes not point to valid MIDI file data recognized by the systemIOException- if an I/O exception occursNullPointerException- iffileisnull
-
getSequence
public abstract Sequence getSequence(InputStream stream) throws InvalidMidiDataException, IOException Obtains a MIDI sequence from the input stream provided. The stream must point to valid MIDI file data. In general, MIDI file readers may need to read some data from the stream before determining whether they support it. These parsers must be able to mark the stream, read enough data to determine whether they support the stream, and, if not, reset the stream's read pointer to its original position. If the input stream does not support this, this method may fail with anIOException.- Parameters:
stream- the input stream from which theSequenceshould be constructed- Returns:
- a
Sequenceobject based on the MIDI file data contained in the input stream - Throws:
InvalidMidiDataException- if the stream does not point to valid MIDI file data recognized by the systemIOException- if an I/O exception occursNullPointerException- ifstreamisnull- See Also:
-
getSequence
Obtains a MIDI sequence from theURLprovided. TheURLmust point to valid MIDI file data.- Parameters:
url- theURLfor which theSequenceshould be constructed- Returns:
- a
Sequenceobject based on the MIDI file data pointed to by theURL - Throws:
InvalidMidiDataException- if theURLdoes not point to valid MIDI file data recognized by the systemIOException- if an I/O exception occursNullPointerException- ifurlisnull
-
getSequence
Obtains a MIDI sequence from theFileprovided. TheFilemust point to valid MIDI file data.- Parameters:
file- theFilefrom which theSequenceshould be constructed- Returns:
- a
Sequenceobject based on the MIDI file data pointed to by theFile - Throws:
InvalidMidiDataException- if theFiledoes not point to valid MIDI file data recognized by the systemIOException- if an I/O exception occursNullPointerException- iffileisnull
-