javax.media.GainChangeEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mhp-1.1.2 Show documentation
MHP 1.1.2 stubs
The newest version!
/*
 * @(#)GainChangeEvent.java	1.17 98/03/28
 *
 * Copyright 1996-1998 by Sun Microsystems, Inc.,
 * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
 * All rights reserved.
 *
 * This software is the confidential and proprietary information
 * of Sun Microsystems, Inc. ("Confidential Information").  You
 * shall not disclose such Confidential Information and shall use
 * it only in accordance with the terms of the license agreement
 * you entered into with Sun.
 */

package javax.media;

/**
 * A GainChangeEvent is posted by a
 * GainControl when its state has been updated.
 *
 * Java Beans support 
 * Any implementation of this object is required to be subclassed
 * from either java.util.EventObject or sunw.util.EventObject.
 *
 * @see GainControl
 * @see GainChangeListener
 *
 * @version 1.17, 98/03/28
 */
public class GainChangeEvent extends java.util.EventObject
    implements MediaEvent {

    GainControl eventSrc;
    boolean newMute;
    float newDB;
    float newLevel;

    public GainChangeEvent(GainControl from,
			  boolean mute, float dB, float level) {
	super(from);
	eventSrc = from;
	newMute = mute;
	newDB = dB;
	newLevel = level;
    }

    /**
     * Get the object that posted this event.
     *
     * @return The object that posted this event.
     */
     public Object getSource() {
	 return eventSrc;
     }

    /**
     * Get the GainControl that posted this event.  
     *
     * @return The GainControl that posted this event.
     */
    public GainControl getSourceGainControl() {
	return eventSrc;
    }

    /**
     * Get the GainControl's new gain value in dB.
     *
     * @return The GainControl's new gain value, in dB.
     */
    public float getDB() {
	return newDB;
    }

    /**
     * Get the GainControl's new gain value in the level scale.
     *
     * @return The GainControl's new gain, in the level scale.
    */
    public float getLevel() {
	return newLevel;
    }

    /**
     * Get the GainControl's new mute value.
     *
     * @return The GainControl's new mute value.
    */
    public boolean getMute() {
	return newMute;
    }

}