javax.sound.sampled.spi

Class FormatConversionProvider

java.lang.Object

javax.sound.sampled.spi.FormatConversionProvider

public abstract class FormatConversionProvider
extends Object

A format conversion provider supplies methods for converting between different audio formats. This abstract class defines the interface to this functionality; concrete subclasses will implement the methods declared here.

Since:

1.3

Constructor Summary

Constructors

Constructor and Description
FormatConversionProvider() Create a new format conversion provider.

Method Summary

Methods

Modifier and Type	Method and Description
abstract AudioInputStream	getAudioInputStream(AudioFormat.Encoding encoding, AudioInputStream source) Return an audio input stream given the desired target encoding and another audio input stream.
abstract AudioInputStream	getAudioInputStream(AudioFormat format, AudioInputStream source) Return an audio input stream given the desired target format and another audio input stream.
abstract AudioFormat.Encoding[]	getSourceEncodings() Return an array of all the source encodings supported by this conversion provider.
abstract AudioFormat.Encoding[]	getTargetEncodings() Return an array of all the target encodings supported by this conversion provider.
abstract AudioFormat.Encoding[]	getTargetEncodings(AudioFormat fmt) Return an array of all the target encodings that are available for a given source format.
abstract AudioFormat[]	getTargetFormats(AudioFormat.Encoding targ, AudioFormat src) Return a array of all the target formats that match given target encoding, and to which this provider can convert the source format.
boolean	isConversionSupported(AudioFormat.Encoding targ, AudioFormat src) Return true if this provider supports conversion from the given source format to the given target encoding.
boolean	isConversionSupported(AudioFormat targ, AudioFormat src) Return true if this provider supports conversions from the given source format to the given target format.
boolean	isSourceEncodingSupported(AudioFormat.Encoding src) Return true if an encoding matching the argument is supported as a source encoding by this provider.
boolean	isTargetEncodingSupported(AudioFormat.Encoding targ) Return true if an encoding matching the argument is supported as a target encoding by this provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormatConversionProvider

public FormatConversionProvider()

Create a new format conversion provider.

Method Detail

getAudioInputStream

public abstract AudioInputStream getAudioInputStream(AudioFormat.Encoding encoding,
                                   AudioInputStream source)

Return an audio input stream given the desired target encoding and another audio input stream. The data in the given stream will be converted to the desired encoding.

Parameters:

encoding - the encoding

source - the source audio input stream

Returns:

a new audio input stream

Throws:

IllegalArgumentException - if the conversion is not supported

getAudioInputStream

public abstract AudioInputStream getAudioInputStream(AudioFormat format,
                                   AudioInputStream source)

Return an audio input stream given the desired target format and another audio input stream. The data in the given stream will be converted to the desired format.

Parameters:

format - the format

source - the source audio input stream

Returns:

a new audio input stream

Throws:

IllegalArgumentException - if the conversion is not supported

getSourceEncodings

public abstract AudioFormat.Encoding[] getSourceEncodings()

Return an array of all the source encodings supported by this conversion provider.

getTargetEncodings

public abstract AudioFormat.Encoding[] getTargetEncodings()

Return an array of all the target encodings supported by this conversion provider.

getTargetEncodings

public abstract AudioFormat.Encoding[] getTargetEncodings(AudioFormat fmt)

Return an array of all the target encodings that are available for a given source format.

Parameters:

fmt - the source format

Returns:

an array of supported target encodings

getTargetFormats

public abstract AudioFormat[] getTargetFormats(AudioFormat.Encoding targ,
                             AudioFormat src)

Return a array of all the target formats that match given target encoding, and to which this provider can convert the source format.

Parameters:

targ - the target encoding to match

src - the source format

Returns:

an array of supported target formats

isConversionSupported

public boolean isConversionSupported(AudioFormat.Encoding targ,
                            AudioFormat src)

Return true if this provider supports conversion from the given source format to the given target encoding.

Parameters:

targ - the target encoding

src - the source format

Returns:

true if the conversion is supported

isConversionSupported

public boolean isConversionSupported(AudioFormat targ,
                            AudioFormat src)

Return true if this provider supports conversions from the given source format to the given target format.

Parameters:

targ - the source format

src - the target format

Returns:

true if the conversion is supported

isSourceEncodingSupported

public boolean isSourceEncodingSupported(AudioFormat.Encoding src)

Return true if an encoding matching the argument is supported as a source encoding by this provider.

Parameters:

src - the source encoding

Returns:

true if it is supported

isTargetEncodingSupported

public boolean isTargetEncodingSupported(AudioFormat.Encoding targ)

Return true if an encoding matching the argument is supported as a target encoding by this provider.

Parameters:

targ - the target encoding

Returns:

true if it is supported