IPlayerImpl.java

/*
 *  Jajuk
 *  Copyright (C) The Jajuk Team
 *  http://jajuk.info
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *  
 */
package org.jajuk.services.players;

import org.jajuk.base.File;
import org.jajuk.services.webradio.WebRadio;

/**
 * Minimum methods required for all Player implementations.
 */
public interface IPlayerImpl {
  /**
   * Launches player.
   * 
   * @param file :
   * jajuk file to be played
   * @param fPosition position in % of the file
   * @param length length to play in ms or TO_THE_END of you want to play to the end
   * of the current file
   * @param fVolume volume
   * 
   * @throws Exception the exception
   */
  void play(File file, float fPosition, long length, float fVolume) throws Exception;

  /**
   * Play a web radio stream.
   * 
   * @param radio 
   * @param fVolume 
   * 
   * @throws Exception the exception
   */
  void play(WebRadio radio, float fVolume) throws Exception;

  /**
   * Stop current player.
   * 
   * @throws Exception the exception
   */
  void stop() throws Exception;

  /**
   * Set the gain.
   * 
   * @param fVolume :
   * gain from 0 to 1
   * 
   * @throws Exception the exception
   */
  void setVolume(float fVolume) throws Exception;

  /**
   * Gets the elapsed time. (position*total length)
   * 
   * @return elapsed time (ms) for this player
   */
  long getElapsedTimeMillis();

  /**
  * Gets the actually played time (including rewinds and forward, pause not included)
  * 
  * @return actually played time (ms) for this player
  */
  long getActuallyPlayedTimeMillis();

  /**
   * Pause the player.
   * 
   * @throws Exception the exception
   */
  void pause() throws Exception;

  /**
   * Resume the player.
   * 
   * @throws Exception the exception
   */
  void resume() throws Exception;

  /**
   * Seek to a given position in %. ex : 0.2 for 20%
   * 
   * @param fPosition 
   */
  void seek(float fPosition);

  /**
   * Gets the current position.
   * 
   *@return current position as a float ex: 0.2f
   */
  float getCurrentPosition();

  /**
   * Return track total duration secs.
   * 
   * @return track total duration secs.
   */
  long getDurationSec();

  /**
   * Return volume in %.
   * 
   * @return the current volume
   */
  float getCurrentVolume();

  /**
   * Return player state.
   * 
   * @return the state
   */
  int getState();
}