1 /* 2 * Copyright (c) 1999, 2020, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package javax.sound.sampled.spi; 27 28 import java.util.Arrays; 29 30 import javax.sound.sampled.Mixer; 31 32 /** 33 * A provider or factory for a particular mixer type. This mechanism allows the 34 * implementation to determine how resources are managed in creation / 35 * management of a mixer. 36 * 37 * @author Kara Kytle 38 * @since 1.3 39 */ 40 public abstract class MixerProvider { 41 42 /** 43 * Constructs a {@code MixerProvider}. 44 */ 45 protected MixerProvider() {} 46 47 /** 48 * Indicates whether the mixer provider supports the mixer represented by 49 * the specified mixer info object. 50 * <p> 51 * The full set of mixer info objects that represent the mixers supported by 52 * this {@code MixerProvider} may be obtained through the 53 * {@code getMixerInfo} method. 54 * 55 * @param info an info object that describes the mixer for which support is 56 * queried 57 * @return {@code true} if the specified mixer is supported, otherwise 58 * {@code false} 59 * @throws NullPointerException if {@code info} is {@code null} 60 * @see #getMixerInfo() 61 */ 62 public boolean isMixerSupported(final Mixer.Info info) { 63 return Arrays.stream(getMixerInfo()).anyMatch(info::equals); 64 } 65 66 /** 67 * Obtains the set of info objects representing the mixer or mixers provided 68 * by this MixerProvider. 69 * <p> 70 * The {@code isMixerSupported} method returns {@code true} for all the info 71 * objects returned by this method. The corresponding mixer instances for 72 * the info objects are returned by the {@code getMixer} method. 73 * 74 * @return a set of mixer info objects 75 * @see #getMixer(Mixer.Info) 76 * @see #isMixerSupported(Mixer.Info) 77 */ 78 public abstract Mixer.Info[] getMixerInfo(); 79 80 /** 81 * Obtains an instance of the mixer represented by the info object. If 82 * {@code null} is passed, then the default mixer will be returned. 83 * <p> 84 * The full set of the mixer info objects that represent the mixers 85 * supported by this {@code MixerProvider} may be obtained through the 86 * {@code getMixerInfo} method. Use the {@code isMixerSupported} method to 87 * test whether this {@code MixerProvider} supports a particular mixer. 88 * 89 * @param info an info object that describes the desired mixer, or 90 * {@code null} for the default mixer 91 * @return mixer instance 92 * @throws IllegalArgumentException if the info object specified does not 93 * match the info object for a mixer supported by this 94 * {@code MixerProvider}, or if this {@code MixerProvider} does not 95 * have default mixer, but default mixer has been requested 96 * @see #getMixerInfo() 97 * @see #isMixerSupported(Mixer.Info) 98 */ 99 public abstract Mixer getMixer(Mixer.Info info); 100 }