org.videolan.jvlc
Class Input

java.lang.Object
  org.videolan.jvlc.Input

All Implemented Interfaces:

InputIntf

public class Input
extends java.lang.Object
implements InputIntf

Constructor Summary

Input(long instance)

Method Summary

double	getFPS() Gets the current playing item frames per second (FPS) value.
long	getInstance()
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 position) Moves current input to position specified in a float on a scale from 0 to 1.
void	setTime(long time) Moves current input to the specified time (in milliseconds).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Input

public Input(long instance)

Method Detail

getLength

public long getLength()
               throws VLCException

Description copied from interface: InputIntf

Gets the length in milliseconds for the currently running input.

Specified by:

getLength in interface InputIntf

Returns:

The total length of the current file playing in millis.

Throws:

VLCException

getTime

public long getTime()
             throws VLCException

Description copied from interface: InputIntf

Gets the current position in milliseconds for the currently running input.

Specified by:

getTime in interface InputIntf

Returns:

The current position in millis within the playing item.

Throws:

VLCException

getPosition

public float getPosition()
                  throws VLCException

Description copied from interface: InputIntf

Gets the current position on a scale from 0 to 1 for the currently running input.

Specified by:

getPosition in interface InputIntf

Returns:

The position in %.

Throws:

VLCException

setTime

public void setTime(long time)
             throws VLCException

Description copied from interface: InputIntf

Moves current input to the specified time (in milliseconds).

Specified by:

setTime in interface InputIntf

Parameters:

time - The time in milliseconds to move the input to.

Throws:

VLCException

setPosition

public void setPosition(float position)
                 throws VLCException

Description copied from interface: InputIntf

Moves current input to position specified in a float on a scale from 0 to 1.

Specified by:

setPosition in interface InputIntf

Parameters:

position - The position, from 0 to 1, to move the input to.

Throws:

VLCException

getFPS

public double getFPS()
              throws VLCException

Description copied from interface: InputIntf

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

Specified by:

getFPS in interface InputIntf

Returns:

If the playing item is a video file, returns the FPS, otherwise 0.

Throws:

VLCException

isPlaying

public boolean isPlaying()
                  throws VLCException

Description copied from interface: InputIntf

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.

Specified by:

isPlaying in interface InputIntf

Returns:

True if the current input is really playing

Throws:

VLCException

hasVout

public boolean hasVout()
                throws VLCException

Description copied from interface: InputIntf

This method is used to know if the currently playing item has spawned a video output window.

Specified by:

hasVout in interface InputIntf

Returns:

True if the current input has spawned a video output window

Throws:

VLCException

getInstance

public long getInstance()