public interface

VideoFrame

implements VideoMoment AnnotationObject
vars.annotation.VideoFrame
Known Indirect Subclasses

Summary

Constants
String PROP_ALTERNATE_TIMECODE
String PROP_CAMERA_DATA
String PROP_IN_SEQUENCE
String PROP_PHYSICAL_DATA
String PROP_RECORDED_DATE
String PROP_TIMECODE
[Expand]
Inherited Constants
From interface vars.VideoMoment
Public Methods
abstract void addObservation(Observation obs)
Add to the Observation collection of this VideoFrame.
abstract CameraData getCameraData()
Get the CameraData associated with this VideoFrame.
abstract List<Observation> getObservations()
abstract PhysicalData getPhysicalData()
Get the PhysicalData associated with this VideoFrame.
abstract VideoArchive getVideoArchive()
abstract boolean hasImageReference()
Indeicates if an annotation has an associated framegrab.
abstract boolean isInSequence()
Check whether this VideoFrame is part of a larger sequence of VideoFrame objects.
abstract void removeObservation(Observation obs)
abstract void setAlternateTimecode(String altTimecode)
Set the HD Timecode for this VideoFrame.
abstract void setInSequence(boolean state)
Set the flag indicating whether this VideoFrame is part of a larger sequence of VideoFrame objects.
abstract void setRecordedDate(Date dtg)
Sets the time of the frame representing the annotation
abstract void setTimecode(String timecode)
[Expand]
Inherited Methods
From interface vars.VARSObject
From interface vars.VideoMoment

Constants

public static final String PROP_ALTERNATE_TIMECODE

Constant Value: "alternateTimecode"

public static final String PROP_CAMERA_DATA

Constant Value: "cameraData"

public static final String PROP_IN_SEQUENCE

Constant Value: "inSequence"

public static final String PROP_PHYSICAL_DATA

Constant Value: "physicalData"

public static final String PROP_RECORDED_DATE

Constant Value: "recordedDate"

public static final String PROP_TIMECODE

Constant Value: "timecode"

Public Methods

public abstract void addObservation (Observation obs)

Add to the Observation collection of this VideoFrame.

Parameters
obs The Observation to add.
Returns
  • the Observation with updated ID.
See Also

public abstract CameraData getCameraData ()

Get the CameraData associated with this VideoFrame.

Returns
  • A handle to the CameraData object associated with this VideoFrame. null will never be returned.
See Also

public abstract List<Observation> getObservations ()

Returns
  • The observations associated with this annotated frame. This collection is synchronized.

public abstract PhysicalData getPhysicalData ()

Get the PhysicalData associated with this VideoFrame.

Returns
  • A handle to the PhysicalData object associated with this VideoFrame. null should never be returned.
See Also

public abstract VideoArchive getVideoArchive ()

public abstract boolean hasImageReference ()

Indeicates if an annotation has an associated framegrab.

public abstract boolean isInSequence ()

Check whether this VideoFrame is part of a larger sequence of VideoFrame objects.

Returns
  • true if this VideoFrame is part of a larger sequence of VideoFrame objects; false otherwise.

public abstract void removeObservation (Observation obs)

public abstract void setAlternateTimecode (String altTimecode)

Set the HD Timecode for this VideoFrame.

Parameters
altTimecode The HD Timecode object to associate with this VideoFrame.

public abstract void setInSequence (boolean state)

Set the flag indicating whether this VideoFrame is part of a larger sequence of VideoFrame objects. a.k.a This annotation is part of larger group of annotations describing a sequence of events.

Parameters
state boolean indicator of sequence state

public abstract void setRecordedDate (Date dtg)

Sets the time of the frame representing the annotation

Parameters
dtg The Date that the annotated frame was recorded in UTC.

public abstract void setTimecode (String timecode)