Source for javax.sound.sampled.spi.MixerProvider

   1: /* Mixer API
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.sound.sampled.spi;
  40: 
  41: import javax.sound.sampled.Mixer;
  42: 
  43: /**
  44:  * This abstract class defines an interface to mixer providers.
  45:  * Concrete subclasses will implement the methods in this class.
  46:  * @since 1.3
  47:  */
  48: public abstract class MixerProvider
  49: {
  50:   /**
  51:    * Create a new mixer provider.
  52:    */
  53:   public MixerProvider()
  54:   {
  55:   }
  56: 
  57:   /**
  58:    * Return a mixer that matches the given info object.
  59:    * @param info description of the mixer to match
  60:    * @return the mixer
  61:    * @throws IllegalArgumentException if no mixer matches the description
  62:    */
  63:   public abstract Mixer getMixer(Mixer.Info info);
  64: 
  65:   /**
  66:    * Return an array of info objects describing all the mixers provided by
  67:    * this provider.
  68:    */
  69:   public abstract Mixer.Info[] getMixerInfo();
  70: 
  71:   /**
  72:    * Return true if a mixer matching the provided description is supported.
  73:    * @param info description of the mixer to match
  74:    * @return true if it is supported by this provider
  75:    */
  76:   public boolean isMixerSupported(Mixer.Info info)
  77:   {
  78:     Mixer.Info[] infos = getMixerInfo();
  79:     for (int i = 0; i < infos.length; ++i)
  80:       {
  81:         if (info.equals(infos[i]))
  82:           return true;
  83:       }
  84:     return false;
  85:   }
  86: }