java.lang.Object
javax.sound.sampled.spi.AudioFileWriter
Provider for audio file writing services. Classes providing concrete
implementations can write one or more types of audio file from an audio
stream.
- Since:
- 1.3
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract AudioFileFormat.Type[]
Obtains the file types for which file writing support is provided by this audio file writer.abstract AudioFileFormat.Type[]
getAudioFileTypes
(AudioInputStream stream) Obtains the file types that this audio file writer can write from the audio input stream specified.boolean
isFileTypeSupported
(AudioFileFormat.Type fileType) Indicates whether file writing support for the specified file type is provided by this audio file writer.boolean
isFileTypeSupported
(AudioFileFormat.Type fileType, AudioInputStream stream) Indicates whether an audio file of the type specified can be written from the audio input stream indicated.abstract 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.abstract 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.
-
Constructor Details
-
AudioFileWriter
protected AudioFileWriter()Constructor for subclasses to call.
-
-
Method Details
-
getAudioFileTypes
Obtains the file types for which file writing support is provided by this audio file writer.- Returns:
- array of file types. If no file types are supported, an array of length 0 is returned.
-
isFileTypeSupported
Indicates whether file writing support for the specified file type is provided by this audio file writer.- Parameters:
fileType
- the file type for which write capabilities are queried- Returns:
true
if the file type is supported, otherwisefalse
- Throws:
NullPointerException
- iffileType
isnull
-
getAudioFileTypes
Obtains the file types that this audio file writer can write from the audio input stream specified.- 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.
- Throws:
NullPointerException
- ifstream
isnull
-
isFileTypeSupported
Indicates whether an audio file of the type specified can be written from the audio input stream indicated.- Parameters:
fileType
- file type for which write capabilities are queriedstream
- for which file writing support is queried- Returns:
true
if the file type is supported for this audio input stream, otherwisefalse
- Throws:
NullPointerException
- iffileType
orstream
arenull
-
write
public abstract 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 anIOException
if the length in the audio file format isAudioSystem.NOT_SPECIFIED
.- Parameters:
stream
- the audio input stream containing audio data to be written to the output streamfileType
- file type to be written to the output streamout
- 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 occursIllegalArgumentException
- if the file type is not supported by the systemNullPointerException
- ifstream
orfileType
orout
arenull
- See Also:
-
write
public abstract 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.- Parameters:
stream
- the audio input stream containing audio data to be written to the filefileType
- file type to be written to the fileout
- 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 occursIllegalArgumentException
- if the file format is not supported by the systemNullPointerException
- ifstream
orfileType
orout
arenull
- See Also:
-