org.openimaj.video

Class VideoDisplay.BasicVideoTimeKeeper

java.lang.Object

org.openimaj.video.VideoDisplay.BasicVideoTimeKeeper

All Implemented Interfaces:

Runnable, TimeKeeper<Timecode>

Enclosing class:

VideoDisplay<T extends Image<?,T>>

public class VideoDisplay.BasicVideoTimeKeeper
extends Object
implements TimeKeeper<Timecode>

A timekeeper for videos without audio - uses the system time to keep track of where in a video a video should be. Also used for live videos that are to be displayed at a given rate.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
VideoDisplay.BasicVideoTimeKeeper(boolean liveVideo) Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
Timecode	getTime() Returns the current time.
void	pause() Pause the running of the timekeeper.
void	reset() Reset the timekeeper.
void	run() Use this method to start the time keeper running.
void	seek(long timestamp) Seek to a given timestamp.
void	setTimeOffset(long timeOffset) Set the time offset to use in the current time calculation.
void	stop() Use this method to stop the time keeper from running.
boolean	supportsPause() Returns whether the timekeeper supports pausing.
boolean	supportsSeek() Returns whether the timekeeper supports seeking.

Methods inherited from class java.lang.Object

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

Constructor Detail

VideoDisplay.BasicVideoTimeKeeper

public VideoDisplay.BasicVideoTimeKeeper(boolean liveVideo)

Default constructor

Parameters:

liveVideo - Whether the timekeeper is for a live video or for a video that supports pausing

Method Detail

run

public void run()

Use this method to start the time keeper running.

Specified by:

run in interface Runnable

Specified by:

run in interface TimeKeeper<Timecode>

See Also:

TimeKeeper.run()

stop

public void stop()

Use this method to stop the time keeper from running.

Specified by:

stop in interface TimeKeeper<Timecode>

See Also:

TimeKeeper.stop()

getTime

public Timecode getTime()

Returns the current time.

Specified by:

getTime in interface TimeKeeper<Timecode>

Returns:

the current time object.

See Also:

TimeKeeper.getTime()

supportsPause

public boolean supportsPause()

Returns whether the timekeeper supports pausing. If the timekeeper supports pausing then a stop() followed by a run() will continue from where the timekeeper was paused. Use reset() inbetween to force the timekeeper to start from the beginning again.

Specified by:

supportsPause in interface TimeKeeper<Timecode>

Returns:

TRUE if the timekeeper supports pausing.

See Also:

TimeKeeper.supportsPause()

supportsSeek

public boolean supportsSeek()

Returns whether the timekeeper supports seeking.

Specified by:

supportsSeek in interface TimeKeeper<Timecode>

Returns:

TRUE if the timekeeper supports seeking.

See Also:

TimeKeeper.supportsSeek()

seek

public void seek(long timestamp)

Seek to a given timestamp.

Specified by:

seek in interface TimeKeeper<Timecode>

Parameters:

timestamp - The timestamp to seek to

See Also:

TimeKeeper.seek(long)

reset

public void reset()

Reset the timekeeper.

Specified by:

reset in interface TimeKeeper<Timecode>

See Also:

TimeKeeper.reset()

pause

public void pause()

Pause the running of the timekeeper.

Specified by:

pause in interface TimeKeeper<Timecode>

See Also:

TimeKeeper.pause()

setTimeOffset

public void setTimeOffset(long timeOffset)

Set the time offset to use in the current time calculation. Can be used to force the time keeper to start at a different point in time.

Parameters:

timeOffset - the new time offset.