org.openimaj.video.timecode

Class HrsMinSecFrameTimecode

java.lang.Object

org.openimaj.video.timecode.VideoTimecode

org.openimaj.video.timecode.FrameNumberVideoTimecode

org.openimaj.video.timecode.HrsMinSecFrameTimecode

All Implemented Interfaces:

Comparable<VideoTimecode>, Timecode

public class HrsMinSecFrameTimecode
extends FrameNumberVideoTimecode

A timecode representation that extends the standard frame count representation to provide hours, minutes, seconds and frames timecode.

Author:

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

Created:

6 Jun 2011

Field Summary

Fields inherited from class org.openimaj.video.timecode.FrameNumberVideoTimecode

fps

Constructor Summary

Constructors

Constructor and Description
HrsMinSecFrameTimecode(long number, double framesPerSec) Default constructor that takes the current (start) frame number and the number of frames in one second.

Method Summary

Modifier and Type	Method and Description
HrsMinSecFrameTimecode	clone() Clone this timecode.
boolean	equals(Object obj)
static HrsMinSecFrameTimecode	fromString(String s) Parses a string (formatted as toString()) back into a timecode object.
int	getFrames() Get the number of frames within the second.
int	getHours() Get the number of hours.
int	getMinutes() Get the number of minutes within the hour.
int	getSeconds() Get the number of seconds within the minute.
int	hashCode()
String	toString()

Methods inherited from class org.openimaj.video.timecode.FrameNumberVideoTimecode

compareTo, getFrameNumber, getTimecodeInMilliseconds, setFrameNumber, setTimecodeInMilliseconds

Methods inherited from class java.lang.Object

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

Constructor Detail

HrsMinSecFrameTimecode

public HrsMinSecFrameTimecode(long number,
                              double framesPerSec)

Default constructor that takes the current (start) frame number and the number of frames in one second.

Parameters:

number - The frame number.

framesPerSec - The number of frames per second.

Method Detail

getHours

public int getHours()

Get the number of hours.

Returns:

The number of hours.

getMinutes

public int getMinutes()

Get the number of minutes within the hour.

Returns:

The number of minutes within the hour.

getSeconds

public int getSeconds()

Get the number of seconds within the minute.

Returns:

The number of seconds within the minute.

getFrames

public int getFrames()

Get the number of frames within the second.

Returns:

The number of frames within the second.

toString

public String toString()

Overrides:

toString in class FrameNumberVideoTimecode

See Also:

FrameNumberVideoTimecode.toString()

fromString

public static HrsMinSecFrameTimecode fromString(String s)

Parses a string (formatted as toString()) back into a timecode object.

Parameters:

s - The string to parse

Returns:

A new HrsMinSecFrameTimecode or null if the string couldn't be parsed.

hashCode

public int hashCode()

Overrides:

hashCode in class FrameNumberVideoTimecode

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class FrameNumberVideoTimecode

See Also:

Object.equals(java.lang.Object)

clone

public HrsMinSecFrameTimecode clone()

Clone this timecode.

Specified by:

clone in interface Timecode

Overrides:

clone in class FrameNumberVideoTimecode

Returns:

All timecodes need to support clone.

See Also:

FrameNumberVideoTimecode.clone()