001/* 
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
041import java.io.IOException;
042
043/**
044 * A Clip represents some pre-loaded audio data.
045 * @since 1.3
046 */
047public interface Clip extends DataLine
048{
049  /**
050   * This can be passed to {@link #loop(int)} to indicate that looping
051   * should be done continuously.
052   */
053  int LOOP_CONTINUOUSLY = -1;
054
055  /**
056   * Return the frame length of this clip.
057   */
058  int getFrameLength();
059
060  /**
061   * Return the length of the clip in microseconds.
062   */
063  long getMicrosecondLength();
064
065  /**
066   * Start looping the clip.  Looping will occur count times, or, if count
067   * is LOOP_CONTINUOUSLY, will be done continuously.  A count of 0 indicates
068   * that any current looping should stop.
069   * @param count the number of times to loop
070   */
071  void loop(int count);
072
073  /**
074   * Open a clip, given an audio format and some data.
075   * @param fmt the format of the data
076   * @param data a byte array containing the audio data
077   * @param offset the offset of the first byte of data in the array
078   * @param len the length of the audio data in the array, in bytes
079   * @throws LineUnavailableException if the line cannot be opened
080   * @throws SecurityException if the line cannot be opened for security
081   * reasons
082   */
083  void open(AudioFormat fmt, byte[] data, int offset, int len)
084    throws LineUnavailableException;
085
086  /**
087   * Open a clip, given an audio input stream.
088   * @param ais the input stream
089   * @throws LineUnavailableException if the line cannot be opened
090   * @throws SecurityException if the line cannot be opened for security
091   * reasons
092   * @throws IOException if there is an I/O error while reading the stream
093   */
094  void open(AudioInputStream ais)
095    throws LineUnavailableException, IOException;
096
097  /**
098   * Set the position to the indicated frame.
099   * @param where new frame position
100   */
101  void setFramePosition(int where);
102
103  /**
104   * Set the loop begin and end points.  These are used by loop(int).
105   * @param begin the starting point
106   * @param end the ending point
107   */
108  void setLoopPoints(int begin, int end);
109
110  /**
111   * Set the position to the indicated microsecond.
112   * @param ms the new position in microseconds
113   */
114  void setMicrosecondPosition(long ms);
115}