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

public abstract Class ModelAbstractChannelMixer

extends Object
implements ModelChannelMixer
Class Inheritance
All Implemented Interfaces
com.sun.media.sound.ModelChannelMixer, javax.sound.midi.MidiChannel

ModelAbstractChannelMixer is ready for use class to implement ModelChannelMixer interface.
Author
Karl Helgason

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
allNotesOff()

Implements javax.sound.midi.MidiChannel.allNotesOff.

Turns off all notes that are currently sounding on this channel.

public void
allSoundOff()

Implements javax.sound.midi.MidiChannel.allSoundOff.

Immediately turns off all sounding notes on this channel, ignoring the state of the Hold Pedal and the internal decay rate of the current Instrument.

public void
controlChange(int controller, int value)

Implements javax.sound.midi.MidiChannel.controlChange.

Reacts to a change in the specified controller's value.

public int
getChannelPressure()

Implements javax.sound.midi.MidiChannel.getChannelPressure.

Obtains the channel's keyboard pressure.

public int
getController(int controller)

Implements javax.sound.midi.MidiChannel.getController.

Obtains the current value of the specified controller.

public boolean
getMono()

Implements javax.sound.midi.MidiChannel.getMono.

Obtains the current mono/poly mode.

public boolean
getMute()

Implements javax.sound.midi.MidiChannel.getMute.

Obtains the current mute state for this channel.

public boolean
getOmni()

Implements javax.sound.midi.MidiChannel.getOmni.

Obtains the current omni mode.

public int
getPitchBend()

Implements javax.sound.midi.MidiChannel.getPitchBend.

Obtains the upward or downward pitch offset for this channel.

public int
getPolyPressure(int noteNumber)

Implements javax.sound.midi.MidiChannel.getPolyPressure.

Obtains the pressure with which the specified key is being depressed.

public int
getProgram()

Implements javax.sound.midi.MidiChannel.getProgram.

Obtains the current program number for this channel.

public boolean
getSolo()

Implements javax.sound.midi.MidiChannel.getSolo.

Obtains the current solo state for this channel.

public boolean
localControl(boolean on)

Implements javax.sound.midi.MidiChannel.localControl.

Turns local control on or off.

public void
noteOff(int noteNumber)

Implements javax.sound.midi.MidiChannel.noteOff.

Turns the specified note off.

public void
noteOff(int noteNumber, int velocity)

Implements javax.sound.midi.MidiChannel.noteOff.

Turns the specified note off.

public void
noteOn(int noteNumber, int velocity)

Implements javax.sound.midi.MidiChannel.noteOn.

Starts the specified note sounding.

public abstract boolean
process(float[][] buffer, int offset, int len)

Redeclares com.sun.media.sound.ModelChannelMixer.process.

public void
programChange(int program)

Implements javax.sound.midi.MidiChannel.programChange.

Changes a program (patch).

public void
programChange(int bank, int program)

Implements javax.sound.midi.MidiChannel.programChange.

Changes the program using bank and program (patch) numbers.

public void
resetAllControllers()

Implements javax.sound.midi.MidiChannel.resetAllControllers.

Resets all the implemented controllers to their default values.

public void
setChannelPressure(int pressure)

Implements javax.sound.midi.MidiChannel.setChannelPressure.

Reacts to a change in the keyboard pressure.

public void
setMono(boolean on)

Implements javax.sound.midi.MidiChannel.setMono.

Turns mono mode on or off.

public void
setMute(boolean mute)

Implements javax.sound.midi.MidiChannel.setMute.

Sets the mute state for this channel.

public void
setOmni(boolean on)

Implements javax.sound.midi.MidiChannel.setOmni.

Turns omni mode on or off.

public void
setPitchBend(int bend)

Implements javax.sound.midi.MidiChannel.setPitchBend.

Changes the pitch offset for all notes on this channel.

public void
setPolyPressure(int noteNumber, int pressure)

Implements javax.sound.midi.MidiChannel.setPolyPressure.

Reacts to a change in the specified note's key pressure.

public void
setSolo(boolean soloState)

Implements javax.sound.midi.MidiChannel.setSolo.

Sets the solo state for this channel.

public abstract void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

ModelAbstractChannelMixerback to summary
public ModelAbstractChannelMixer()

Method Detail

allNotesOffback to summary
public void allNotesOff()

Implements javax.sound.midi.MidiChannel.allNotesOff.

Doc from javax.sound.midi.MidiChannel.allNotesOff.

Turns off all notes that are currently sounding on this channel. The notes might not die away instantaneously; their decay rate is determined by the internals of the Instrument. If the Hold Pedal controller (see controlChange) is down, the effect of this method is deferred until the pedal is released.

Annotations
@Override
allSoundOffback to summary
public void allSoundOff()

Implements javax.sound.midi.MidiChannel.allSoundOff.

Doc from javax.sound.midi.MidiChannel.allSoundOff.

Immediately turns off all sounding notes on this channel, ignoring the state of the Hold Pedal and the internal decay rate of the current Instrument.

Annotations
@Override
controlChangeback to summary
public void controlChange(int controller, int value)

Implements javax.sound.midi.MidiChannel.controlChange.

Doc from javax.sound.midi.MidiChannel.controlChange.

Reacts to a change in the specified controller's value. A controller is some control other than a keyboard key, such as a switch, slider, pedal, wheel, or breath-pressure sensor. The MIDI 1.0 Specification provides standard numbers for typical controllers on MIDI devices, and describes the intended effect for some of the controllers. The way in which an Instrument reacts to a controller change may be specific to the Instrument.

The MIDI 1.0 Specification defines both 7-bit controllers and 14-bit controllers. Continuous controllers, such as wheels and sliders, typically have 14 bits (two MIDI bytes), while discrete controllers, such as switches, typically have 7 bits (one MIDI byte). Refer to the specification to see the expected resolution for each type of control.

Controllers 64 through 95 (0x40 - 0x5F) allow 7-bit precision. The value of a 7-bit controller is set completely by the value argument. An additional set of controllers provide 14-bit precision by using two controller numbers, one for the most significant 7 bits and another for the least significant 7 bits. Controller numbers 0 through 31 (0x00 - 0x1F) control the most significant 7 bits of 14-bit controllers; controller numbers 32 through 63 (0x20 - 0x3F) control the least significant 7 bits of these controllers. For example, controller number 7 (0x07) controls the upper 7 bits of the channel volume controller, and controller number 39 (0x27) controls the lower 7 bits. The value of a 14-bit controller is determined by the interaction of the two halves. When the most significant 7 bits of a controller are set (using controller numbers 0 through 31), the lower 7 bits are automatically set to 0. The corresponding controller number for the lower 7 bits may then be used to further modulate the controller value.

It is possible that the underlying synthesizer does not support a specific controller message. In order to verify that a call to controlChange was successful, use getController.

Annotations
@Override
getChannelPressureback to summary
public int getChannelPressure()

Implements javax.sound.midi.MidiChannel.getChannelPressure.

Doc from javax.sound.midi.MidiChannel.getChannelPressure.

Obtains the channel's keyboard pressure.

If the device does not support setting channel pressure, this method always returns 0. Calling setChannelPressure will have no effect then.

Annotations
@Override
getControllerback to summary
public int getController(int controller)

Implements javax.sound.midi.MidiChannel.getController.

Doc from javax.sound.midi.MidiChannel.getController.

Obtains the current value of the specified controller. The return value is represented with 7 bits. For 14-bit controllers, the MSB and LSB controller value needs to be obtained separately. For example, the 14-bit value of the volume controller can be calculated by multiplying the value of controller 7 (0x07, channel volume MSB) with 128 and adding the value of controller 39 (0x27, channel volume LSB).

If the device does not support setting a specific controller, this method returns 0 for that controller. Calling controlChange will have no effect then.

Annotations
@Override
getMonoback to summary
public boolean getMono()

Implements javax.sound.midi.MidiChannel.getMono.

Doc from javax.sound.midi.MidiChannel.getMono.

Obtains the current mono/poly mode. Synthesizers that do not allow changing mono/poly mode will always return the same value, regardless of calls to setMono.

Annotations
@Override
getMuteback to summary
public boolean getMute()

Implements javax.sound.midi.MidiChannel.getMute.

Doc from javax.sound.midi.MidiChannel.getMute.

Obtains the current mute state for this channel. If the underlying synthesizer does not support muting this channel, this method always returns false.

Annotations
@Override
getOmniback to summary
public boolean getOmni()

Implements javax.sound.midi.MidiChannel.getOmni.

Doc from javax.sound.midi.MidiChannel.getOmni.

Obtains the current omni mode. Synthesizers that do not allow changing the omni mode will always return the same value, regardless of calls to setOmni.

Annotations
@Override
getPitchBendback to summary
public int getPitchBend()

Implements javax.sound.midi.MidiChannel.getPitchBend.

Doc from javax.sound.midi.MidiChannel.getPitchBend.

Obtains the upward or downward pitch offset for this channel. If the device does not support setting pitch bend, this method always returns 8192. Calling setPitchBend will have no effect then.

Annotations
@Override
getPolyPressureback to summary
public int getPolyPressure(int noteNumber)

Implements javax.sound.midi.MidiChannel.getPolyPressure.

Doc from javax.sound.midi.MidiChannel.getPolyPressure.

Obtains the pressure with which the specified key is being depressed.

If the device does not support setting poly pressure, this method always returns 0. Calling setPolyPressure will have no effect then.

Annotations
@Override
getProgramback to summary
public int getProgram()

Implements javax.sound.midi.MidiChannel.getProgram.

Doc from javax.sound.midi.MidiChannel.getProgram.

Obtains the current program number for this channel.

Annotations
@Override
getSoloback to summary
public boolean getSolo()

Implements javax.sound.midi.MidiChannel.getSolo.

Doc from javax.sound.midi.MidiChannel.getSolo.

Obtains the current solo state for this channel. If the underlying synthesizer does not support solo on this channel, this method always returns false.

Annotations
@Override
localControlback to summary
public boolean localControl(boolean on)

Implements javax.sound.midi.MidiChannel.localControl.

Doc from javax.sound.midi.MidiChannel.localControl.

Turns local control on or off. The default is for local control to be on. The "on" setting means that if a device is capable of both synthesizing sound and transmitting MIDI messages, it will synthesize sound in response to the note-on and note-off messages that it itself transmits. It will also respond to messages received from other transmitting devices. The "off" setting means that the synthesizer will ignore its own transmitted MIDI messages, but not those received from other devices.

It is possible that the underlying synthesizer does not support local control. In order to verify that a call to localControl was successful, check the return value.

Annotations
@Override
noteOffback to summary
public void noteOff(int noteNumber)

Implements javax.sound.midi.MidiChannel.noteOff.

Doc from javax.sound.midi.MidiChannel.noteOff.

Turns the specified note off.

Annotations
@Override
noteOffback to summary
public void noteOff(int noteNumber, int velocity)

Implements javax.sound.midi.MidiChannel.noteOff.

Doc from javax.sound.midi.MidiChannel.noteOff.

Turns the specified note off. The key-up velocity, if not ignored, can be used to affect how quickly the note decays. In any case, the note might not die away instantaneously; its decay rate is determined by the internals of the Instrument. If the Hold Pedal (a controller; see controlChange) is down, the effect of this method is deferred until the pedal is released.

Annotations
@Override
noteOnback to summary
public void noteOn(int noteNumber, int velocity)

Implements javax.sound.midi.MidiChannel.noteOn.

Doc from javax.sound.midi.MidiChannel.noteOn.

Starts the specified note sounding. The key-down velocity usually controls the note's volume and/or brightness. If velocity is zero, this method instead acts like noteOff(int), terminating the note.

Annotations
@Override
processback to summary
public abstract boolean process(float[][] buffer, int offset, int len)

Redeclares com.sun.media.sound.ModelChannelMixer.process.

Annotations
@Override
programChangeback to summary
public void programChange(int program)

Implements javax.sound.midi.MidiChannel.programChange.

Doc from javax.sound.midi.MidiChannel.programChange.

Changes a program (patch). This selects a specific instrument from the currently selected bank of instruments.

The MIDI specification does not dictate whether notes that are already sounding should switch to the new instrument (timbre) or continue with their original timbre until terminated by a note-off.

The program number is zero-based (expressed from 0 to 127). Note that MIDI hardware displays and literature about MIDI typically use the range 1 to 128 instead.

It is possible that the underlying synthesizer does not support a specific program. In order to verify that a call to programChange was successful, use getProgram.

Annotations
@Override
programChangeback to summary
public void programChange(int bank, int program)

Implements javax.sound.midi.MidiChannel.programChange.

Doc from javax.sound.midi.MidiChannel.programChange.

Changes the program using bank and program (patch) numbers.

It is possible that the underlying synthesizer does not support a specific bank, or program. In order to verify that a call to programChange was successful, use getProgram and getController. Since banks are changed by way of control changes, you can verify the current bank with the following statement:

  int bank = (getController(0) * 128) + getController(32);
Annotations
@Override
resetAllControllersback to summary
public void resetAllControllers()

Implements javax.sound.midi.MidiChannel.resetAllControllers.

Doc from javax.sound.midi.MidiChannel.resetAllControllers.

Resets all the implemented controllers to their default values.

Annotations
@Override
setChannelPressureback to summary
public void setChannelPressure(int pressure)

Implements javax.sound.midi.MidiChannel.setChannelPressure.

Doc from javax.sound.midi.MidiChannel.setChannelPressure.

Reacts to a change in the keyboard pressure. Channel pressure indicates how hard the keyboard player is depressing the entire keyboard. This can be the maximum or average of the per-key pressure-sensor values, as set by setPolyPressure. More commonly, it is a measurement of a single sensor on a device that doesn't implement polyphonic key pressure. Pressure can be used to control various aspects of the sound, as described under setPolyPressure.

It is possible that the underlying synthesizer does not support this MIDI message. In order to verify that setChannelPressure was successful, use getChannelPressure.

Annotations
@Override
setMonoback to summary
public void setMono(boolean on)

Implements javax.sound.midi.MidiChannel.setMono.

Doc from javax.sound.midi.MidiChannel.setMono.

Turns mono mode on or off. In mono mode, the channel synthesizes only one note at a time. In poly mode (identical to mono mode off), the channel can synthesize multiple notes simultaneously. The default is mono off (poly mode on).

"Mono" is short for the word "monophonic," which in this context is opposed to the word "polyphonic" and refers to a single synthesizer voice per MIDI channel. It has nothing to do with how many audio channels there might be (as in "monophonic" versus "stereophonic" recordings).

It is possible that the underlying synthesizer does not support mono mode. In order to verify that a call to setMono was successful, use getMono.

Annotations
@Override
setMuteback to summary
public void setMute(boolean mute)

Implements javax.sound.midi.MidiChannel.setMute.

Doc from javax.sound.midi.MidiChannel.setMute.

Sets the mute state for this channel. A value of true means the channel is to be muted, false means the channel can sound (if other channels are not soloed).

Unlike allSoundOff(), this method applies to only a specific channel, not to all channels. Further, it silences not only currently sounding notes, but also subsequently received notes.

It is possible that the underlying synthesizer does not support muting channels. In order to verify that a call to setMute was successful, use getMute.

Annotations
@Override
setOmniback to summary
public void setOmni(boolean on)

Implements javax.sound.midi.MidiChannel.setOmni.

Doc from javax.sound.midi.MidiChannel.setOmni.

Turns omni mode on or off. In omni mode, the channel responds to messages sent on all channels. When omni is off, the channel responds only to messages sent on its channel number. The default is omni off.

It is possible that the underlying synthesizer does not support omni mode. In order to verify that setOmni was successful, use getOmni.

Annotations
@Override
setPitchBendback to summary
public void setPitchBend(int bend)

Implements javax.sound.midi.MidiChannel.setPitchBend.

Doc from javax.sound.midi.MidiChannel.setPitchBend.

Changes the pitch offset for all notes on this channel. This affects all currently sounding notes as well as subsequent ones. (For pitch bend to cease, the value needs to be reset to the center position.)

The MIDI specification stipulates that pitch bend be a 14-bit value, where zero is maximum downward bend, 16383 is maximum upward bend, and 8192 is the center (no pitch bend). The actual amount of pitch change is not specified; it can be changed by a pitch-bend sensitivity setting. However, the General MIDI specification says that the default range should be two semitones up and down from center.

It is possible that the underlying synthesizer does not support this MIDI message. In order to verify that setPitchBend was successful, use getPitchBend.

Annotations
@Override
setPolyPressureback to summary
public void setPolyPressure(int noteNumber, int pressure)

Implements javax.sound.midi.MidiChannel.setPolyPressure.

Doc from javax.sound.midi.MidiChannel.setPolyPressure.

Reacts to a change in the specified note's key pressure. Polyphonic key pressure allows a keyboard player to press multiple keys simultaneously, each with a different amount of pressure. The pressure, if not ignored, is typically used to vary such features as the volume, brightness, or vibrato of the note.

It is possible that the underlying synthesizer does not support this MIDI message. In order to verify that setPolyPressure was successful, use getPolyPressure.

Annotations
@Override
setSoloback to summary
public void setSolo(boolean soloState)

Implements javax.sound.midi.MidiChannel.setSolo.

Doc from javax.sound.midi.MidiChannel.setSolo.

Sets the solo state for this channel. If solo is true only this channel and other soloed channels will sound. If solo is false then only other soloed channels will sound, unless no channels are soloed, in which case all unmuted channels will sound.

It is possible that the underlying synthesizer does not support solo channels. In order to verify that a call to setSolo was successful, use getSolo.

Annotations
@Override
stopback to summary
public abstract void stop()

Redeclares com.sun.media.sound.ModelChannelMixer.stop.

Annotations
@Override