org.openimaj.video.timecode

Class FrameNumberVideoTimecode

java.lang.Object

org.openimaj.video.timecode.VideoTimecode

org.openimaj.video.timecode.FrameNumberVideoTimecode

All Implemented Interfaces:

Comparable<VideoTimecode>, Timecode

Direct Known Subclasses:

HrsMinSecFrameTimecode

public class FrameNumberVideoTimecode
extends VideoTimecode

This class allows video timecodes to be stored as frame numbers.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected double	fps The number of frames per second

Constructor Summary

Constructors

Constructor and Description
FrameNumberVideoTimecode(long number, double fps) Default constructor that takes the frame number.

Method Summary

Methods

Modifier and Type	Method and Description
FrameNumberVideoTimecode	clone() Clone this timecode.
int	compareTo(VideoTimecode o)
boolean	equals(Object obj)
long	getFrameNumber() Returns the frame number of the frame represented by the video timecode.
long	getTimecodeInMilliseconds() All timecode instances must be able to return the time in seconds from the beginning of the temporal media.
int	hashCode()
void	setFrameNumber(long frame) Set the frame number.
void	setTimecodeInMilliseconds(long timeInMilliseconds) Set the current timecode to the given time in seconds, converting as necessary.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

fps

protected double fps

The number of frames per second

Constructor Detail

FrameNumberVideoTimecode

public FrameNumberVideoTimecode(long number,
                        double fps)

Default constructor that takes the frame number.

Parameters:

number - The frame number

fps - The frame rate

Method Detail

getFrameNumber

public long getFrameNumber()

Returns the frame number of the frame represented by the video timecode. This is necessary to allow comparison between video timecodes (even of different types).

Specified by:

getFrameNumber in class VideoTimecode

Returns:

The frame number of the frame represented by this timecode.

See Also:

VideoTimecode.getFrameNumber()

setFrameNumber

public void setFrameNumber(long frame)

Set the frame number.

Parameters:

frame - The frame number

compareTo

public int compareTo(VideoTimecode o)

See Also:

Comparable.compareTo(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

getTimecodeInMilliseconds

public long getTimecodeInMilliseconds()

All timecode instances must be able to return the time in seconds from the beginning of the temporal media.

Returns:

The time in seconds.

See Also:

Timecode.getTimecodeInMilliseconds()

setTimecodeInMilliseconds

public void setTimecodeInMilliseconds(long timeInMilliseconds)

Set the current timecode to the given time in seconds, converting as necessary.

Parameters:

timeInMilliseconds - The time in seconds.

See Also:

Timecode.setTimecodeInMilliseconds(long)

clone

public FrameNumberVideoTimecode clone()

Clone this timecode.

Specified by:

clone in interface Timecode

Specified by:

clone in class VideoTimecode

Returns:

All timecodes need to support clone.