/*
* @(#)Receiver.java 1.21 03/12/19
*
* Copyright 2004 Sun Microsystems, Inc. All rights reserved.
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*/
package javax.sound.midi;
/**
* A Receiver
receives {@link MidiEvent}
objects and
* typically does something useful in response, such as interpreting them to
* generate sound or raw MIDI output. Common MIDI receivers include
* synthesizers and MIDI Out ports.
*
* @see MidiDevice
* @see Synthesizer
* @see Transmitter
*
* @version 1.21, 03/12/19
* @author Kara Kytle
*/
public interface Receiver {
//$$fb 2002-04-12: fix for 4662090: Contradiction in Receiver specification
/**
* Sends a MIDI message and time-stamp to this receiver.
* If time-stamping is not supported by this receiver, the time-stamp
* value should be -1.
* @param message the MIDI message to send
* @param timeStamp the time-stamp for the message, in microseconds.
* @throws IllegalStateException if the receiver is closed
*/
public void send(MidiMessage message, long timeStamp);
/**
* Indicates that the application has finished using the receiver, and
* that limited resources it requires may be released or made available.
*
*
If the creation of this Receiver
resulted in
* implicitly opening the underlying device, the device is
* implicitly closed by this method. This is true unless the device is
* kept open by other Receiver
or Transmitter
* instances that opened the device implicitly, and unless the device
* has been opened explicitly. If the device this
* Receiver
is retrieved from is closed explicitly by
* calling {@link MidiDevice#close MidiDevice.close}, the
* Receiver
is closed, too. For a detailed
* description of open/close behaviour see the class description
* of {@link javax.sound.midi.MidiDevice MidiDevice}.
*
* @see javax.sound.midi.MidiSystem#getReceiver
*/
public void close();
}