java.lang.Object javax.sound.sampled.AudioFileFormat
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:
Property key | Value type | Description |
---|---|---|
"duration" | Long | playback duration of the file in microseconds |
"author" | String | name of the author of this file |
"title" | String | title of this file |
"copyright" | String | copyright message |
"date" | Date | date of the recording or release |
"comment" | String | an arbitrary text |
Nested Class Summary | |
---|---|
static class |
AudioFileFormat.Type
An instance of the Type class represents one of the standard types of audio file. |
Constructor Summary | |
---|---|
AudioFileFormat
(
AudioFileFormat.Type
type,
AudioFormat
format, int frameLength) Constructs an audio file format object. |
|
AudioFileFormat
(
AudioFileFormat.Type
type,
AudioFormat
format, int frameLength,
Map
<
String
,
Object
Construct an audio file format object with a set of defined properties. |
|
protected |
AudioFileFormat
(
AudioFileFormat.Type
type, int byteLength,
AudioFormat
format, int frameLength) Constructs an audio file format object. |
Method Summary | |
---|---|
int |
getByteLength
() Obtains the size in bytes of the entire audio file (not just its audio data). |
AudioFormat |
getFormat
() Obtains the format of the audio data contained in the audio file. |
int |
getFrameLength
() Obtains the length of the audio data contained in the file, expressed in sample frames. |
Object |
getProperty
(
String
Obtain the property value specified by the key. |
AudioFileFormat.Type |
getType
() Obtains the audio file type, such as WAVE or AU. |
Map < String , Object |
properties
()
Obtain an unmodifiable map of properties. |
String |
toString
() Provides a string representation of the file format. |
Methods inherited from class java.lang. Object |
---|
clone , equals , finalize , getClass , hashCode , notify , notifyAll , wait , wait , wait |
Constructor Detail |
---|
protected AudioFileFormat(AudioFileFormat.Type type, int byteLength, AudioFormat format, int frameLength)
public AudioFileFormat(AudioFileFormat.Type type, AudioFormat format, int frameLength)
public AudioFileFormat ( AudioFileFormat.Type type, AudioFormat format, int frameLength, Map< String, Object> properties)
Method Detail |
---|
public AudioFileFormat.Type getType()
public int getByteLength()
public AudioFormat getFormat()
public int getFrameLength()
public Map< String, Object> properties ()
public ObjectgetProperty ( String key)
If the specified property is not defined for a particular file format, this method returns null.
public String toString()