com.github.bjoernpetersen.jmusicbot.playback.PlaybackFactory 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.playback;

import com.github.bjoernpetersen.jmusicbot.InitStateWriter;
import com.github.bjoernpetersen.jmusicbot.InitializationException;
import com.github.bjoernpetersen.jmusicbot.Plugin;
import java.util.Collection;
import javax.annotation.Nonnull;

public interface PlaybackFactory extends Plugin {

  /**
   * Initializes the PlaybackFactory. After this call, the factory should be operational until
   * {@link #close()} is called.
   *
   * @param initStateWriter a writer for initialization state messages
   * @throws InitializationException if anything goes wrong
   * @throws InterruptedException if the thread is interrupted while initializing
   */
  void initialize(@Nonnull InitStateWriter initStateWriter)
      throws InitializationException, InterruptedException;

  /**
   * Gets the PlaybackFactories this is implementing.
   *
   * @return a collection of PlaybackFactory interfaces
   */
  @Nonnull
  Collection> getBases();
}