パッケージ com.lmt.lib.bms.bemusic
クラス BeMusic
- Object
-
- BeMusic
-
public class BeMusic extends Object
BeMusicクラスは、ライブラリ上で使用するAPIや定数値などを定義するためのプレースホルダの役割を果たします。当クラスはインスタンスを生成することを想定していません。全てのメンバは静的メンバとして宣言されています。 宣言されたメンバの詳細については、それらのメンバの説明を参照してください。
-
-
フィールドの概要
フィールド 修飾子とタイプ フィールド 説明 static int
KEY1
static int
KEY1_LN
static int
KEY10
static int
KEY10_LN
static int
KEY11
static int
KEY11_LN
static int
KEY12
static int
KEY12_LN
static int
KEY13
static int
KEY13_LN
static int
KEY14
static int
KEY14_LN
static int
KEY2
static int
KEY2_LN
static int
KEY3
static int
KEY3_LN
static int
KEY4
static int
KEY4_LN
static int
KEY5
static int
KEY5_LN
static int
KEY6
static int
KEY6_LN
static int
KEY7
static int
KEY7_LN
static int
KEY8
static int
KEY8_LN
static int
KEY9
static int
KEY9_LN
static int
SCRATCH1
static int
SCRATCH1_LN
static int
SCRATCH2
static int
SCRATCH2_LN
static int
TOTAL_NOTES
-
コンストラクタの概要
コンストラクタ コンストラクタ 説明 BeMusic()
-
メソッドの概要
すべてのメソッド staticメソッド concreteメソッド 修飾子とタイプ メソッド 説明 static BeMusicContent
createContent()
新しいBeMusicコンテンツオブジェクトを生成します。static BmsSpec
getSpec()
BeMusicのBMS仕様を取得します。static void
initialize(int specVersion, BmsMeta[] objectMetas, BmsChannel[] userChannels)
BeMusicライブラリを初期化します。static boolean
isInitialized()
BeMusicライブラリが初期化されているかどうかを返します。static BeMusicContent
loadContent(byte[] bms)
指定されたバイト配列からBeMusicコンテンツを読み込みます。static BeMusicContent
loadContent(File file)
指定されたファイルからBeMusicコンテンツを読み込みます。static BeMusicContent
loadContent(InputStream stream)
指定された入力ストリームからBeMusicコンテンツを読み込みます。static BeMusicContent
loadContent(Reader reader)
指定されたReaderからBeMusicコンテンツを読み込みます。static BeMusicContent
loadContent(String bms)
指定されたBMS文字列からBeMusicコンテンツを読み込みます。static BeMusicContent
loadContent(Path path)
指定されたパスからBeMusicコンテンツを読み込みます。
-
-
-
フィールドの詳細
-
KEY1
public static final int KEY1
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY1を示します。- 関連項目:
- 定数フィールド値
-
KEY2
public static final int KEY2
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY2を示します。- 関連項目:
- 定数フィールド値
-
KEY3
public static final int KEY3
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY3を示します。- 関連項目:
- 定数フィールド値
-
KEY4
public static final int KEY4
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY4を示します。- 関連項目:
- 定数フィールド値
-
KEY5
public static final int KEY5
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY5を示します。- 関連項目:
- 定数フィールド値
-
KEY6
public static final int KEY6
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY6を示します。- 関連項目:
- 定数フィールド値
-
KEY7
public static final int KEY7
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY7を示します。- 関連項目:
- 定数フィールド値
-
KEY8
public static final int KEY8
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY1を示します。- 関連項目:
- 定数フィールド値
-
KEY9
public static final int KEY9
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY2を示します。- 関連項目:
- 定数フィールド値
-
KEY10
public static final int KEY10
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY3を示します。- 関連項目:
- 定数フィールド値
-
KEY11
public static final int KEY11
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY4を示します。- 関連項目:
- 定数フィールド値
-
KEY12
public static final int KEY12
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY5を示します。- 関連項目:
- 定数フィールド値
-
KEY13
public static final int KEY13
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY6を示します。- 関連項目:
- 定数フィールド値
-
KEY14
public static final int KEY14
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY7を示します。- 関連項目:
- 定数フィールド値
-
SCRATCH1
public static final int SCRATCH1
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのSCRATCHを示します。- 関連項目:
- 定数フィールド値
-
SCRATCH2
public static final int SCRATCH2
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのSCRATCHを示します。- 関連項目:
- 定数フィールド値
-
KEY1_LN
public static final int KEY1_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY1におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY2_LN
public static final int KEY2_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY2におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY3_LN
public static final int KEY3_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY3におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY4_LN
public static final int KEY4_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY4におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY5_LN
public static final int KEY5_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY5におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY6_LN
public static final int KEY6_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY6におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY7_LN
public static final int KEY7_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのKEY7におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY8_LN
public static final int KEY8_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY1におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY9_LN
public static final int KEY9_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY2におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY10_LN
public static final int KEY10_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY3におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY11_LN
public static final int KEY11_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY4におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY12_LN
public static final int KEY12_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY5におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY13_LN
public static final int KEY13_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY6におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
KEY14_LN
public static final int KEY14_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのKEY7におけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
SCRATCH1_LN
public static final int SCRATCH1_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。1PのSCRATCHにおけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
SCRATCH2_LN
public static final int SCRATCH2_LN
BeMusicContent.getVisibleNoteCount(int)
の引数。2PのSCRATCHにおけるロングノートを示します。- 関連項目:
- 定数フィールド値
-
TOTAL_NOTES
public static final int TOTAL_NOTES
BeMusicContent.getVisibleNoteCount(int)
の引数。総ノート数を示します。- 関連項目:
- 定数フィールド値
-
-
メソッドの詳細
-
initialize
public static void initialize(int specVersion, BmsMeta[] objectMetas, BmsChannel[] userChannels)
BeMusicライブラリを初期化します。アプリケーションがBeMusicライブラリを使用する際は、必ず当メソッドを1回呼ばなければなりません。BeMusicライブラリは当メソッドで指定された パラメータでライブラリの初期化を行います。
初期化処理では、アプリケーションが指定したパラメータを用い、BeMusicライブラリで使用するBMS仕様を初期化します。以後、BeMusicコンテンツを 読み込む際はこのBMS仕様に従います。
任意型メタ情報、およびユーザーチャンネルは、アプリケーションの都合に応じて定義してください。これらの定義が不要な場合はnullを指定しても 構いません。メタ情報に任意型以外のメタ情報を指定したり、ユーザーチャンネルに仕様チャンネルを含めたりすると初期化が失敗するので注意してください。 また、同じ構成単位で同じ名前のメタ情報が存在したり、同じチャンネル番号を持つユーザーチャンネルが存在したりなど、BMS仕様のルールに違反した場合も 例外がスローされます。詳しくはBmsSpecBuilder#createを参照してください。
- パラメータ:
specVersion
- BeMusicのBMS仕様バージョン。BeMusicSpec
にバージョンの定数値の定義があります。objectMetas
- BMS仕様に含める任意型メタ情報のリストuserChannels
- BMS仕様に含めるユーザーチャンネルのリスト- 例外:
IllegalStateException
- 初期化済みで当メソッドを呼び出したIllegalArgumentException
- specVersionに未知の値を指定したIllegalArgumentException
- objectMetasのリスト内に任意型以外のメタ情報が含まれていたIllegalArgumentException
- userChannelsのリスト内に仕様チャンネルが含まれていた
-
isInitialized
public static boolean isInitialized()
BeMusicライブラリが初期化されているかどうかを返します。BeMusicライブラリの初期化は
initialize(int, com.lmt.lib.bms.BmsMeta[], com.lmt.lib.bms.BmsChannel[])
で行います。- 戻り値:
- BeMusicライブラリが初期化済みの場合true
-
getSpec
public static BmsSpec getSpec()
BeMusicのBMS仕様を取得します。- 戻り値:
- BeMusicのBMS仕様
- 例外:
IllegalStateException
- BeMusicライブラリが初期化されていない
-
createContent
public static BeMusicContent createContent()
新しいBeMusicコンテンツオブジェクトを生成します。BMS仕様は
getSpec()
で取得可能なオブジェクトを使用します。- 戻り値:
- BeMusicコンテンツオブジェクト
- 例外:
IllegalStateException
- BeMusicライブラリが初期化されていない
-
loadContent
public static BeMusicContent loadContent(File file) throws BmsException
指定されたファイルからBeMusicコンテンツを読み込みます。- パラメータ:
file
- BMSファイル- 戻り値:
- BeMusicコンテンツオブジェクト
- 例外:
IllegalStateException
- BeMusicライブラリが初期化されていないBmsException
- fileがnull: Cause NullPointerExceptionBmsException
- BMS宣言にてencoding指定時、指定の文字セットが未知: Cause ExceptionBmsException
- その他、IOエラーなどでファイルアクセスに失敗した場合BmsAbortException
- BMS解析エラーが発生した
-
loadContent
public static BeMusicContent loadContent(Path path) throws BmsException
指定されたパスからBeMusicコンテンツを読み込みます。- パラメータ:
path
- BMSファイルのパス- 戻り値:
- BeMusicコンテンツオブジェクト
- 例外:
IllegalStateException
- BeMusicライブラリが初期化されていないBmsException
- pathがnull: Cause NullPointerExceptionBmsException
- その他、IOエラーなどでパスが示すコンテンツへのアクセスに失敗した場合BmsAbortException
- BMS解析エラーが発生した
-
loadContent
public static BeMusicContent loadContent(InputStream stream) throws BmsException
指定された入力ストリームからBeMusicコンテンツを読み込みます。- パラメータ:
stream
- BMSの入力ストリーム- 戻り値:
- BeMusicコンテンツオブジェクト
- 例外:
IllegalStateException
- BeMusicライブラリが初期化されていないBmsException
- streamがnull: Cause NullPointerExceptionBmsException
- その他、IOエラーなどでストリームが示すコンテンツへのアクセスに失敗した場合BmsAbortException
- BMS解析エラーが発生した
-
loadContent
public static BeMusicContent loadContent(Reader reader) throws BmsException
指定されたReaderからBeMusicコンテンツを読み込みます。- パラメータ:
reader
- BMSのReader- 戻り値:
- BeMusicコンテンツオブジェクト
- 例外:
IllegalStateException
- BeMusicライブラリが初期化されていないBmsException
- readerがnull: Cause NullPointerExceptionBmsAbortException
- BMS解析エラーが発生した
-
loadContent
public static BeMusicContent loadContent(byte[] bms) throws BmsException
指定されたバイト配列からBeMusicコンテンツを読み込みます。- パラメータ:
bms
- BMSのバイト配列- 戻り値:
- BeMusicコンテンツオブジェクト
- 例外:
IllegalStateException
- BeMusicライブラリが初期化されていないBmsException
- bmsがnull: Cause NullPointerExceptionBmsAbortException
- BMS解析エラーが発生した
-
loadContent
public static BeMusicContent loadContent(String bms) throws BmsException
指定されたBMS文字列からBeMusicコンテンツを読み込みます。- パラメータ:
bms
- BMS文字列- 戻り値:
- BeMusicコンテンツオブジェクト
- 例外:
IllegalStateException
- BeMusicライブラリが初期化されていないBmsException
- bmsがnull: Cause NullPointerExceptionBmsAbortException
- BMS解析エラーが発生した
-
-