com.github.bjoernpetersen.jmusicbot.playback.FilePlaybackFactory 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 java.io.File;
import java.io.IOException;
import javax.annotation.Nonnull;
import javax.sound.sampled.UnsupportedAudioFileException;

/**
 * An extension of the {@link PlaybackFactory} interface which accepts input files.
 */
public interface FilePlaybackFactory extends PlaybackFactory {

  /**
   * Creates a playback object from the given input file.
   *
   * This method can perform blocking IO actions.
   *
   * @param inputFile the input file with audio data
   * @return a Playback object
   * @throws UnsupportedAudioFileException if the format of the input stream is unsupported
   * @throws IOException if any IO error occurs
   */
  @Nonnull
  Playback createPlayback(@Nonnull File inputFile)
      throws UnsupportedAudioFileException, IOException;
}