| java.lang.Object
 javax.sound.sampled.AudioFileFormat
| AudioFileFormat | | public class AudioFileFormat (Code) | | An instance of the AudioFileFormat class describes
an audio file, including the file type, the file's length in bytes,
the length in sample frames of the audio data contained in the file,
and the format of the audio data.
The
AudioSystem class includes methods for determining the format
of an audio file, obtaining an audio input stream from an audio file, and
writing an audio file from an audio input stream.
An AudioFileFormat object can
include a set of properties. A property is a pair of key and value:
the key is of type String, the associated property
value is an arbitrary object.
Properties specify additional informational
meta data (like a author, copyright, or file duration).
Properties are optional information, and file reader and file
writer implementations are not required to provide or
recognize properties.
The following table lists some common properties that should
be used in implementations:
author:
David Rivas
author:
Kara Kytle
author:
Florian Bomers
version:
1.29 07/05/05
See Also: AudioInputStream
since:
1.3 |
| Inner Class :public static class Type | |
| Constructor Summary | |
| protected | AudioFileFormat(Type type, int byteLength, AudioFormat format, int frameLength)
Constructs an audio file format object. | | public | AudioFileFormat(Type type, AudioFormat format, int frameLength)
Constructs an audio file format object. | | public | AudioFileFormat(Type type, AudioFormat format, int frameLength, Map<String, Object> properties)
Construct an audio file format object with a set of
defined properties.
This public constructor may be used by applications to describe the
properties of a requested audio file. |
| Method Summary | |
| public int | getByteLength()
Obtains the size in bytes of the entire audio file (not just its audio data). | | public AudioFormat | getFormat()
Obtains the format of the audio data contained in the audio file. | | public int | getFrameLength()
Obtains the length of the audio data contained in the file, expressed in sample frames. | | public Object | getProperty(String key)
Obtain the property value specified by the key. | | public Type | getType()
Obtains the audio file type, such as WAVE or AU. | | public Map<String, Object> | properties()
Obtain an unmodifiable map of properties.
The concept of properties is further explained in
the
AudioFileFormat class description .
a Map<String,Object> object containingall properties. | | public String | toString()
Provides a string representation of the file format. |
| AudioFileFormat | | protected AudioFileFormat(Type type, int byteLength, AudioFormat format, int frameLength)(Code) | | Constructs an audio file format object.
This protected constructor is intended for use by providers of file-reading
services when returning information about an audio file or about supported audio file
formats.
Parameters:
type - the type of the audio file
Parameters:
byteLength - the length of the file in bytes, or AudioSystem.NOT_SPECIFIED
Parameters:
format - the format of the audio data contained in the file
Parameters:
frameLength - the audio data length in sample frames, or AudioSystem.NOT_SPECIFIED
See Also: AudioFileFormat.getType |
| AudioFileFormat | | public AudioFileFormat(Type type, AudioFormat format, int frameLength)(Code) | | Constructs an audio file format object.
This public constructor may be used by applications to describe the
properties of a requested audio file.
Parameters:
type - the type of the audio file
Parameters:
format - the format of the audio data contained in the file
Parameters:
frameLength - the audio data length in sample frames, or AudioSystem.NOT_SPECIFIED |
| AudioFileFormat | | public AudioFileFormat(Type type, AudioFormat format, int frameLength, Map<String, Object> properties)(Code) | | Construct an audio file format object with a set of
defined properties.
This public constructor may be used by applications to describe the
properties of a requested audio file. The properties map
will be copied to prevent any changes to it.
Parameters:
type - the type of the audio file
Parameters:
format - the format of the audio data contained in the file
Parameters:
frameLength - the audio data length in sample frames, orAudioSystem.NOT_SPECIFIED
Parameters:
properties - a Map<String,Object> objectwith properties
since:
1.5 |
| getByteLength | | public int getByteLength()(Code) | | Obtains the size in bytes of the entire audio file (not just its audio data).
the audio file length in bytes
See Also: AudioSystem.NOT_SPECIFIED |
| getFormat | | public AudioFormat getFormat()(Code) | | Obtains the format of the audio data contained in the audio file.
the audio data format |
| getFrameLength | | public int getFrameLength()(Code) | | Obtains the length of the audio data contained in the file, expressed in sample frames.
the number of sample frames of audio data in the file
See Also: AudioSystem.NOT_SPECIFIED |
| getProperty | | public Object getProperty(String key)(Code) | | Obtain the property value specified by the key.
The concept of properties is further explained in
the
AudioFileFormat class description .
If the specified property is not defined for a
particular file format, this method returns
null.
Parameters:
key - the key of the desired property the value of the property with the specified key,or null if the property does not exist.
See Also: AudioFileFormat.properties()
since:
1.5 |
| getType | | public Type getType()(Code) | | Obtains the audio file type, such as WAVE or AU.
the audio file type
See Also: Type.WAVE
See Also: Type.AU
See Also: Type.AIFF
See Also: Type.AIFC
See Also: Type.SND |
| toString | | public String toString()(Code) | | Provides a string representation of the file format.
the file format as a string |
|
|