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 | 
- Since:
- 1.3
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classAn instance of theTypeclass represents one of the standard types of audio file.
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedAudioFileFormat(AudioFileFormat.Type type, int byteLength, AudioFormat format, int frameLength) Constructs an audio file format object.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> properties) Construct an audio file format object with a set of defined properties.
- 
Method SummaryModifier and TypeMethodDescriptionintObtains the size in bytes of the entire audio file (not just its audio data).Obtains the format of the audio data contained in the audio file.intObtains the length of the audio data contained in the file, expressed in sample frames.getProperty(String key) Obtain the property value specified by the key.getType()Obtains the audio file type, such asWAVEorAU.Obtain an unmodifiable map of properties.toString()Returns a string representation of the audio file format.
- 
Constructor Details- 
AudioFileFormatprotected AudioFileFormat(AudioFileFormat.Type type, int byteLength, AudioFormat format, int frameLength) 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
- byteLength- the length of the file in bytes, or- AudioSystem.NOT_SPECIFIED
- format- the format of the audio data contained in the file
- frameLength- the audio data length in sample frames, or- AudioSystem.NOT_SPECIFIED
- See Also:
 
- 
AudioFileFormatConstructs 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
- format- the format of the audio data contained in the file
- frameLength- the audio data length in sample frames, or- AudioSystem.NOT_SPECIFIED
 
- 
AudioFileFormatpublic AudioFileFormat(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. The properties map will be copied to prevent any changes to it.- Parameters:
- type- the type of the audio file
- format- the format of the audio data contained in the file
- frameLength- the audio data length in sample frames, or- AudioSystem.NOT_SPECIFIED
- properties- a- Map<String, Object>object with properties
- Since:
- 1.5
 
 
- 
- 
Method Details- 
getTypeObtains the audio file type, such asWAVEorAU.- Returns:
- the audio file type
- See Also:
 
- 
getByteLengthpublic int getByteLength()Obtains the size in bytes of the entire audio file (not just its audio data).- Returns:
- the audio file length in bytes
- See Also:
 
- 
getFormatObtains the format of the audio data contained in the audio file.- Returns:
- the audio data format
 
- 
getFrameLengthpublic int getFrameLength()Obtains the length of the audio data contained in the file, expressed in sample frames.- Returns:
- the number of sample frames of audio data in the file
- See Also:
 
- 
propertiesObtain an unmodifiable map of properties. The concept of properties is further explained in theclass description.- Returns:
- a Map<String, Object>object containing all properties. If no properties are recognized, an empty map is returned.
- Since:
- 1.5
- See Also:
 
- 
getPropertyObtain the property value specified by the key. The concept of properties is further explained in theclass 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
- Returns:
- the value of the property with the specified key, or nullif the property does not exist
- Since:
- 1.5
- See Also:
 
- 
toStringReturns a string representation of the audio file format.
 
-