java.lang.Object
javax.sound.midi.spi.MidiFileWriter
A
MidiFileWriter
supplies MIDI file-writing services. Classes that
implement this interface can write one or more types of MIDI file from a
Sequence
object.- Since:
- 1.3
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract int[]
Obtains the set of MIDI file types for which file writing support is provided by this file writer.abstract int[]
getMidiFileTypes
(Sequence sequence) Obtains the file types that this file writer can write from the sequence specified.boolean
isFileTypeSupported
(int fileType) Indicates whether file writing support for the specified MIDI file type is provided by this file writer.boolean
isFileTypeSupported
(int fileType, Sequence sequence) Indicates whether a MIDI file of the file type specified can be written from the sequence indicated.abstract int
Writes a stream of bytes representing a MIDI file of the file type indicated to the external file provided.abstract int
write
(Sequence in, int fileType, OutputStream out) Writes a stream of bytes representing a MIDI file of the file type indicated to the output stream provided.
-
Constructor Details
-
MidiFileWriter
protected MidiFileWriter()Constructor for subclasses to call.
-
-
Method Details
-
getMidiFileTypes
public abstract int[] getMidiFileTypes()Obtains the set of MIDI file types for which file writing support is provided by this file writer.- Returns:
- array of file types. If no file types are supported, an array of length 0 is returned.
-
getMidiFileTypes
Obtains the file types that this file writer can write from the sequence specified.- Parameters:
sequence
- the sequence for which MIDI file type support is queried- Returns:
- array of file types. If no file types are supported, returns an array of length 0.
- Throws:
NullPointerException
- ifsequence
isnull
-
isFileTypeSupported
public boolean isFileTypeSupported(int fileType) Indicates whether file writing support for the specified MIDI file type is provided by this file writer.- Parameters:
fileType
- the file type for which write capabilities are queried- Returns:
true
if the file type is supported, otherwisefalse
-
isFileTypeSupported
Indicates whether a MIDI file of the file type specified can be written from the sequence indicated.- Parameters:
fileType
- the file type for which write capabilities are queriedsequence
- the sequence for which file writing support is queried- Returns:
true
if the file type is supported for this sequence, otherwisefalse
- Throws:
NullPointerException
- ifsequence
isnull
-
write
Writes a stream of bytes representing a MIDI file of the file type indicated to the output stream provided.- Parameters:
in
- sequence containing MIDI data to be written to the filefileType
- type of the file to be written to the output streamout
- stream to which the file data should be written- Returns:
- the number of bytes written to the output stream
- Throws:
IOException
- if an I/O exception occursIllegalArgumentException
- if the file type is not supported by this file writerNullPointerException
- ifin
orout
arenull
- See Also:
-
write
Writes a stream of bytes representing a MIDI file of the file type indicated to the external file provided.- Parameters:
in
- sequence containing MIDI data to be written to the external filefileType
- type of the file to be written to the external fileout
- external file to which the file data should be written- Returns:
- the number of bytes written to the file
- Throws:
IOException
- if an I/O exception occursIllegalArgumentException
- if the file type is not supported by this file writerNullPointerException
- ifin
orout
arenull
- See Also:
-