Package org.jfugue.midi

Class PatchProvider

  • public class PatchProvider
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String STATUS_NO_SOUNDBANK_FILE
      Status when the PatchProvider has no defined soundbank file
      static java.lang.String STATUS_OK
      Status when loadPatchesIntoSynthesizer is successful
      static java.lang.String STATUS_SOUNDBANK_NOT_SUPPORTED
      Status when the Synthesizer given to loadPatchesIntoSynthesizer cannot support the loaded soundbank

    • Constructor Summary

      Constructors 
      Constructor Description
      PatchProvider​(java.io.File soundbankFile)  
      PatchProvider​(java.io.File soundbankFile, int... patchIndexes)  
      PatchProvider​(java.io.File soundbankFile, java.util.List<javax.sound.midi.Patch> patches)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<javax.sound.midi.Patch> getPatches()  
      java.io.File getSoundbankFile()  
      java.lang.String loadPatchesIntoSynthesizer​(javax.sound.midi.Synthesizer synth)
      Loads the soundbank into the given synthesizer - or tries to.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • STATUS_OK

        public static final java.lang.String STATUS_OK
        Status when loadPatchesIntoSynthesizer is successful
        See Also:
        Constant Field Values

      • STATUS_NO_SOUNDBANK_FILE

        public static final java.lang.String STATUS_NO_SOUNDBANK_FILE
        Status when the PatchProvider has no defined soundbank file
        See Also:
        Constant Field Values

      • STATUS_SOUNDBANK_NOT_SUPPORTED

        public static final java.lang.String STATUS_SOUNDBANK_NOT_SUPPORTED
        Status when the Synthesizer given to loadPatchesIntoSynthesizer cannot support the loaded soundbank
        See Also:
        Constant Field Values

    • Constructor Detail

      • PatchProvider

        public PatchProvider​(java.io.File soundbankFile,
                     int... patchIndexes)

      • PatchProvider

        public PatchProvider​(java.io.File soundbankFile,
                     java.util.List<javax.sound.midi.Patch> patches)

      • PatchProvider

        public PatchProvider​(java.io.File soundbankFile)

    • Method Detail

      • getSoundbankFile

        public java.io.File getSoundbankFile()

      • getPatches

        public java.util.List<javax.sound.midi.Patch> getPatches()

      • loadPatchesIntoSynthesizer

        public java.lang.String loadPatchesIntoSynthesizer​(javax.sound.midi.Synthesizer synth)
                                            throws javax.sound.midi.InvalidMidiDataException,
                                                   java.io.IOException
        Loads the soundbank into the given synthesizer - or tries to. If the method is not successful, it will return a status other than STATUS_OK.
        Throws:
        javax.sound.midi.InvalidMidiDataException
        java.io.IOException