1 /*
2 * Copyright 1999-2002 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.sound.midi;
27
28 import java.util.EventListener;
29
30
31 /**
32 * The <code>ControllerEventListener</code> interface should be implemented
33 * by classes whose instances need to be notified when a <code>Sequencer</code>
34 * has processed a requested type of MIDI control-change event.
35 * To register a <code>ControllerEventListener</code> object to receive such
36 * notifications, invoke the
37 * {@link Sequencer#addControllerEventListener(ControllerEventListener, int[])
38 * addControllerEventListener} method of <code>Sequencer</code>,
39 * specifying the types of MIDI controllers about which you are interested in
40 * getting control-change notifications.
41 *
42 * @see MidiChannel#controlChange(int, int)
43 *
44 * @author Kara Kytle
45 */
46 public interface ControllerEventListener extends EventListener {
47
48 /**
49 * Invoked when a <code>Sequencer</code> has encountered and processed
50 * a control-change event of interest to this listener. The event passed
51 * in is a <code>ShortMessage</code> whose first data byte indicates
52 * the controller number and whose second data byte is the value to which
53 * the controller was set.
54 *
55 * @param event the control-change event that the sequencer encountered in
56 * the sequence it is processing
57 *
58 * @see Sequencer#addControllerEventListener(ControllerEventListener, int[])
59 * @see MidiChannel#controlChange(int, int)
60 * @see ShortMessage#getData1
61 * @see ShortMessage#getData2
62 */
63 public void controlChange(ShortMessage event);
64 }
Save This Page