org.openimaj.audio.timecode

Class AudioTimecode

java.lang.Object

org.openimaj.audio.timecode.AudioTimecode

All Implemented Interfaces:

Timecode

Direct Known Subclasses:

MeasuresBeatsTicksTimecode

public class AudioTimecode
extends Object
implements Timecode

A basic audio timecode that represents the number of milliseconds from the start of the audio file.

Author:

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

Created:

21 Nov 2011

Field Summary

Fields

Modifier and Type	Field and Description
protected long	milliseconds The number of milliseconds from the start of the audio file

Constructor Summary

Constructors

Constructor and Description
AudioTimecode(long milliseconds) Default constructor that takes the number of milliseconds into the audio file.

Method Summary

Modifier and Type	Method and Description
AudioTimecode	clone() Clone this timecode.
long	getTimecodeInMilliseconds() All timecode instances must be able to return the time in seconds from the beginning of the temporal media.
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

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

Field Detail

milliseconds

protected long milliseconds

The number of milliseconds from the start of the audio file

Constructor Detail

AudioTimecode

public AudioTimecode(long milliseconds)

Default constructor that takes the number of milliseconds into the audio file.

Parameters:

milliseconds - The number of milliseconds from the start of the audio file.

Method Detail

getTimecodeInMilliseconds

public long getTimecodeInMilliseconds()

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

Specified by:

getTimecodeInMilliseconds in interface Timecode

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.

Specified by:

setTimecodeInMilliseconds in interface Timecode

Parameters:

timeInMilliseconds - The time in seconds.

See Also:

Timecode.setTimecodeInMilliseconds(long)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

clone

public AudioTimecode clone()

Clone this timecode.

Specified by:

clone in interface Timecode

Overrides:

clone in class Object

Returns:

All timecodes need to support clone.