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