javax.sound.midi
クラス MidiFileFormat

java.lang.Object
  javax.sound.midi.MidiFileFormat

public class MidiFileFormat
extends Object

MidiFileFormat オブジェクトは、MIDI ファイルの型を長さおよびタイミング情報とともにカプセル化します。

MidiFileFormat オブジェクトには、一式のプロパティを組み込むことができます。プロパティは、String 型のキーと、任意のオブジェクトを値として指定するプロパティ値のペアで構成されます。プロパティには、作成者や著作権など、付加的な情報のメタデータを指定します。プロパティはオプション情報なので、ファイルリーダおよびファイルリーダの実装でプロパティを提供したり認識したりすることは必須ではありません。

次の表に、実装で使用される一般的なプロパティの例を示します。

プロパティのキー	値の型	説明
「author」	String	このファイルの作成者の名前
「title」	String	このファイルのタイトル
「copyright」	String	著作権メッセージ
「date」	Date	録音またはリリースの日付
「comment」	String	任意のテキスト

関連項目:

MidiSystem.getMidiFileFormat(java.io.File), Sequencer.setSequence(java.io.InputStream stream)

フィールドの概要

protected int	byteLength MIDI ファイルの長さをバイトで表示したものです。
protected float	divisionType MIDI ファイルの分割形式です。
protected long	microsecondLength MIDI ファイルのデュレーションをマイクロ秒で表示したものです。
protected int	resolution MIDI ファイルのタイミング解像度です。
protected int	type MIDI ファイルの型です。
static int	UNKNOWN_LENGTH 長さが未知であることを表します。

コンストラクタの概要

MidiFileFormat(int type, float divisionType, int resolution, int bytes, long microseconds)
MidiFileFormat を構築します。

MidiFileFormat(int type, float divisionType, int resolution, int bytes, long microseconds, Map<String,Object> properties)
MidiFileFormat を、一式のプロパティを組み込んで構築します。

メソッドの概要

int	getByteLength() MIDI ファイルの長さを 8 ビットバイト単位で取得します。
float	getDivisionType() MIDI ファイルのタイミング分割形式を取得します。
long	getMicrosecondLength() MIDI ファイルの長さをマイクロ秒単位で取得します。
Object	getProperty(String key) 指定したキーのプロパティ値を取得します。
int	getResolution() MIDI ファイルのタイミング解像度を取得します。
int	getType() MIDI ファイル型を取得します。
Map<String,Object>	properties() プロパティのマップ (変更不可) を取得します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

UNKNOWN_LENGTH

public static final int UNKNOWN_LENGTH

長さが未知であることを表します。

関連項目:

getByteLength(), getMicrosecondLength(), 定数フィールド値

type

protected int type

MIDI ファイルの型です。

divisionType

protected float divisionType

MIDI ファイルの分割形式です。

関連項目:

Sequence.PPQ, Sequence.SMPTE_24, Sequence.SMPTE_25, Sequence.SMPTE_30DROP, Sequence.SMPTE_30

resolution

protected int resolution

MIDI ファイルのタイミング解像度です。

byteLength

protected int byteLength

MIDI ファイルの長さをバイトで表示したものです。

microsecondLength

protected long microsecondLength

MIDI ファイルのデュレーションをマイクロ秒で表示したものです。

コンストラクタの詳細

MidiFileFormat

public MidiFileFormat(int type,
                      float divisionType,
                      int resolution,
                      int bytes,
                      long microseconds)

MidiFileFormat を構築します。

パラメータ:

type - MIDI ファイルの型 (0、1、または 2)

divisionType - タイミング分割形式 (PPQ、または SMPTE 形式の 1 つ)

resolution - タイミング解像度

bytes - MIDI ファイルの長さ (バイト単位) か、長さが未知の場合は UNKNOWN_LENGTH

microseconds - MIDI ファイルのデュレーション (マイクロ秒単位) か、長さが未知の場合は UNKNOWN_LENGTH

関連項目:

UNKNOWN_LENGTH, Sequence.PPQ, Sequence.SMPTE_24, Sequence.SMPTE_25, Sequence.SMPTE_30DROP, Sequence.SMPTE_30

MidiFileFormat

public MidiFileFormat(int type,
                      float divisionType,
                      int resolution,
                      int bytes,
                      long microseconds,
                      Map<String,Object> properties)

MidiFileFormat を、一式のプロパティを組み込んで構築します。

パラメータ:

type - MIDI ファイルの型 (0、1、または 2)

divisionType - タイミング分割形式 (PPQ、または SMPTE 形式の 1 つ)

resolution - タイミング解像度

bytes - MIDI ファイルの長さ (バイト単位) か、長さが未知の場合は UNKNOWN_LENGTH

microseconds - MIDI ファイルのデュレーション (マイクロ秒単位) か、長さが未知の場合は UNKNOWN_LENGTH

properties - プロパティを指定した Map<String,Object> オブジェクト

導入されたバージョン:

1.5

関連項目:

UNKNOWN_LENGTH, Sequence.PPQ, Sequence.SMPTE_24, Sequence.SMPTE_25, Sequence.SMPTE_30DROP, Sequence.SMPTE_30

メソッドの詳細

getType

public int getType()

MIDI ファイル型を取得します。

戻り値:

ファイルの型 (0、1、または 2)

getDivisionType

public float getDivisionType()

MIDI ファイルのタイミング分割形式を取得します。

戻り値:

分割形式 (PPQ、または SMPTE 形式の 1 つ)

関連項目:

Sequence.Sequence(float, int), Sequence.PPQ, Sequence.SMPTE_24, Sequence.SMPTE_25, Sequence.SMPTE_30DROP, Sequence.SMPTE_30, Sequence.getDivisionType()

getResolution

public int getResolution()

MIDI ファイルのタイミング解像度を取得します。分割形式が PPQ の場合、解像度は 1 ビート当たりのティックで指定されます。SMTPE タイミングの場合、解像度は 1 フレーム当たりのティックで指定されます。

戻り値:

1 ビート当たり (PPQ) または 1 フレーム当たり (SMPTE) のティック数

関連項目:

getDivisionType(), Sequence.getResolution()

getByteLength

public int getByteLength()

MIDI ファイルの長さを 8 ビットバイト単位で取得します。

戻り値:

ファイルに含まれるバイト数か、バイト数が未知の場合は UNKNOWN_LENGTH

関連項目:

UNKNOWN_LENGTH

getMicrosecondLength

public long getMicrosecondLength()

MIDI ファイルの長さをマイクロ秒単位で取得します。

戻り値:

ファイルのデュレーション (マイクロ秒単位) か、長さが未知の場合は UNKNOWN_LENGTH

関連項目:

Sequence.getMicrosecondLength(), getByteLength(), UNKNOWN_LENGTH

properties

public Map<String,Object> properties()

プロパティのマップ (変更不可) を取得します。プロパティの概念について詳しくは、クラスの説明の中で解説します。

戻り値:

すべてのプロパティを含む Map<String,Object> オブジェクト。プロパティが 1 つも認識されない場合は、空のマップが返される

導入されたバージョン:

1.5

関連項目:

getProperty(String)

getProperty

public Object getProperty(String key)

指定したキーのプロパティ値を取得します。プロパティの概念について詳しくは、クラスの説明の中で解説します。

指定したプロパティが特定のファイル形式で定義されていない場合、このメソッドは null を返します。

パラメータ:

key - 望ましいプロパティのキー

戻り値:

指定されたキーを持つプロパティの値。そのプロパティが存在しない場合は null

導入されたバージョン:

1.5

関連項目:

properties