001 /* Input data line.
002 Copyright (C) 2005 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.sound.sampled;
040
041 /**
042 * This is a DataLine from which data may be read.
043 * @since 1.3
044 */
045 public interface TargetDataLine extends DataLine
046 {
047 /**
048 * Open the line using the indicated audio format.
049 * @param fmt the format to use
050 * @throws LineUnavailableException if the line is not available for
051 * some reason
052 * @throws SecurityException if this operation is prevented by the
053 * security manager
054 */
055 void open(AudioFormat fmt)
056 throws LineUnavailableException;
057
058 /**
059 * Open the line using the indicated audio format and buffer size.
060 * @param fmt the format to use
061 * @throws LineUnavailableException if the line is not available for
062 * some reason
063 * @throws SecurityException if this operation is prevented by the
064 * security manager
065 */
066 void open(AudioFormat fmt, int size)
067 throws LineUnavailableException;
068
069 /**
070 * Read data from the line into the given buffer. The requested data
071 * should be an integral number of framaes, as determined by the audio
072 * format.
073 * @param buf the buffer into which the data is put
074 * @param offset the initial offset at which to write
075 * @param length the maximum number of bytes to read
076 * @return the actual number of bytes read
077 */
078 int read(byte[] buf, int offset, int length);
079 }