com.github.bjoernpetersen.jmusicbot.SongLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of musicbot Show documentation

Core library of MusicBot, which plays music from various providers.

There is a newer version: 0.25.0

package com.github.bjoernpetersen.jmusicbot;

import com.github.bjoernpetersen.jmusicbot.playback.Playback;
import com.github.bjoernpetersen.jmusicbot.playback.PlaybackFactory;
import com.github.bjoernpetersen.jmusicbot.provider.Provider;

/**
 * Prepares songs to be played by a {@link PlaybackFactory}.
 *
 * Implementations are generally provided by a {@link Provider}. As an example, an implementation
 * could download a song to a MP3 file so a PlaybackFactory can subsequently play the file.
 *
 * It is possible that no loading is need or even possible before the song is actually played. In
 * this case, the {@link #DUMMY} implementation may be used.
 */
@FunctionalInterface
public interface SongLoader extends Loggable {

  /**
   * A SongLoader implementation that does nothing
   */
  SongLoader DUMMY = song -> true;

  /**
   * Loads a song.

   *
   * This method can potentially download a song before it is being played. The song might never be
   * actually played, so this should not prepare a {@link Playback} object in any way.

   *
   * This method will not be called on a UI Thread.
   *
   * @param song the song to load
   * @return whether the song has been loaded successfully
   */
  boolean load(Song song);
}