• root
• java
• j2se
• 1.6
• javax.sound.midi
• MidiSystem

Methods

• getMidiDevicetop

  public static MidiDevice getMidiDevice(MidiDevice.Info info) throws MidiUnavailableException
  Obtains the requested MIDI device.

  Parameters:

  @param info a device information object representing the desired device.

  Return:

  @return the requested device

  Exceptions:

  @throws MidiUnavailableException if the requested device is not available due to resource restrictions

  @throws IllegalArgumentException if the info object does not represent a MIDI device installed on the system

  See:

  @see javax.sound.midi.MidiSystem.getMidiDeviceInfo()

  Related Links:

  Google Code Search

  Stack Overflow

• getMidiDeviceInfotop

  public static MidiDevice.Info[] getMidiDeviceInfo()
  Obtains an array of information objects representing the set of all MIDI devices available on the system. A returned information object can then be used to obtain the corresponding device object, by invoking getMidiDevice.

  Return:

  @return an array of MidiDevice.Info objects, one for each installed MIDI device. If no such devices are installed, an array of length 0 is returned.

  Related Links:

  Google Code Search

  Stack Overflow

• getMidiFileFormattop

  public static MidiFileFormat getMidiFileFormat(File file) throws InvalidMidiDataException, IOException
  Obtains the MIDI file format of the specified File. The File must point to valid MIDI file data for a file type recognized by the system.

  This operation can only succeed for files of a type which can be parsed by an installed file reader. It may fail with an InvalidMidiDataException even for valid files if no compatible file reader is installed. It will also fail with an InvalidMidiDataException if a compatible file reader is installed, but encounters errors while determining the file format.

  Parameters:

  @param file the File from which file format information should be extracted

  Return:

  @return a MidiFileFormat object describing the MIDI file format

  Exceptions:

  @throws InvalidMidiDataException if the File does not point to valid MIDI file data recognized by the system

  @throws IOException if an I/O exception occurs while accessing the file

  See:

  @see javax.sound.midi.MidiSystem.getMidiFileFormat(java.io.InputStream)

  @see javax.sound.midi.MidiSystem.getMidiFileFormat(java.net.URL)

  Related Links:

  Google Code Search

  Stack Overflow

• getMidiFileFormattop

  public static MidiFileFormat getMidiFileFormat(InputStream stream) throws InvalidMidiDataException, IOException
  Obtains the MIDI file format of the data in the specified input stream. The stream must point to valid MIDI file data for a file type recognized by the system.

  This method and/or the code it invokes may need to read some data from the stream to determine whether its data format is supported. The implementation may therefore need to mark the stream, read enough data to determine whether it is in a supported format, and reset the stream's read pointer to its original position. If the input stream does not permit this set of operations, this method may fail with an IOException.

  This operation can only succeed for files of a type which can be parsed by an installed file reader. It may fail with an InvalidMidiDataException even for valid files if no compatible file reader is installed. It will also fail with an InvalidMidiDataException if a compatible file reader is installed, but encounters errors while determining the file format.

  Parameters:

  @param stream the input stream from which file format information should be extracted

  Return:

  @return an MidiFileFormat object describing the MIDI file format

  Exceptions:

  @throws InvalidMidiDataException if the stream does not point to valid MIDI file data recognized by the system

  @throws IOException if an I/O exception occurs while accessing the stream

  See:

  @see javax.sound.midi.MidiSystem.getMidiFileFormat(java.net.URL)

  @see javax.sound.midi.MidiSystem.getMidiFileFormat(java.io.File)

  @see java.io.InputStream.markSupported()

  @see java.io.InputStream.mark(int)

  Related Links:

  Google Code Search

  Stack Overflow

• getMidiFileFormattop

  public static MidiFileFormat getMidiFileFormat(URL url) throws InvalidMidiDataException, IOException
  Obtains the MIDI file format of the data in the specified URL. The URL must point to valid MIDI file data for a file type recognized by the system.

  This operation can only succeed for files of a type which can be parsed by an installed file reader. It may fail with an InvalidMidiDataException even for valid files if no compatible file reader is installed. It will also fail with an InvalidMidiDataException if a compatible file reader is installed, but encounters errors while determining the file format.

  Parameters:

  @param url the URL from which file format information should be extracted

  Return:

  @return a MidiFileFormat object describing the MIDI file format

  Exceptions:

  @throws InvalidMidiDataException if the URL does not point to valid MIDI file data recognized by the system

  @throws IOException if an I/O exception occurs while accessing the URL

  See:

  @see javax.sound.midi.MidiSystem.getMidiFileFormat(java.io.InputStream)

  @see javax.sound.midi.MidiSystem.getMidiFileFormat(java.io.File)

  Related Links:

  Google Code Search

  Stack Overflow

• getMidiFileTypestop

  public static int[] getMidiFileTypes()
  Obtains the set of MIDI file types for which file writing support is provided by the system.

  Return:

  @return array of unique file types. If no file types are supported, an array of length 0 is returned.

  Related Links:

  Google Code Search

  Stack Overflow

• getMidiFileTypestop

  public static int[] getMidiFileTypes(Sequence sequence)
  Obtains the set of MIDI file types that the system can write from the sequence specified.

  Parameters:

  @param sequence the sequence for which MIDI file type support is queried

  Return:

  @return the set of unique supported file types. If no file types are supported, returns an array of length 0.

  Related Links:

  Google Code Search

  Stack Overflow

• getReceivertop

  public static Receiver getReceiver() throws MidiUnavailableException
  Obtains a MIDI receiver from an external MIDI port or other default device.

  If the system property javax.sound.midi.Receiver is defined or it is defined in the file "sound.properties", it is used to identify the device that provides the default receiver. For details, refer to the class description. If a suitable MIDI port is not available, the Receiver is retrieved from an installed synthesizer.

  If this method returns successfully, the MidiDevice the Receiver belongs to is opened implicitly, if it is not already open. It is possible to close an implicitly opened device by calling close on the returned Receiver. All open Receiver instances have to be closed in order to release system resources hold by the MidiDevice. For a detailed description of open/close behaviour see the class description of MidiDevice.

  Return:

  @return the default MIDI receiver

  Exceptions:

  @throws MidiUnavailableException if the default receiver is not available due to resource restrictions, or no device providing receivers is installed in the system

  Related Links:

  Google Code Search

  Stack Overflow

• getSequencetop

  public static Sequence getSequence(File file) throws InvalidMidiDataException, IOException
  Obtains a MIDI sequence from the specified File. The File must point to valid MIDI file data for a file type recognized by the system.

  This operation can only succeed for files of a type which can be parsed by an installed file reader. It may fail with an InvalidMidiDataException even for valid files if no compatible file reader is installed. It will also fail with an InvalidMidiDataException if a compatible file reader is installed, but encounters errors while constructing the Sequence object from the file data.

  Parameters:

  @param file the File from which the Sequence should be constructed

  Return:

  @return a Sequence object based on the MIDI file data pointed to by the File

  Exceptions:

  @throws InvalidMidiDataException if the File does not point to valid MIDI file data recognized by the system

  @throws IOException if an I/O exception occurs

  Related Links:

  Google Code Search

  Stack Overflow

• getSequencetop

  public static Sequence getSequence(InputStream stream) throws InvalidMidiDataException, IOException
  Obtains a MIDI sequence from the specified input stream. The stream must point to valid MIDI file data for a file type recognized by the system.

  This method and/or the code it invokes may need to read some data from the stream to determine whether its data format is supported. The implementation may therefore need to mark the stream, read enough data to determine whether it is in a supported format, and reset the stream's read pointer to its original position. If the input stream does not permit this set of operations, this method may fail with an IOException.

  This operation can only succeed for files of a type which can be parsed by an installed file reader. It may fail with an InvalidMidiDataException even for valid files if no compatible file reader is installed. It will also fail with an InvalidMidiDataException if a compatible file reader is installed, but encounters errors while constructing the Sequence object from the file data.

  Parameters:

  @param stream the input stream from which the Sequence should be constructed

  Return:

  @return a Sequence object based on the MIDI file data contained in the input stream

  Exceptions:

  @throws InvalidMidiDataException if the stream does not point to valid MIDI file data recognized by the system

  @throws IOException if an I/O exception occurs while accessing the stream

  See:

  @see java.io.InputStream.markSupported()

  @see java.io.InputStream.mark(int)

  Related Links:

  Google Code Search

  Stack Overflow

• getSequencetop

  public static Sequence getSequence(URL url) throws InvalidMidiDataException, IOException
  Obtains a MIDI sequence from the specified URL. The URL must point to valid MIDI file data for a file type recognized by the system.

  This operation can only succeed for files of a type which can be parsed by an installed file reader. It may fail with an InvalidMidiDataException even for valid files if no compatible file reader is installed. It will also fail with an InvalidMidiDataException if a compatible file reader is installed, but encounters errors while constructing the Sequence object from the file data.

  Parameters:

  @param url the URL from which the Sequence should be constructed

  Return:

  @return a Sequence object based on the MIDI file data pointed to by the URL

  Exceptions:

  @throws InvalidMidiDataException if the URL does not point to valid MIDI file data recognized by the system

  @throws IOException if an I/O exception occurs while accessing the URL

  Related Links:

  Google Code Search

  Stack Overflow

• getSequencertop

  public static Sequencer getSequencer() throws MidiUnavailableException
  Obtains the default Sequencer, connected to a default device. The returned Sequencer instance is connected to the default Synthesizer, as returned by javax.sound.midi.MidiSystem.getSynthesizer(). If there is no Synthesizer available, or the default Synthesizer cannot be opened, the sequencer is connected to the default Receiver, as returned by javax.sound.midi.MidiSystem.getReceiver(). The connection is made by retrieving a Transmitter instance from the Sequencer and setting its Receiver. Closing and re-opening the sequencer will restore the connection to the default device.

  This method is equivalent to calling getSequencer(true).

  If the system property javax.sound.midi.Sequencer is defined or it is defined in the file "sound.properties", it is used to identify the default sequencer. For details, refer to the class description.

  Return:

  @return the default sequencer, connected to a default Receiver

  Exceptions:

  @throws MidiUnavailableException if the sequencer is not available due to resource restrictions, or there is no Receiver available by any installed MidiDevice, or no sequencer is installed in the system.

  See:

  @see javax.sound.midi.MidiSystem.getSequencer(boolean)

  @see javax.sound.midi.MidiSystem.getSynthesizer()

  @see javax.sound.midi.MidiSystem.getReceiver()

  Related Links:

  Google Code Search

  Stack Overflow

• getSequencertop

  public static Sequencer getSequencer(boolean connected) throws MidiUnavailableException
  Obtains the default Sequencer, optionally connected to a default device.

  If connected is true, the returned Sequencer instance is connected to the default Synthesizer, as returned by javax.sound.midi.MidiSystem.getSynthesizer(). If there is no Synthesizer available, or the default Synthesizer cannot be opened, the sequencer is connected to the default Receiver, as returned by javax.sound.midi.MidiSystem.getReceiver(). The connection is made by retrieving a Transmitter instance from the Sequencer and setting its Receiver. Closing and re-opening the sequencer will restore the connection to the default device.

  If connected is false, the returned Sequencer instance is not connected, it has no open Transmitters. In order to play the sequencer on a MIDI device, or a Synthesizer, it is necessary to get a Transmitter and set its Receiver.

  If the system property javax.sound.midi.Sequencer is defined or it is defined in the file "sound.properties", it is used to identify the default sequencer. For details, refer to the class description.

  Return:

  @return the default sequencer

  Exceptions:

  @throws MidiUnavailableException if the sequencer is not available due to resource restrictions, or no sequencer is installed in the system, or if connected is true, and there is no Receiver available by any installed MidiDevice

  See:

  @see javax.sound.midi.MidiSystem.getSynthesizer()

  @see javax.sound.midi.MidiSystem.getReceiver()

  Since:

  @since 1.5

  Related Links:

  Google Code Search

  Stack Overflow

• getSoundbanktop

  public static Soundbank getSoundbank(File file) throws InvalidMidiDataException, IOException
  Constructs a Soundbank by reading it from the specified File. The File must point to a valid MIDI soundbank file.

  Parameters:

  @param file the source of the sound bank data

  Return:

  @return the sound bank

  Exceptions:

  @throws InvalidMidiDataException if the File does not point to valid MIDI soundbank data recognized by the system

  @throws IOException if an I/O error occurred when loading the soundbank

  Related Links:

  Google Code Search

  Stack Overflow

• getSoundbanktop

  public static Soundbank getSoundbank(InputStream stream) throws InvalidMidiDataException, IOException
  Constructs a MIDI sound bank by reading it from the specified stream. The stream must point to a valid MIDI soundbank file. In general, MIDI soundbank providers 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 an IOException.

  Parameters:

  @param stream the source of the sound bank data.

  Return:

  @return the sound bank

  Exceptions:

  @throws InvalidMidiDataException if the stream does not point to valid MIDI soundbank data recognized by the system

  @throws IOException if an I/O error occurred when loading the soundbank

  See:

  @see java.io.InputStream.markSupported()

  @see java.io.InputStream.mark(int)

  Related Links:

  Google Code Search

  Stack Overflow

• getSoundbanktop

  public static Soundbank getSoundbank(URL url) throws InvalidMidiDataException, IOException
  Constructs a Soundbank by reading it from the specified URL. The URL must point to a valid MIDI soundbank file.

  Parameters:

  @param url the source of the sound bank data

  Return:

  @return the sound bank

  Exceptions:

  @throws InvalidMidiDataException if the URL does not point to valid MIDI soundbank data recognized by the system

  @throws IOException if an I/O error occurred when loading the soundbank

  Related Links:

  Google Code Search

  Stack Overflow

• getSynthesizertop

  public static Synthesizer getSynthesizer() throws MidiUnavailableException
  Obtains the default synthesizer.

  If the system property javax.sound.midi.Synthesizer is defined or it is defined in the file "sound.properties", it is used to identify the default synthesizer. For details, refer to the class description.

  Return:

  @return the default synthesizer

  Exceptions:

  @throws MidiUnavailableException if the synthesizer is not available due to resource restrictions, or no synthesizer is installed in the system

  Related Links:

  Google Code Search

  Stack Overflow

• getTransmittertop

  public static Transmitter getTransmitter() throws MidiUnavailableException
  Obtains a MIDI transmitter from an external MIDI port or other default source.

  If the system property javax.sound.midi.Transmitter is defined or it is defined in the file "sound.properties", it is used to identify the device that provides the default transmitter. For details, refer to the class description. If this method returns successfully, the MidiDevice the Transmitter belongs to is opened implicitly, if it is not already open. It is possible to close an implicitly opened device by calling close on the returned Transmitter. All open Transmitter instances have to be closed in order to release system resources hold by the MidiDevice. For a detailed description of open/close behaviour see the class description of MidiDevice.

  Return:

  @return the default MIDI transmitter

  Exceptions:

  @throws MidiUnavailableException if the default transmitter is not available due to resource restrictions, or no device providing transmitters is installed in the system

  Related Links:

  Google Code Search

  Stack Overflow

• isFileTypeSupportedtop

  public static boolean isFileTypeSupported(int fileType)
  Indicates whether file writing support for the specified MIDI file type is provided by the system.

  Parameters:

  @param fileType the file type for which write capabilities are queried

  Return:

  @return true if the file type is supported, otherwise false

  Related Links:

  Google Code Search

  Stack Overflow

• isFileTypeSupportedtop

  public static boolean isFileTypeSupported(int fileType, Sequence sequence)
  Indicates whether a MIDI file of the file type specified can be written from the sequence indicated.

  Parameters:

  @param fileType the file type for which write capabilities are queried

  @param sequence the sequence for which file writing support is queried

  Return:

  @return true if the file type is supported for this sequence, otherwise false

  Related Links:

  Google Code Search

  Stack Overflow

• writetop

  public static int write(Sequence in, int type, File out) throws IOException
  Writes a stream of bytes representing a file of the MIDI file type indicated to the external file provided.

  Parameters:

  @param in sequence containing MIDI data to be written to the file

  @param type the file type of the file to be written to the output stream

  @param out external file to which the file data should be written

  Return:

  @return the number of bytes written to the file

  Exceptions:

  @throws IOException if an I/O exception occurs

  @throws IllegalArgumentException if the file type is not supported by the system

  See:

  @see javax.sound.midi.MidiSystem.isFileTypeSupported(int, javax.sound.midi.Sequence)

  @see javax.sound.midi.MidiSystem.getMidiFileTypes(javax.sound.midi.Sequence)

  Related Links:

  Google Code Search

  Stack Overflow

• writetop

  public static int write(Sequence in, int fileType, OutputStream out) throws IOException
  Writes a stream of bytes representing a file of the MIDI file type indicated to the output stream provided.

  Parameters:

  @param in sequence containing MIDI data to be written to the file

  @param fileType the file type of the file to be written to the output stream

  @param out stream to which the file data should be written

  Return:

  @return the number of bytes written to the output stream

  Exceptions:

  @throws IOException if an I/O exception occurs

  @throws IllegalArgumentException if the file format is not supported by the system

  See:

  @see javax.sound.midi.MidiSystem.isFileTypeSupported(int, javax.sound.midi.Sequence)

  @see javax.sound.midi.MidiSystem.getMidiFileTypes(javax.sound.midi.Sequence)

  Related Links:

  Google Code Search

  Stack Overflow