1 /*
2 * Copyright (c) 1999, 2015, 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.Objects;
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 * Indicates whether the mixer provider supports the mixer represented by
44 * the specified mixer info object.
45 * <p>
46 * The full set of mixer info objects that represent the mixers supported by
47 * this {@code MixerProvider} may be obtained through the
48 * {@code getMixerInfo} method.
49 *
50 * @param info an info object that describes the mixer for which support is
51 * queried
52 * @return {@code true} if the specified mixer is supported, otherwise
53 * {@code false}
54 * @throws NullPointerException if {@code info} is {@code null}
55 * @see #getMixerInfo()
56 */
57 public boolean isMixerSupported(Mixer.Info info) {
58 Objects.requireNonNull(info);
59
60 Mixer.Info infos[] = getMixerInfo();
61
62 for(int i=0; i<infos.length; i++){
63 if( info.equals( infos[i] ) ) {
64 return true;
65 }
66 }
67 return false;
68 }
69
70 /**
71 * Obtains the set of info objects representing the mixer or mixers provided
72 * by this MixerProvider.
73 * <p>
74 * The {@code isMixerSupported} method returns {@code true} for all the info
75 * objects returned by this method. The corresponding mixer instances for
76 * the info objects are returned by the {@code getMixer} method.
77 *
78 * @return a set of mixer info objects
79 * @see #getMixer(Mixer.Info)
80 * @see #isMixerSupported(Mixer.Info)
81 */
82 public abstract Mixer.Info[] getMixerInfo();
83
84 /**
85 * Obtains an instance of the mixer represented by the info object.
86 * <p>
87 * The full set of the mixer info objects that represent the mixers
88 * supported by this {@code MixerProvider} may be obtained through the
89 * {@code getMixerInfo} method. Use the {@code isMixerSupported} method to
90 * test whether this {@code MixerProvider} supports a particular mixer.
91 *
92 * @param info an info object that describes the desired mixer,
93 * or {@code null} for the system default mixer
94 * @return mixer instance
95 * @throws IllegalArgumentException if the info object specified does not
96 * match the info object for a mixer supported by this MixerProvider
97 * @see #getMixerInfo()
98 * @see #isMixerSupported(Mixer.Info)
99 */
100 public abstract Mixer getMixer(Mixer.Info info);
101 }