001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030/**
031 * 
032 */
033package org.openimaj.audio;
034
035import org.openimaj.audio.util.AudioUtils;
036
037/**
038 *      Represents an audio device and its capabilities. Use
039 *      {@link AudioUtils#getDevices()} to get a list of supported devices.
040 *
041 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
042 *      
043 *      @created 26 Nov 2011
044 */
045public class AudioDevice
046{
047        /** The audio device name */
048        public String displayName;
049        
050        /** The name of the device */
051        public String deviceName;
052        
053        /**
054         *      Create a new audio device.
055         * 
056         *      @param deviceName The device name
057         *      @param displayName The display name
058         */
059        public AudioDevice( String deviceName, String displayName )
060        {
061                this.deviceName = deviceName;
062                this.displayName = displayName;
063        }
064
065        /**
066         *      {@inheritDoc}
067         *      @see java.lang.Object#toString()
068         */
069        @Override
070        public String toString()
071        {
072                return deviceName+" ("+displayName+")";
073        }
074}