FileDocCategorySizeDatePackage
TonePlayer.javaAPI DocphoneME MR2 API (J2ME)1665Wed May 02 16:47:16 BST 2007com.sun.mmedia

TonePlayer.java

/*
 *  Copyright  1990-2007 Sun Microsystems, Inc. All Rights Reserved.
 *  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *  
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License version
 *  2 only, as published by the Free Software Foundation.
 *  
 *  This program 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 version 2 for more details (a copy is
 *  included at /legal/license.txt).
 *  
 *  You should have received a copy of the GNU General Public License
 *  version 2 along with this work; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 *  02110-1301 USA
 *  
 *  Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
 *  Clara, CA 95054 or visit www.sun.com if you need additional
 *  information or have any questions.
 */
package com.sun.mmedia;

import javax.microedition.media.MediaException;

/**
 * The Tone Player Interface
 *
 * @created    January 31, 2005
 */
public interface TonePlayer {
    /**
     * Plays a note of specified duration and volume
     *
     * @param  note      Defines the tone of the note.
     * @param  duration  The duration of the tone in milli-seconds.
     * @param  volume    Audio volume range from 0 to 100.
     */
    public void playTone(int note, int duration, int volume)
        throws MediaException;

    /**
     * Stop current tone playing
     */
    public void stopTone();
}