Source for javax.sound.sampled.TargetDataLine

   1: /* Input data line.
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.sound.sampled;
  40: 
  41: /**
  42:  * This is a DataLine from which data may be read.
  43:  * @since 1.3
  44:  */
  45: public interface TargetDataLine extends DataLine
  46: {
  47:   /**
  48:    * Open the line using the indicated audio format.
  49:    * @param fmt the format to use
  50:    * @throws LineUnavailableException if the line is not available for
  51:    * some reason
  52:    * @throws SecurityException if this operation is prevented by the
  53:    * security manager
  54:    */
  55:   void open(AudioFormat fmt)
  56:     throws LineUnavailableException;
  57: 
  58:   /**
  59:    * Open the line using the indicated audio format and buffer size.
  60:    * @param fmt the format to use
  61:    * @throws LineUnavailableException if the line is not available for
  62:    * some reason
  63:    * @throws SecurityException if this operation is prevented by the
  64:    * security manager
  65:    */
  66:   void open(AudioFormat fmt, int size)
  67:     throws LineUnavailableException;
  68: 
  69:   /**
  70:    * Read data from the line into the given buffer.  The requested data
  71:    * should be an integral number of framaes, as determined by the audio
  72:    * format.
  73:    * @param buf the buffer into which the data is put
  74:    * @param offset the initial offset at which to write
  75:    * @param length the maximum number of bytes to read
  76:    * @return the actual number of bytes read
  77:    */
  78:   int read(byte[] buf, int offset, int length);
  79: }