1 /* 2 * Copyright (c) 1999, 2003, Oracle and/or its affiliates. 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. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package javax.sound.midi; 27 28 29 /** 30 * A <code>Receiver</code> receives <code>{@link MidiEvent}</code> objects and 31 * typically does something useful in response, such as interpreting them to 32 * generate sound or raw MIDI output. Common MIDI receivers include 33 * synthesizers and MIDI Out ports. 34 * 35 * @see MidiDevice 36 * @see Synthesizer 37 * @see Transmitter 38 * 39 * @author Kara Kytle 40 */ 41 public interface Receiver extends AutoCloseable { 42 43 44 //$$fb 2002-04-12: fix for 4662090: Contradiction in Receiver specification 45 /** 46 * Sends a MIDI message and time-stamp to this receiver. 47 * If time-stamping is not supported by this receiver, the time-stamp 48 * value should be -1. 49 * @param message the MIDI message to send 50 * @param timeStamp the time-stamp for the message, in microseconds. 51 * @throws IllegalStateException if the receiver is closed 52 */ 53 public void send(MidiMessage message, long timeStamp); 54 55 /** 56 * Indicates that the application has finished using the receiver, and 57 * that limited resources it requires may be released or made available. 58 * 59 * <p>If the creation of this <code>Receiver</code> resulted in 60 * implicitly opening the underlying device, the device is 61 * implicitly closed by this method. This is true unless the device is 62 * kept open by other <code>Receiver</code> or <code>Transmitter</code> 63 * instances that opened the device implicitly, and unless the device 64 * has been opened explicitly. If the device this 65 * <code>Receiver</code> is retrieved from is closed explicitly by 66 * calling {@link MidiDevice#close MidiDevice.close}, the 67 * <code>Receiver</code> is closed, too. For a detailed 68 * description of open/close behaviour see the class description 69 * of {@link javax.sound.midi.MidiDevice MidiDevice}. 70 * 71 * @see javax.sound.midi.MidiSystem#getReceiver 72 */ 73 public void close(); 74 }