git.sesse.net Git - vlc/blob - bindings/java/org/videolan/jvlc/InputIntf.java

   1 /*****************************************************************************
   2  * InputIntf.java: Input interface
   3  *****************************************************************************
   4  *
   5  * Copyright (C) 1998-2006 the VideoLAN team
   6  *
   7  * Author: Filippo Carone <filippo@carone.org>
   8  *
   9  * Created on 28-feb-2006
  10  *
  11  * $Id$
  12  *
  13  * This program is free software; you can redistribute it
  14  * and/or modify it under the terms of the GNU General Public License
  15  * as published by the Free Software Foundation; either version 2 of the
  16  * License, or (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful, but
  19  * WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21  * General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public
  24  * License along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  26  *
  27  */
  28
  29
  30 package org.videolan.jvlc;
  31
  32 /**
  33  * @author little
  34  *
  35  */
  36 public interface InputIntf {
  37
  38     /**
  39      * @return The total length of the current file playing in millis.
  40      * @throws VLCException
  41      */
  42     long getLength() throws VLCException;
  43
  44     /**
  45      * @return The current position in millis within the playing item.
  46      * @throws VLCException
  47      */
  48     long getTime() throws VLCException;
  49
  50     /**
  51      * @return The position in %.
  52      * @throws VLCException
  53      */
  54     float getPosition() throws VLCException;
  55
  56     /**
  57      * Moves current input to position specified in a float [0-1].
  58      * @param value The position, from 0 to 1, to move the input to.
  59      * @throws VLCException
  60      */
  61     void setPosition( float value ) throws VLCException;
  62
  63     /**
  64      * Moves current input to time specified in value
  65      * @param value The time in milliseconds to move the input to.
  66      * @throws VLCException
  67      */
  68     void setTime(long value) throws VLCException;
  69
  70
  71     /**
  72      * @return If the playing item is a video file, returns the FPS, otherwise 0.
  73      * @throws VLCException
  74      */
  75     double getFPS() throws VLCException;
  76
  77
  78     /**
  79      * @return True if the current input is really playing
  80      */
  81     boolean isPlaying() throws VLCException;
  82
  83     /**
  84      * @return True if the current input has spawned a video output window
  85      */
  86     boolean hasVout() throws VLCException;
  87 }