Receiver (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.sound.midi
interface Receiver

Most common way to construct:

Synthesizer synth = …;

Receiver receiver = synth.getReceiver();

Based on 15 examples

public interface Receiver

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.

Method Summary
`void`	`close()` Indicates that the application has finished using the receiver, and that limited resources it requires may be released or made available.
`void`	`send(MidiMessage message, long timeStamp)` Sends a MIDI message and time-stamp to this receiver.

Method Detail

close

public void close()

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}.

send

public void send(MidiMessage message,
                 long timeStamp)

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.

Parameters:: message - the MIDI message to send; timeStamp - the time-stamp for the message, in microseconds.