jdk/src/share/classes/javax/sound/sampled/spi/MixerProvider.java
author amenkov
Fri, 17 Apr 2009 15:11:43 +0400
changeset 2653 4abd0886fcfb
parent 2 90ce3da70b43
child 5506 202f599c92aa
permissions -rw-r--r--
4895403: SPEC: documentation of javax.sound.sampled.spi.MixerProvider should be detailed Reviewed-by: malenkov
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1999-2003 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.sound.sampled.spi;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import javax.sound.sampled.Mixer;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * A provider or factory for a particular mixer type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * This mechanism allows the implementation to determine
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * how resources are managed in creation / management of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * a mixer.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * @author Kara Kytle
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * @since 1.3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
public abstract class MixerProvider {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
     * Indicates whether the mixer provider supports the mixer represented by
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    public boolean isMixerSupported(Mixer.Info info) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
        Mixer.Info infos[] = getMixerInfo();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
        for(int i=0; i<infos.length; i++){
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
            if( info.equals( infos[i] ) ) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
                return true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
        return false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * Obtains the set of info objects representing the mixer
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    public abstract Mixer.Info[] getMixerInfo();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     * @param info an info object that describes the desired mixer
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
     * @return mixer instance
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
    public abstract Mixer getMixer(Mixer.Info info);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
}