Source for javax.sound.sampled.Clip

   1: /*
   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: import java.io.IOException;
  42: 
  43: /**
  44:  * A Clip represents some pre-loaded audio data.
  45:  * @since 1.3
  46:  */
  47: public interface Clip extends DataLine
  48: {
  49:   /**
  50:    * This can be passed to {@link #loop(int)} to indicate that looping
  51:    * should be done continuously.
  52:    */
  53:   int LOOP_CONTINUOUSLY = -1;
  54: 
  55:   /**
  56:    * Return the frame length of this clip.
  57:    */
  58:   int getFrameLength();
  59: 
  60:   /**
  61:    * Return the length of the clip in microseconds.
  62:    */
  63:   long getMicrosecondLength();
  64: 
  65:   /**
  66:    * Start looping the clip.  Looping will occur count times, or, if count
  67:    * is LOOP_CONTINUOUSLY, will be done continuously.  A count of 0 indicates
  68:    * that any current looping should stop.
  69:    * @param count the number of times to loop
  70:    */
  71:   void loop(int count);
  72: 
  73:   /**
  74:    * Open a clip, given an audio format and some data.
  75:    * @param fmt the format of the data
  76:    * @param data a byte array containing the audio data
  77:    * @param offset the offset of the first byte of data in the array
  78:    * @param len the length of the audio data in the array, in bytes
  79:    * @throws LineUnavailableException if the line cannot be opened
  80:    * @throws SecurityException if the line cannot be opened for security
  81:    * reasons
  82:    */
  83:   void open(AudioFormat fmt, byte[] data, int offset, int len)
  84:     throws LineUnavailableException;
  85: 
  86:   /**
  87:    * Open a clip, given an audio input stream.
  88:    * @param ais the input stream
  89:    * @throws LineUnavailableException if the line cannot be opened
  90:    * @throws SecurityException if the line cannot be opened for security
  91:    * reasons
  92:    * @throws IOException if there is an I/O error while reading the stream
  93:    */
  94:   void open(AudioInputStream ais)
  95:     throws LineUnavailableException, IOException;
  96: 
  97:   /**
  98:    * Set the position to the indicated frame.
  99:    * @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: }