public abstract class

FormatConversionProvider

extends Object
java.lang.Object
   ↳ javax.sound.sampled.spi.FormatConversionProvider
Known Direct Subclasses

Class Overview

A format conversion provider provides format conversion services from one or more input formats to one or more output formats. Converters include codecs, which encode and/or decode audio data, as well as transcoders, etc. Format converters provide methods for determining what conversions are supported and for obtaining an audio stream from which converted data can be read.

The source format represents the format of the incoming audio data, which will be converted.

The target format represents the format of the processed, converted audio data. This is the format of the data that can be read from the stream returned by one of the getAudioInputStream methods.

Summary

Public Constructors
FormatConversionProvider()
Public Methods
abstract AudioInputStream getAudioInputStream(AudioFormat.Encoding targetEncoding, AudioInputStream sourceStream)
Obtains an audio input stream with the specified encoding from the given audio input stream.
abstract AudioInputStream getAudioInputStream(AudioFormat targetFormat, AudioInputStream sourceStream)
Obtains an audio input stream with the specified format from the given audio input stream.
abstract Encoding[] getSourceEncodings()
Obtains the set of source format encodings from which format conversion services are provided by this provider.
abstract Encoding[] getTargetEncodings(AudioFormat sourceFormat)
Obtains the set of target format encodings supported by the format converter given a particular source format.
abstract Encoding[] getTargetEncodings()
Obtains the set of target format encodings to which format conversion services are provided by this provider.
abstract AudioFormat[] getTargetFormats(AudioFormat.Encoding targetEncoding, AudioFormat sourceFormat)
Obtains the set of target formats with the encoding specified supported by the format converter If no target formats with the specified encoding are supported for this source format, an array of length 0 is returned.
boolean isConversionSupported(AudioFormat.Encoding targetEncoding, AudioFormat sourceFormat)
Indicates whether the format converter supports conversion to a particular encoding from a particular format.
boolean isConversionSupported(AudioFormat targetFormat, AudioFormat sourceFormat)
Indicates whether the format converter supports conversion to one particular format from another.
boolean isSourceEncodingSupported(AudioFormat.Encoding sourceEncoding)
Indicates whether the format converter supports conversion from the specified source format encoding.
boolean isTargetEncodingSupported(AudioFormat.Encoding targetEncoding)
Indicates whether the format converter supports conversion to the specified target format encoding.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public FormatConversionProvider ()

Public Methods

public abstract AudioInputStream getAudioInputStream (AudioFormat.Encoding targetEncoding, AudioInputStream sourceStream)

Obtains an audio input stream with the specified encoding from the given audio input stream.

Parameters
targetEncoding desired encoding of the stream after processing
sourceStream stream from which data to be processed should be read
Returns
  • stream from which processed data with the specified target encoding may be read
Throws
IllegalArgumentException if the format combination supplied is not supported.

public abstract AudioInputStream getAudioInputStream (AudioFormat targetFormat, AudioInputStream sourceStream)

Obtains an audio input stream with the specified format from the given audio input stream.

Parameters
targetFormat desired data format of the stream after processing
sourceStream stream from which data to be processed should be read
Returns
  • stream from which processed data with the specified format may be read
Throws
IllegalArgumentException if the format combination supplied is not supported.

public abstract Encoding[] getSourceEncodings ()

Obtains the set of source format encodings from which format conversion services are provided by this provider.

Returns
  • array of source format encodings. The array will always have a length of at least 1.

public abstract Encoding[] getTargetEncodings (AudioFormat sourceFormat)

Obtains the set of target format encodings supported by the format converter given a particular source format. If no target format encodings are supported for this source format, an array of length 0 is returned.

Returns
  • array of supported target format encodings.

public abstract Encoding[] getTargetEncodings ()

Obtains the set of target format encodings to which format conversion services are provided by this provider.

Returns
  • array of target format encodings. The array will always have a length of at least 1.

public abstract AudioFormat[] getTargetFormats (AudioFormat.Encoding targetEncoding, AudioFormat sourceFormat)

Obtains the set of target formats with the encoding specified supported by the format converter If no target formats with the specified encoding are supported for this source format, an array of length 0 is returned.

Returns
  • array of supported target formats.

public boolean isConversionSupported (AudioFormat.Encoding targetEncoding, AudioFormat sourceFormat)

Indicates whether the format converter supports conversion to a particular encoding from a particular format.

Parameters
targetEncoding desired encoding of the outgoing data
sourceFormat format of the incoming data
Returns
  • true if the conversion is supported, otherwise false

public boolean isConversionSupported (AudioFormat targetFormat, AudioFormat sourceFormat)

Indicates whether the format converter supports conversion to one particular format from another.

Parameters
targetFormat desired format of outgoing data
sourceFormat format of the incoming data
Returns
  • true if the conversion is supported, otherwise false

public boolean isSourceEncodingSupported (AudioFormat.Encoding sourceEncoding)

Indicates whether the format converter supports conversion from the specified source format encoding.

Parameters
sourceEncoding the source format encoding for which support is queried
Returns
  • true if the encoding is supported, otherwise false

public boolean isTargetEncodingSupported (AudioFormat.Encoding targetEncoding)

Indicates whether the format converter supports conversion to the specified target format encoding.

Parameters
targetEncoding the target format encoding for which support is queried
Returns
  • true if the encoding is supported, otherwise false