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