パッケージ hajimeapi4j.api.endpoint

インタフェース MusicEndPoint

すべてのスーパーインタフェース:
EndPoint, RestAction<EndPoint>
既知の実装クラスのリスト:
MusicEndPointImpl
public interface MusicEndPoint extends EndPoint
エンドポイント「/music」にて取得できる情報を定義したインターフェースです

musicエンドポイントではエンドユーザーの指定によって出力される情報が変化するため、特に理由付けがなされていないかぎりOptionalでラップされています。

導入されたバージョン:
5.0.0.0-Alpha.1
関連項目:

  • メソッドの詳細

    • getRemix

      @CheckReturnValue Optional<List<EndPoint>> getRemix()
      指定された楽曲IDがリミックス楽曲である場合に、原曲の情報を出力します。

      その他のリミックス情報は出力しませんのでお気をつけください。

      戻り値:
      リミックス元楽曲の、原曲情報

    • getOriginal

      @CheckReturnValue Optional<List<EndPoint>> getOriginal()
      指定された楽曲IDがオリジナル楽曲である場合に、リミックスバージョン一覧を出力します。

      getRemix()メソッドとの混同にお気をつけください。

      戻り値:
      リミックスバージョンの一覧

    • getLyrics

      @CheckReturnValue Optional<List<EndPoint>> getLyrics()
      作詞者の情報を出力します。

      1人での作業の場合もList形式となります。

      戻り値:
      楽曲に携わった作詞者情報

    • getComposer

      @CheckReturnValue Optional<List<EndPoint>> getComposer()
      リアレンジ楽曲を含む、作曲者情報を出力します。

      一人での作業の場合もList形式となります。

      戻り値:
      楽曲に携わった作曲者情報

    • getArrange

      @CheckReturnValue Optional<List<EndPoint>> getArrange()
      リアレンジ楽曲のアレンジメント含む、編曲者情報を出力します。

      一人での作業の場合もList形式となります。

      戻り値:
      楽曲に携わった編曲者情報

    • getLyricsUrl

      @CheckReturnValue Optional<String> getLyricsUrl()
      歌詞が存在する曲について、歌詞サイトのURLを取得します。

      リミックス楽曲では出力されないため、適宜原曲情報から参照する必要があります。

      戻り値:
      歌詞サイトへのリンクURL

    • getMember

      @Nonnull List<Member> getMember()
      CD、配信、ゲーム内参加メンバーを取得します。

      この情報はnullになりえません。

      戻り値:
      参加メンバー一覧

    • getDigitalReleaseExists

      boolean getDigitalReleaseExists()
      指定された楽曲が、デジタル配信されているかどうかを取得します。
      戻り値:
      デジタル配信が存在する場合は true、存在しない場合はfalse

    • getDisc

      @CheckReturnValue Optional<List<Disc>> getDisc()
      楽曲が収録されたCD情報を全て返します。
      戻り値:
      Listに詰められたCD収録情報

    • getLive

      @CheckReturnValue Optional<List<Live>> getLive()
      指定された楽曲が披露されたライブの情報を出力します。
      戻り値:
      披露された全てのライブの情報