001/* Mixer API
002   Copyright (C) 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.sound.sampled.spi;
040
041import javax.sound.sampled.Mixer;
042
043/**
044 * This abstract class defines an interface to mixer providers.
045 * Concrete subclasses will implement the methods in this class.
046 * @since 1.3
047 */
048public abstract class MixerProvider
049{
050  /**
051   * Create a new mixer provider.
052   */
053  public MixerProvider()
054  {
055  }
056
057  /**
058   * Return a mixer that matches the given info object.
059   * @param info description of the mixer to match
060   * @return the mixer
061   * @throws IllegalArgumentException if no mixer matches the description
062   */
063  public abstract Mixer getMixer(Mixer.Info info);
064
065  /**
066   * Return an array of info objects describing all the mixers provided by
067   * this provider.
068   */
069  public abstract Mixer.Info[] getMixerInfo();
070
071  /**
072   * Return true if a mixer matching the provided description is supported.
073   * @param info description of the mixer to match
074   * @return true if it is supported by this provider
075   */
076  public boolean isMixerSupported(Mixer.Info info)
077  {
078    Mixer.Info[] infos = getMixerInfo();
079    for (int i = 0; i < infos.length; ++i)
080      {
081        if (info.equals(infos[i]))
082          return true;
083      }
084    return false;
085  }
086}