This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.sound.midi.spi
class MidiFileWriter

java.lang.Object extended by javax.sound.midi.spi.MidiFileWriter

Most common way to construct:

List providers = …;
int i = …;

MidiFileWriter writer = (MidiFileWriter)providers.get(i);

Based on 12 examples


public abstract class MidiFileWriter
extends Object

A MidiFileWriter supplies MIDI file-writing services. Classes that implement this interface can write one or more types of MIDI file from a {@link Sequence} object.


Constructor Summary

          
 
Method Summary
abstract int[]

          Obtains the set of MIDI file types for which file writing support is provided by this file writer.
abstract int[]

          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
write(Sequence in, int fileType, File out)

          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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MidiFileWriter

public MidiFileWriter()
Method Detail

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

public abstract int[] getMidiFileTypes(Sequence sequence)
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.

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, otherwise false

isFileTypeSupported

public boolean isFileTypeSupported(int fileType,
                                   Sequence sequence)
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 queried
sequence - the sequence for which file writing support is queried
Returns:
true if the file type is supported for this sequence, otherwise false

write

public abstract int write(Sequence in,
                          int fileType,
                          File out)
                   throws IOException
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 file
fileType - type of the file to be written to the external file
out - 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 occurs

write

public abstract int write(Sequence in,
                          int fileType,
                          OutputStream out)
                   throws IOException
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 file
fileType - type of the file to be written to the output stream
out - 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 occurs


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.