javax.sound.sampled.spi

Class AudioFileWriter

java.lang.Object

javax.sound.sampled.spi.AudioFileWriter

public abstract class AudioFileWriter
extends java.lang.Object

This abstract class provides an API for writing audio files. Concrete subclasses implement the methods declared here.

Since:

1.3

Constructor Summary

Constructors

Constructor and Description
AudioFileWriter() Creat a new audio file writer.

Method Summary

Methods

Modifier and Type	Method and Description
abstract javax.sound.sampled.AudioFileFormat.Type[]	getAudioFileTypes() Return an array of all audio file format types supported by this provider.
abstract javax.sound.sampled.AudioFileFormat.Type[]	getAudioFileTypes(javax.sound.sampled.AudioInputStream ais) Return an array of all the audio file format types supported by this provider, which can be written given the input stream.
boolean	isFileTypeSupported(javax.sound.sampled.AudioFileFormat.Type type) Return true if the indicated type is supported by this provider.
boolean	isFileTypeSupported(javax.sound.sampled.AudioFileFormat.Type type, javax.sound.sampled.AudioInputStream ais) Return true if the indicated type is supported by this provider, and can be written from the given audio input stream.
abstract int	write(javax.sound.sampled.AudioInputStream ais, javax.sound.sampled.AudioFileFormat.Type type, java.io.File out) Write audio data to a file.
abstract int	write(javax.sound.sampled.AudioInputStream ais, javax.sound.sampled.AudioFileFormat.Type type, java.io.OutputStream os) Write audio data to an output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AudioFileWriter

public AudioFileWriter()

Creat a new audio file writer.

Method Detail

getAudioFileTypes

public abstract javax.sound.sampled.AudioFileFormat.Type[] getAudioFileTypes()

Return an array of all audio file format types supported by this provider.

getAudioFileTypes

public abstract javax.sound.sampled.AudioFileFormat.Type[] getAudioFileTypes(javax.sound.sampled.AudioInputStream ais)

Return an array of all the audio file format types supported by this provider, which can be written given the input stream.

Parameters:

ais - the audio input stream

isFileTypeSupported

public boolean isFileTypeSupported(javax.sound.sampled.AudioFileFormat.Type type)

Return true if the indicated type is supported by this provider.

Parameters:

type - the audio file format type

isFileTypeSupported

public boolean isFileTypeSupported(javax.sound.sampled.AudioFileFormat.Type type,
                          javax.sound.sampled.AudioInputStream ais)

Return true if the indicated type is supported by this provider, and can be written from the given audio input stream.

Parameters:

type - the audio file format type

ais - the audio input stream to write

write

public abstract int write(javax.sound.sampled.AudioInputStream ais,
        javax.sound.sampled.AudioFileFormat.Type type,
        java.io.File out)
                   throws java.io.IOException

Write audio data to a file.

Parameters:

ais - the audio input stream to write

type - the desired audio file format type

out - the file to write to

Returns:

the number of bytes written

Throws:

java.io.IOException - if an I/O error occurs when writing

write

public abstract int write(javax.sound.sampled.AudioInputStream ais,
        javax.sound.sampled.AudioFileFormat.Type type,
        java.io.OutputStream os)
                   throws java.io.IOException

Write audio data to an output stream.

Parameters:

ais - the audio input stream to write

type - the desired audio file format type

os - the output stream

Returns:

the number of bytes written

Throws:

java.io.IOException - if an I/O error occurs when writing