001    /* Soundbank.java -- Container of Instruments to be loaded into a Synthesizer
002       Copyright (C) 2005 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package javax.sound.midi;
040    
041    /**
042     * A Soundbank is a container for instruments which may be loaded into 
043     * a Synthesizer.
044     * 
045     * @author Anthony Green (green@redhat.com)
046     * @since 1.3
047     *
048     */
049    public interface Soundbank
050    {
051      /**
052       * Get the sound bank name.
053       * 
054       * @return the sound bank name
055       */
056      String getName();
057      
058      /**
059       * Get the sound bank version.
060       * 
061       * @return the sound bank version
062       */
063      String getVersion();
064    
065      /**
066       * Get the sound bank vendor.
067       * 
068       * @return the sound bank vendor
069       */
070      String getVendor();
071      
072      
073      /**
074       * Get the sound bank description.
075       * 
076       * @return the sound bank description
077       */
078      String getDescription();
079      
080      /**
081       * Get an array of non-Instrument resources in this sound bank.
082       * 
083       * @return an array of non-instrument resources in this sound bank
084       */
085      SoundbankResource[] getResources();
086      
087      /**
088       * Get an array of Instruments in this sound bank.
089       * 
090       * @return an array of instruments in this sound bank
091       */
092      Instrument[] getInstruments();
093      
094      /**
095       * Get the Instrument for the given Patch.
096       * 
097       * @param patch the Patch to search for
098       * @return the Instrument corresponding to patch
099       */
100      Instrument getInstrument(Patch patch);
101    }