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

Class MidiFileFormat

public class MidiFileFormat
extends Object
Describe a MIDI file, including specifics about its type, length and timing.
Since:
1.3

Field Summary

static int
UNKNOWN_LENGTH
A special value indicating an unknown quantity.
protected int
byteLength
The size of the MIDI file in bytes.
protected float
divisionType
The division type of the MIDI file.
protected long
microsecondLength
The length of the MIDI file in microseconds.
protected int
resolution
The timing resolution of the MIDI file.
protected int
type
The MIDI file type.

Constructor Summary

MidiFileFormat(int type, float divisionType, int resolution, int bytes, long microseconds)
Create a MidiFileFormat object from the given parameters.

Method Summary

int
getByteLength()
Get the file length in bytes.
float
getDivisionType()
Get the file division type.
long
getMicrosecondLength()
Get the file length in microseconds.
int
getResolution()
Get the file timing resolution.
int
getType()
Get the MIDI file type (0, 1, or 2).

Methods inherited from class java.lang.Object

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

Field Details

UNKNOWN_LENGTH

public static final int UNKNOWN_LENGTH
A special value indicating an unknown quantity.
Field Value:
-1

byteLength

protected int byteLength
The size of the MIDI file in bytes.

divisionType

protected float divisionType
The division type of the MIDI file.

microsecondLength

protected long microsecondLength
The length of the MIDI file in microseconds.

resolution

protected int resolution
The timing resolution of the MIDI file.

type

protected int type
The MIDI file type. This is either 0, 1 or 2. Type 0 files contain a single track and represents a single song performance. Type 1 may contain multiple tracks for a single song performance. Type 2 may contain multiple tracks, each representing a separate song performance. See http://en.wikipedia.org/wiki/MIDI#MIDI_file_formats for more information.

Constructor Details

MidiFileFormat

public MidiFileFormat(int type,
                      float divisionType,
                      int resolution,
                      int bytes,
                      long microseconds)
Create a MidiFileFormat object from the given parameters.
Parameters:
type - the MIDI file type (0, 1, or 2)
divisionType - the MIDI file division type
resolution - the MIDI file timing resolution
bytes - the MIDI file size in bytes
microseconds - the MIDI file length in microseconds

Method Details

getByteLength

public int getByteLength()
Get the file length in bytes.
Returns:
the file length in bytes or UNKNOWN_LENGTH

getDivisionType

public float getDivisionType()
Get the file division type.
Returns:
the file divison type

getMicrosecondLength

public long getMicrosecondLength()
Get the file length in microseconds.
Returns:
the file length in microseconds or UNKNOWN_LENGTH

getResolution

public int getResolution()
Get the file timing resolution. If the division type is PPQ, then this is value represents ticks per beat, otherwise it's ticks per frame (SMPTE).
Returns:
the timing resolution in ticks per beat or ticks per frame

getType

public int getType()
Get the MIDI file type (0, 1, or 2).
Returns:
the MIDI file type (0, 1, or 2)
MidiFileFormat.java -- Information about a MIDI file 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