Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

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 class
AudioFileFormat.Type
An instance of this type describes a standard audio file format.

Constructor Summary

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.
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 properties)
Create a new AudioFileFormat given the type, the format, the frame length, and some properties.

Method Summary

Map
Object> properties()
Return the properties associated with this format, as a Map.
int
getByteLength()
Return the byte length of this file format.
AudioFormat
getFormat()
Return the AudioFormat associated with this file format.
int
getFrameLength()
Return the frame length of this file format.
Object
getProperty(String key)
Return the value of a property defined in this format.
AudioFileFormat.Type
getType()
Return the Type associated with this file format.
String
toString()
Return a description of this AudioFileFormat.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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

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 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

Method Details

Object> properties

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

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.

toString

public String toString()
Return a description of this AudioFileFormat.
Overrides:
toString in interface Object
Audio file format Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About