MediaPlayer.java

  1. /*
  2.  * *********************************************************************************************************************
  3.  *
  4.  * blueMarine II: Semantic Media Centre
  5.  * http://tidalwave.it/projects/bluemarine2
  6.  *
  7.  * Copyright (C) 2015 - 2021 by Tidalwave s.a.s. (http://tidalwave.it)
  8.  *
  9.  * *********************************************************************************************************************
  10.  *
  11.  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  12.  * the License. You may obtain a copy of the License at
  13.  *
  14.  *     http://www.apache.org/licenses/LICENSE-2.0
  15.  *
  16.  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
  17.  * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
  18.  * specific language governing permissions and limitations under the License.
  19.  *
  20.  * *********************************************************************************************************************
  21.  *
  22.  * git clone https://bitbucket.org/tidalwave/bluemarine2-src
  23.  * git clone https://github.com/tidalwave-it/bluemarine2-src
  24.  *
  25.  * *********************************************************************************************************************
  26.  */
  27. package it.tidalwave.bluemarine2.ui.audio.renderer;

  28. import javax.annotation.Nonnull;
  29. import java.time.Duration;
  30. import javafx.beans.property.ObjectProperty;
  31. import it.tidalwave.bluemarine2.model.MediaItem;

  32. /***********************************************************************************************************************
  33.  *
  34.  * @author  Fabrizio Giudici
  35.  *
  36.  **********************************************************************************************************************/
  37. public interface MediaPlayer
  38.   {
  39.     enum Status
  40.       {
  41.         STOPPED,
  42.         PLAYING,
  43.         PAUSED
  44.       }

  45.     /*******************************************************************************************************************
  46.      *
  47.      *
  48.      ******************************************************************************************************************/
  49.     public static class Exception extends java.lang.Exception
  50.       {
  51.         public Exception (@Nonnull final String message)
  52.           {
  53.             super(message);
  54.           }

  55.         public Exception (@Nonnull final Throwable cause)
  56.           {
  57.             super(cause);
  58.           }
  59.       }
  60.    
  61.     /*******************************************************************************************************************
  62.      *
  63.      *
  64.      ******************************************************************************************************************/
  65.     public void setMediaItem (@Nonnull MediaItem mediaItem)
  66.       throws Exception;
  67.    
  68.     /*******************************************************************************************************************
  69.      *
  70.      *
  71.      ******************************************************************************************************************/
  72.     public void play()
  73.       throws Exception;
  74.            
  75.     /*******************************************************************************************************************
  76.      *
  77.      *
  78.      ******************************************************************************************************************/
  79.     public void stop()
  80.       throws Exception;
  81.    
  82.     /*******************************************************************************************************************
  83.      *
  84.      *
  85.      ******************************************************************************************************************/
  86.     public void pause()
  87.       throws Exception;
  88.    
  89.     /*******************************************************************************************************************
  90.      *
  91.      *
  92.      ******************************************************************************************************************/
  93.     public void rewind()
  94.       throws Exception;

  95.     /*******************************************************************************************************************
  96.      *
  97.      *
  98.      ******************************************************************************************************************/
  99.     public void fastForward()
  100.       throws Exception;
  101.    
  102.     /*******************************************************************************************************************
  103.      *
  104.      *
  105.      ******************************************************************************************************************/
  106.     @Nonnull
  107.     public ObjectProperty<Duration> playTimeProperty();
  108.    
  109.     /*******************************************************************************************************************
  110.      *
  111.      *
  112.      ******************************************************************************************************************/
  113.     @Nonnull
  114.     public ObjectProperty<Status> statusProperty();
  115.   }