author | amenkov |
Fri, 17 Apr 2009 15:11:43 +0400 | |
changeset 2653 | 4abd0886fcfb |
parent 2 | 90ce3da70b43 |
child 5506 | 202f599c92aa |
permissions | -rw-r--r-- |
2 | 1 |
/* |
2 |
* Copyright 1999-2003 Sun Microsystems, Inc. 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. Sun designates this |
|
8 |
* particular file as subject to the "Classpath" exception as provided |
|
9 |
* by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
|
22 |
* CA 95054 USA or visit www.sun.com if you need additional information or |
|
23 |
* have any questions. |
|
24 |
*/ |
|
25 |
||
26 |
package javax.sound.sampled.spi; |
|
27 |
||
28 |
import javax.sound.sampled.Mixer; |
|
29 |
||
30 |
/** |
|
31 |
* A provider or factory for a particular mixer type. |
|
32 |
* This mechanism allows the implementation to determine |
|
33 |
* how resources are managed in creation / management of |
|
34 |
* a mixer. |
|
35 |
* |
|
36 |
* @author Kara Kytle |
|
37 |
* @since 1.3 |
|
38 |
*/ |
|
39 |
public abstract class MixerProvider { |
|
40 |
||
41 |
||
42 |
/** |
|
43 |
* Indicates whether the mixer provider supports the mixer represented by |
|
44 |
* the specified mixer info object. |
|
2653
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
45 |
* <p> |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
46 |
* The full set of mixer info objects that represent the mixers supported |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
47 |
* by this {@code MixerProvider} may be obtained |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
48 |
* through the {@code getMixerInfo} method. |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
49 |
* |
2 | 50 |
* @param info an info object that describes the mixer for which support is queried |
2653
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
51 |
* @return {@code true} if the specified mixer is supported, |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
52 |
* otherwise {@code false} |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
53 |
* @see #getMixerInfo() |
2 | 54 |
*/ |
55 |
public boolean isMixerSupported(Mixer.Info info) { |
|
56 |
||
57 |
Mixer.Info infos[] = getMixerInfo(); |
|
58 |
||
59 |
for(int i=0; i<infos.length; i++){ |
|
60 |
if( info.equals( infos[i] ) ) { |
|
61 |
return true; |
|
62 |
} |
|
63 |
} |
|
64 |
return false; |
|
65 |
} |
|
66 |
||
67 |
||
68 |
/** |
|
69 |
* Obtains the set of info objects representing the mixer |
|
70 |
* or mixers provided by this MixerProvider. |
|
2653
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
71 |
* <p> |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
72 |
* The {@code isMixerSupported} method returns {@code true} |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
73 |
* for all the info objects returned by this method. |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
74 |
* The corresponding mixer instances for the info objects |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
75 |
* are returned by the {@code getMixer} method. |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
76 |
* |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
77 |
* @return a set of mixer info objects |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
78 |
* @see #getMixer(javax.sound.sampled.Mixer.Info) getMixer(Mixer.Info) |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
79 |
* @see #isMixerSupported(javax.sound.sampled.Mixer.Info) isMixerSupported(Mixer.Info) |
2 | 80 |
*/ |
81 |
public abstract Mixer.Info[] getMixerInfo(); |
|
82 |
||
83 |
||
84 |
/** |
|
85 |
* Obtains an instance of the mixer represented by the info object. |
|
2653
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
86 |
* <p> |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
87 |
* The full set of the mixer info objects that represent the mixers |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
88 |
* supported by this {@code MixerProvider} may be obtained |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
89 |
* through the {@code getMixerInfo} method. |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
90 |
* Use the {@code isMixerSupported} method to test whether |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
91 |
* this {@code MixerProvider} supports a particular mixer. |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
92 |
* |
2 | 93 |
* @param info an info object that describes the desired mixer |
94 |
* @return mixer instance |
|
95 |
* @throws IllegalArgumentException if the info object specified does not |
|
2653
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
96 |
* match the info object for a mixer supported by this MixerProvider. |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
97 |
* @see #getMixerInfo() |
4abd0886fcfb
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed
amenkov
parents:
2
diff
changeset
|
98 |
* @see #isMixerSupported(javax.sound.sampled.Mixer.Info) isMixerSupported(Mixer.Info) |
2 | 99 |
*/ |
100 |
public abstract Mixer getMixer(Mixer.Info info); |
|
101 |
} |