APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.media.sound

public final Class MidiDeviceTransmitterEnvelope

extends Object
implements MidiDeviceTransmitter
Class Inheritance
All Implemented Interfaces
javax.sound.midi.MidiDeviceTransmitter, javax.sound.midi.Transmitter, java.lang.AutoCloseable
Imports
javax.sound.midi.MidiDevice, .MidiDeviceTransmitter, .Receiver, .Transmitter
Helper class which allows to convert Transmitter to MidiDeviceTransmitter.
Author
Alex Menkov

Field Summary

Modifier and TypeField and Description
private final MidiDevice
device

private final Transmitter
transmitter

Constructor Summary

AccessConstructor and Description
public
MidiDeviceTransmitterEnvelope(MidiDevice
the owner MidiDevice
device, Transmitter
the Transmitter to be enveloped
transmitter)

Creates a new MidiDeviceTransmitterEnvelope object which envelops the specified Transmitter and is owned by the specified MidiDevice.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements javax.sound.midi.Transmitter.close.

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

public MidiDevice
getMidiDevice()

Implements javax.sound.midi.MidiDeviceTransmitter.getMidiDevice.

Obtains a MidiDevice object which is an owner of this Transmitter.

public Receiver
getReceiver()

Implements javax.sound.midi.Transmitter.getReceiver.

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

public Transmitter

Returns:

the enveloped transmitter
getTransmitter()

Obtains the transmitter enveloped by this MidiDeviceTransmitterEnvelope object.

public void
setReceiver(Receiver receiver)

Implements javax.sound.midi.Transmitter.setReceiver.

Sets the receiver to which this transmitter will deliver MIDI messages.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

deviceback to summary
private final MidiDevice device
transmitterback to summary
private final Transmitter transmitter

Constructor Detail

MidiDeviceTransmitterEnvelopeback to summary
public MidiDeviceTransmitterEnvelope(MidiDevice device, Transmitter transmitter)

Creates a new MidiDeviceTransmitterEnvelope object which envelops the specified Transmitter and is owned by the specified MidiDevice.

Parameters
device:MidiDevice

the owner MidiDevice

transmitter:Transmitter

the Transmitter to be enveloped

Method Detail

closeback to summary
public void close()

Implements javax.sound.midi.Transmitter.close.

Doc from javax.sound.midi.Transmitter.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 MidiDevice.close, the Transmitter is closed, too. For a detailed description of open/close behaviour see the class description of MidiDevice.

Annotations
@Override
getMidiDeviceback to summary
public MidiDevice getMidiDevice()

Implements javax.sound.midi.MidiDeviceTransmitter.getMidiDevice.

Doc from javax.sound.midi.MidiDeviceTransmitter.getMidiDevice.

Obtains a MidiDevice object which is an owner of this Transmitter.

Annotations
@Override
getReceiverback to summary
public Receiver getReceiver()

Implements javax.sound.midi.Transmitter.getReceiver.

Doc from javax.sound.midi.Transmitter.getReceiver.

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

Annotations
@Override
getTransmitterback to summary
public Transmitter getTransmitter()

Obtains the transmitter enveloped by this MidiDeviceTransmitterEnvelope object.

Returns:Transmitter

the enveloped transmitter

setReceiverback to summary
public void setReceiver(Receiver receiver)

Implements javax.sound.midi.Transmitter.setReceiver.

Doc from javax.sound.midi.Transmitter.setReceiver.

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

Annotations
@Override