Class SpeexAudioFileWriter

java.lang.Object

javax.sound.sampled.spi.AudioFileWriter

javaforce.codec.speex.spi.SpeexAudioFileWriter

public class SpeexAudioFileWriter
extends AudioFileWriter

Provider for Speex audio file writing services. This implementation can write Speex audio files from an audio stream.

Version:

$Revision$

Author:

Marc Gimpel, Wimba S.A. (mgimpel@horizonwimba.com)

Field Summary

Fields

Modifier and Type	Field	Description
static final AudioFileFormat.Type[]	NO_FORMAT
static final AudioFileFormat.Type[]	SPEEX_FORMAT

Constructor Summary

Constructors

Constructor	Description
SpeexAudioFileWriter()

Method Summary

Modifier and Type	Method	Description
AudioFileFormat.Type[]	getAudioFileTypes()	Obtains the file types for which file writing support is provided by this audio file writer.
AudioFileFormat.Type[]	getAudioFileTypes(AudioInputStream stream)	Obtains the file types that this audio file writer can write from the audio input stream specified.
int	write(AudioInputStream stream, AudioFileFormat.Type fileType, File out)	Writes a stream of bytes representing an audio file of the file format indicated to the external file provided.
int	write(AudioInputStream stream, AudioFileFormat.Type fileType, OutputStream out)	Writes a stream of bytes representing an audio file of the file type indicated to the output stream provided.

Methods inherited from class javax.sound.sampled.spi.AudioFileWriter

isFileTypeSupported, isFileTypeSupported

Methods inherited from class java.lang.Object

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

Field Details

NO_FORMAT

public static final AudioFileFormat.Type[] NO_FORMAT

SPEEX_FORMAT

public static final AudioFileFormat.Type[] SPEEX_FORMAT

Constructor Details

SpeexAudioFileWriter

public SpeexAudioFileWriter()

Method Details

getAudioFileTypes

public AudioFileFormat.Type[] getAudioFileTypes()

Obtains the file types for which file writing support is provided by this audio file writer.

Specified by:

getAudioFileTypes in class AudioFileWriter

Returns:

array of file types. If no file types are supported, an array of length 0 is returned.

getAudioFileTypes

public AudioFileFormat.Type[] getAudioFileTypes(AudioInputStream stream)

Obtains the file types that this audio file writer can write from the audio input stream specified.

Specified by:

getAudioFileTypes in class AudioFileWriter

Parameters:

stream - - the audio input stream for which audio file type support is queried.

Returns:

array of file types. If no file types are supported, an array of length 0 is returned.

write

public int write(AudioInputStream stream,
 AudioFileFormat.Type fileType,
 OutputStream out)
          throws IOException

Writes a stream of bytes representing an audio file of the file type indicated to the output stream provided. Some file types require that the length be written into the file header, and cannot be written from start to finish unless the length is known in advance. An attempt to write such a file type will fail with an IOException if the length in the audio file format is AudioSystem.NOT_SPECIFIED.

Specified by:

write in class AudioFileWriter

Parameters:

stream - - the audio input stream containing audio data to be written to the output stream.

fileType - - file type to be written to the output stream.

out - - stream to which the file data should be written.

Returns:

the number of bytes written to the output stream.

Throws:

IOException - - if an I/O exception occurs.

IllegalArgumentException - - if the file type is not supported by the system.

See Also:

• AudioFileWriter.isFileTypeSupported(AudioFileFormat.Type, AudioInputStream)
• getAudioFileTypes()

write

public int write(AudioInputStream stream,
 AudioFileFormat.Type fileType,
 File out)
          throws IOException

Writes a stream of bytes representing an audio file of the file format indicated to the external file provided.

Specified by:

write in class AudioFileWriter

Parameters:

stream - - the audio input stream containing audio data to be written to the file.

fileType - - file type to be written to the file.

out - - external file to which the file data should be written.

Returns:

the number of bytes written to the file.

Throws:

IOException - - if an I/O exception occurs.

IllegalArgumentException - - if the file format is not supported by the system

See Also:

• AudioFileWriter.isFileTypeSupported(javax.sound.sampled.AudioFileFormat.Type)
• getAudioFileTypes()