org.videolan.jvlc
Interface InputIntf

All Known Subinterfaces:
JLibVLC
All Known Implementing Classes:
Input

public interface InputIntf


Method Summary
 double getFPS()
          Gets the current playing item frames per second (FPS) value.
 long getLength()
          Gets the length in milliseconds for the currently running input.
 float getPosition()
          Gets the current position on a scale from 0 to 1 for the currently running input.
 long getTime()
          Gets the current position in milliseconds for the currently running input.
 boolean hasVout()
          This method is used to know if the currently playing item has spawned a video output window.
 boolean isPlaying()
          Gets the status of the current input.
 void setPosition(float value)
          Moves current input to position specified in a float on a scale from 0 to 1.
 void setTime(long value)
          Moves current input to the specified time (in milliseconds).
 

Method Detail

getLength

long getLength()
               throws VLCException
Gets the length in milliseconds for the currently running input.

Returns:
The total length of the current file playing in millis.
Throws:
VLCException

getTime

long getTime()
             throws VLCException
Gets the current position in milliseconds for the currently running input.

Returns:
The current position in millis within the playing item.
Throws:
VLCException

getPosition

float getPosition()
                  throws VLCException
Gets the current position on a scale from 0 to 1 for the currently running input.

Returns:
The position in %.
Throws:
VLCException

setPosition

void setPosition(float value)
                 throws VLCException
Moves current input to position specified in a float on a scale from 0 to 1.

Parameters:
value - The position, from 0 to 1, to move the input to.
Throws:
VLCException

setTime

void setTime(long value)
             throws VLCException
Moves current input to the specified time (in milliseconds).

Parameters:
value - The time in milliseconds to move the input to.
Throws:
VLCException

getFPS

double getFPS()
              throws VLCException
Gets the current playing item frames per second (FPS) value. This is 0 is the input is an audio only file.

Returns:
If the playing item is a video file, returns the FPS, otherwise 0.
Throws:
VLCException

isPlaying

boolean isPlaying()
                  throws VLCException
Gets the status of the current input. This is used to be sure the item is really playing after we issued a play() command. Beware this value is true also if the current item is paused.

Returns:
True if the current input is really playing
Throws:
VLCException

hasVout

boolean hasVout()
                throws VLCException
This method is used to know if the currently playing item has spawned a video output window.

Returns:
True if the current input has spawned a video output window
Throws:
VLCException