src/main/java/net/pterodactylus/sonitus/data/Sink.java

   1 /*
   2  * Sonitus - Sink.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sonitus.data;
  19
  20 /**
  21  * A sink is an endpoint for an audio stream. It might be a file on disk, it can
  22  * be an audio output in the current system, or it can be sent to a remote
  23  * streaming server for broadcasting.
  24  *
  25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  26  */
  27 public interface Sink {
  28
  29         /**
  30          * Connects this sink to the given source.
  31          *
  32          * @param source
  33          *              The source to connect to
  34          * @throws ConnectException
  35          *              if the source can not be connected, e.g. due to a {@link Format} mismatch
  36          */
  37         void connect(Source source) throws ConnectException;
  38
  39         /** Notifies the sink that a source has updated its metadata. */
  40         void metadataUpdated();
  41
  42 }