Interface ActiveSongBackgroundMusicBuilder

public interface ActiveSongBackgroundMusicBuilder
A service provider which provides the musical phrases of the active song, which are built in some background task.

  • Method Details

    • getDefault

      static ActiveSongBackgroundMusicBuilder getDefault()
      Get the default implementation.
      Returns:
      Can be null

    • addChangeListener

      void addChangeListener(ChangeListener listener)
      Register a listener to be notified each time a new result is available.
      Parameters:
      listener -
      See Also:

    • getLastResult

      MusicGenerationQueue.Result getLastResult()
      Get the latest music generation result available.

      Note that the returned value might not be up to date, see isLastResultUpToDate().

      Returns:
      Can be null.

    • isLastResultUpToDate

      boolean isLastResultUpToDate()
      Check if the Result returned by getLastResult() is up to date.

      Returns false if :
      - last result is null
      - A new music generation is currently being generated
      - Active song is playing and there was a song structure change

      Returns:

    • getSong

      Song getSong()
      Get the active song for this ActiveSongMusicBuilder.
      Returns:
      Can be null

    • isEnabled

      boolean isEnabled()
      Get state (true by default).
      Returns:

    • removeChangeListener

      void removeChangeListener(ChangeListener listener)

    • setEnabled

      void setEnabled(boolean b)
      Change the ActiveSongMusicBuilder state.

      When disabled the ActiveSongMusicBuilder does nothing. Convenient for debugging in specific cases.

      Parameters:
      b -