/* Output data line.
   Copyright (C) 2005 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package javax.sound.sampled;

/**
 * This is a DataLine to which data may be written.
 * @since 1.3
 */
public interface SourceDataLine extends DataLine
{
  /**
   * Open the line, given the desired audio format.
   * @param fmt the format to use
   * @throws LineUnavailableException if the line is not available for
   * some reason
   * @throws SecurityException if this is prevented by the security manager
   */
  void open(AudioFormat fmt)
    throws LineUnavailableException;

  /**
   * Open the line, given the desired audio format and the buffer size.
   * @param fmt the format to use
   * @param size the buffer size
   * @throws LineUnavailableException if the line is not available for
   * some reason
   * @throws SecurityException if this is prevented by the security manager
   */
  void open(AudioFormat fmt, int size)
    throws LineUnavailableException;

  /**
   * Write audio data to this line.  The data must be an integral number
   * of frames, as determined by the audio format.
   * @param buf a byte array of audio data
   * @param offset index of the first byte in the array to use
   * @param length the number of bytes to write
   * @return the number of bytes written
   */
  int write(byte[] buf, int offset, int length);
}