パッケージ com.lmt.lib.bms.bemusic

クラス BeMusicSpec

  • public class BeMusicSpec
extends Object
    Be-MusicのBMS仕様を表します。

    当クラスは、Be-MusicのBMS仕様に関連する定義のプレースホルダの役割を果たします。 そのため、インスタンスを生成することを想定していません。

    当クラスの役割は、ライブラリの利用者が希望する形式でのBe-Music用BMS仕様(BmsSpec)を提供すること、 またはそのBMS仕様を用いて一般的なBMSファイル読み込み機能を提供することにあります。

    • フィールドの詳細

      • V1

        public static final int V1
        Be-MusicのBMS仕様バージョン(V1)を表します。
        関連項目:
        定数フィールド値

      • LATEST_VERSION

        public static final int LATEST_VERSION
        Be-Music用BMS仕様の最新バージョン
        関連項目:
        定数フィールド値

      • LATEST

        public static final BmsSpec LATEST
        最新バージョンのBe-Music用BMS仕様です。

        このBMS仕様はLATEST_VERSIONに対応したものです。任意型メタ情報、ユーザーチャンネルは何も指定されていません。

    • コンストラクタの詳細

      • BeMusicSpec

        public BeMusicSpec()

    • メソッドの詳細

      • create

        public static BmsSpec create​(int specVersion,
                             BmsMeta[] objectMetas,
                             BmsChannel[] userChannels)
        Be-Music用のBMS仕様を生成します。
        パラメータ:
        specVersion - BMS仕様のバージョン
        objectMetas - BMS仕様に含める任意型メタ情報のリスト
        userChannels - BMS仕様に含めるユーザーチャンネルのリスト
        戻り値:
        BeMusic用のBMS仕様
        例外:
        IllegalArgumentException - specVersionに未知の値を指定した
        IllegalArgumentException - objectMetasのリスト内に任意型以外のメタ情報が含まれていた
        IllegalArgumentException - userChannelsのリスト内に仕様チャンネルが含まれていた

      • createV1

        public static BmsSpec createV1​(BmsMeta[] objectMetas,
                               BmsChannel[] userChannels)
        V1のBeMusic用BMS仕様を生成します。
        パラメータ:
        objectMetas - BMS仕様に含める任意型メタ情報のリスト
        userChannels - BMS仕様に含めるユーザーチャンネルのリスト
        戻り値:
        BeMusic用のBMS仕様
        例外:
        IllegalArgumentException - objectMetasのリスト内に任意型以外のメタ情報が含まれていた
        IllegalArgumentException - userChannelsのリスト内に仕様チャンネルが含まれていた

      • createLatest

        public static BmsSpec createLatest​(Collection<BmsMeta> objectMetas,
                                   Collection<BmsChannel> userChannels)
        最新バージョンのBe-Music用BMS仕様を生成します。

        当メソッドは、最新バージョンのBe-Music用BMS仕様に任意型メタ情報かユーザーチャンネル、 またはその両方を付加して生成したい時のヘルパーメソッドです。

        任意型メタ情報、ユーザーチャンネルのコレクションにnullを指定すると何も付加されずにBMS仕様が生成されます。

        パラメータ:
        objectMetas - 任意型メタ情報のコレクション
        userChannels - ユーザーチャンネルのコレクション
        戻り値:
        最新バージョンのBe-Music用BMS仕様
        例外:
        NullPointerException - objectMetasのコレクション内にnullが含まれていた
        NullPointerException - userChannelsのコレクション内にnullが含まれていた
        IllegalArgumentException - objectMetasのコレクション内に任意型以外のメタ情報が含まれていた
        IllegalArgumentException - userChannelsのコレクション内に仕様チャンネルが含まれていた

      • loadContentFrom

        @Deprecated(since="0.7.0")
public static BmsContent loadContentFrom​(Path path,
                                         boolean strictly)
                                  throws BmsException,
                                         IOException
        推奨されていません。
        当メソッドはBMS Library ver.0.7.0以降、非推奨になりました。
        最新バージョンのBe-Music用BMS仕様を用いて指定パスのファイルからBMSコンテンツを読み込みます。

        当メソッドはBeMusic.loadContentFrom(Path, Long, boolean)を乱数の固定化なしで呼び出します。

        パラメータ:
        path - 読み込み対象のBMSファイルのパス
        strictly - 厳格なフォーマットチェックを行うかどうか
        戻り値:
        最新バージョンのBe-Music用BMS仕様で読み込まれたBMSコンテンツ
        例外:
        NullPointerException - pathがnull
        IOException - 指定されたファイルが見つからない、読み取り権限がない、または読み取り中に異常を検出した
        BmsException - 読み込み処理中に想定外の例外がスローされた
        関連項目:
        BeMusic.loadContentFrom(Path, Long, boolean)