Summary: Methods | Inherited Methods | [Expand All]

public interface

AudioSynthesizer

implements Synthesizer

com.sun.media.sound.AudioSynthesizer

Known Indirect Subclasses

SoftSynthesizer

Class Overview

AudioSynthesizer is a Synthesizer which renders it's output audio into SourceDataLine or AudioInputStream.

Summary

Public Methods
abstract AudioFormat	getFormat() Obtains the current format (encoding, sample rate, number of channels, etc.) of the synthesizer audio data.
abstract AudioSynthesizerPropertyInfo[]	getPropertyInfo(Map<String, Object> info) Gets information about the possible properties for the synthesizer.
abstract void	open(SourceDataLine line, Map<String, Object> info) Opens the synthesizer and starts rendering audio into `SourceDataLine`.
abstract AudioInputStream	openStream(AudioFormat targetFormat, Map<String, Object> info) Opens the synthesizer and renders audio into returned `AudioInputStream`.

[Expand]

Inherited Methods

From interface javax.sound.midi.MidiDevice

abstract void	close() Closes the device, indicating that the device should now release any system resources it is using.
abstract MidiDevice.Info	getDeviceInfo() Obtains information about the device, including its Java class and `Strings` containing its name, vendor, and description.
abstract int	getMaxReceivers() Obtains the maximum number of MIDI IN connections available on this MIDI device for receiving MIDI data.
abstract int	getMaxTransmitters() Obtains the maximum number of MIDI OUT connections available on this MIDI device for transmitting MIDI data.
abstract long	getMicrosecondPosition() Obtains the current time-stamp of the device, in microseconds.
abstract Receiver	getReceiver() Obtains a MIDI IN receiver through which the MIDI device may receive MIDI data.
abstract List<Receiver>	getReceivers() Returns all currently active, non-closed receivers connected with this MidiDevice.
abstract Transmitter	getTransmitter() Obtains a MIDI OUT connection from which the MIDI device will transmit MIDI data The returned transmitter must be closed when the application has finished using it.
abstract List<Transmitter>	getTransmitters() Returns all currently active, non-closed transmitters connected with this MidiDevice.
abstract boolean	isOpen() Reports whether the device is open.
abstract void	open() Opens the device, indicating that it should now acquire any system resources it requires and become operational.

From interface javax.sound.midi.Synthesizer

abstract Instrument[]	getAvailableInstruments() Obtains a list of instruments that come with the synthesizer.
abstract MidiChannel[]	getChannels() Obtains the set of MIDI channels controlled by this synthesizer.
abstract Soundbank	getDefaultSoundbank() Obtains the default soundbank for the synthesizer, if one exists.
abstract long	getLatency() Obtains the processing latency incurred by this synthesizer, expressed in microseconds.
abstract Instrument[]	getLoadedInstruments() Obtains a list of the instruments that are currently loaded onto this `Synthesizer`.
abstract int	getMaxPolyphony() Obtains the maximum number of notes that this synthesizer can sound simultaneously.
abstract VoiceStatus[]	getVoiceStatus() Obtains the current status of the voices produced by this synthesizer.
abstract boolean	isSoundbankSupported(Soundbank soundbank) Informs the caller whether this synthesizer is capable of loading instruments from the specified soundbank.
abstract boolean	loadAllInstruments(Soundbank soundbank) Loads onto the `Synthesizer` all instruments contained in the specified `Soundbank`.
abstract boolean	loadInstrument(Instrument instrument) Makes a particular instrument available for synthesis.
abstract boolean	loadInstruments(Soundbank soundbank, Patch[] patchList) Loads the instruments referenced by the specified patches, from the specified `Soundbank`.
abstract boolean	remapInstrument(Instrument from, Instrument to) Remaps an instrument.
abstract void	unloadAllInstruments(Soundbank soundbank) Unloads all instruments contained in the specified `Soundbank`.
abstract void	unloadInstrument(Instrument instrument) Unloads a particular instrument.
abstract void	unloadInstruments(Soundbank soundbank, Patch[] patchList) Unloads the instruments referenced by the specified patches, from the MIDI sound bank specified.

Public Methods

public abstract AudioFormat getFormat ()

Obtains the current format (encoding, sample rate, number of channels, etc.) of the synthesizer audio data.

If the synthesizer is not open and has never been opened, it returns the default format.

Returns

current audio data format

public abstract AudioSynthesizerPropertyInfo[] getPropertyInfo (Map<String, Object> info)

Gets information about the possible properties for the synthesizer.

Parameters

info	a proposed list of tag/value pairs that will be sent on open.

Returns

an array of AudioSynthesizerPropertyInfo objects describing possible properties. This array may be an empty array if no properties are required.

public abstract void open (SourceDataLine line, Map<String, Object> info)

Opens the synthesizer and starts rendering audio into SourceDataLine.

An application opening a synthesizer explicitly with this call has to close the synthesizer by calling close(). This is necessary to release system resources and allow applications to exit cleanly.

Note that some synthesizers, once closed, cannot be reopened. Attempts to reopen such a synthesizer will always result in a MidiUnavailableException.

Parameters

line	which `AudioSynthesizer` writes output audio into. If `line` is null, then line from system default mixer is used.
info	a `Map` object containing properties for additional configuration supported by synthesizer. If `info` is null then default settings are used.

Throws

MidiUnavailableException	thrown if the synthesizer cannot be opened due to resource restrictions.
SecurityException	thrown if the synthesizer cannot be opened due to security restrictions.

public abstract AudioInputStream openStream (AudioFormat targetFormat, Map<String, Object> info)

Opens the synthesizer and renders audio into returned AudioInputStream.

An application opening a synthesizer explicitly with this call has to close the synthesizer by calling close(). This is necessary to release system resources and allow applications to exit cleanly.

Note that some synthesizers, once closed, cannot be reopened. Attempts to reopen such a synthesizer will always result in a MidiUnavailableException.


  
      Parameters
      
        
          targetFormat
          specifies the AudioFormat
 used in returned AudioInputStream.
        
        
          info
          a Map object containing
 properties for additional configuration supported by synthesizer.
 If info is null then default settings are used.
        
      
  
  
      Throws
        
        
            MidiUnavailableException
            thrown if the synthesizer cannot be
 opened due to resource restrictions.
          
        
            SecurityException
            thrown if the synthesizer cannot be
 opened due to security restrictions.
        
      
  
  
      See Also
      close()
isOpen()















Generated by Doclava.

Interfaces

Classes

Exceptions

AudioSynthesizer

Class Overview

See Also

Summary

Public Methods

public abstract AudioFormat getFormat ()

Returns

See Also

public abstract AudioSynthesizerPropertyInfo[] getPropertyInfo (Map<String, Object> info)

Parameters

Returns

public abstract void open (SourceDataLine line, Map<String, Object> info)

Parameters

Throws

See Also

public abstract AudioInputStream openStream (AudioFormat targetFormat, Map<String, Object> info)

Parameters

Throws

See Also

targetFormat	specifies the `AudioFormat` used in returned `AudioInputStream`.
info	a `Map` object containing properties for additional configuration supported by synthesizer. If `info` is null then default settings are used.