Transmitter (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 Transmitter

Most common way to construct:

Sequencer sequencer = …;

Transmitter transmitter = sequencer.getTransmitter();

Based on 20 examples

public interface Transmitter

A Transmitter sends {@link MidiEvent} objects to one or more {@link Receiver Receivers}. Common MIDI transmitters include sequencers and MIDI input ports.

Method Summary
`void`	`close()` Indicates that the application has finished using the transmitter, and that limited resources it requires may be released or made available.
`Receiver`	`getReceiver()` Obtains the current receiver to which this transmitter will deliver MIDI messages.
`void`	`setReceiver(Receiver receiver)` Sets the receiver to which this transmitter will deliver MIDI messages.

Method Detail

close

public void close()

Indicates that the application has finished using the transmitter, and that limited resources it requires may be released or made available.

If the creation of this Transmitter 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 Transmitter is retrieved from is closed explicitly by calling {@link MidiDevice#close MidiDevice.close}, the Transmitter is closed, too. For a detailed description of open/close behaviour see the class description of {@link javax.sound.midi.MidiDevice MidiDevice}.

getReceiver

public Receiver getReceiver()

Obtains the current receiver to which this transmitter will deliver MIDI messages.

Returns:: the current receiver. If no receiver is currently set, returns null

setReceiver

public void setReceiver(Receiver receiver)

Sets the receiver to which this transmitter will deliver MIDI messages. If a receiver is currently set, it is replaced with this one.

Parameters:: receiver - the desired receiver.