javax.sound.sampled

Class AudioFileFormat

public class AudioFileFormat extends Object

This describes an audio file, including information about its length, the format of the audio data, and other things.

Since: 1.3

Nested Class Summary
static classAudioFileFormat.Type
An instance of this type describes a standard audio file format.
Constructor Summary
AudioFileFormat(AudioFileFormat.Type type, AudioFormat fmt, int frameLen)
Create a new AudioFileFormat given the type, the format, and the frame length.
AudioFileFormat(AudioFileFormat.Type type, AudioFormat fmt, int frameLen, Map<String,Object> properties)
Create a new AudioFileFormat given the type, the format, the frame length, and some properties.
protected AudioFileFormat(AudioFileFormat.Type type, int byteLen, AudioFormat fmt, int frameLen)
Create a new AudioFileFormat given the type, the byte length, the format, and the frame length.
Method Summary
intgetByteLength()
Return the byte length of this file format.
AudioFormatgetFormat()
Return the AudioFormat associated with this file format.
intgetFrameLength()
Return the frame length of this file format.
ObjectgetProperty(String key)
Return the value of a property defined in this format.
AudioFileFormat.TypegetType()
Return the Type associated with this file format.
Map<String,Object>properties()
Return the properties associated with this format, as a Map.
StringtoString()
Return a description of this AudioFileFormat.

Constructor Detail

AudioFileFormat

public AudioFileFormat(AudioFileFormat.Type type, AudioFormat fmt, int frameLen)
Create a new AudioFileFormat given the type, the format, and the frame length. The new object will have an unspecified byte length, and an empty properties map.

Parameters: type the type fmt the format frameLen the frame length

AudioFileFormat

public AudioFileFormat(AudioFileFormat.Type type, AudioFormat fmt, int frameLen, Map<String,Object> properties)
Create a new AudioFileFormat given the type, the format, the frame length, and some properties. The new object will have an unspecified byte length. A copy of the properties argument will be made, so changes to the map passed in will not affect the new AudioFileFormat.

Parameters: type the type fmt the format frameLen the frame length properties the properties

AudioFileFormat

protected AudioFileFormat(AudioFileFormat.Type type, int byteLen, AudioFormat fmt, int frameLen)
Create a new AudioFileFormat given the type, the byte length, the format, and the frame length. The new object will have an empty properties map.

Parameters: type the type byteLen the byte length fmt the format frameLen the frame length

Method Detail

getByteLength

public int getByteLength()
Return the byte length of this file format.

getFormat

public AudioFormat getFormat()
Return the AudioFormat associated with this file format.

getFrameLength

public int getFrameLength()
Return the frame length of this file format.

getProperty

public Object getProperty(String key)
Return the value of a property defined in this format.

Parameters: key the property name

Returns: the value of the property, or null if the property is not defined

getType

public AudioFileFormat.Type getType()
Return the Type associated with this file format.

properties

public Map<String,Object> properties()
Return the properties associated with this format, as a Map. The returned Map is unmodifiable.

toString

public String toString()
Return a description of this AudioFileFormat.