tv.amwa.maj.iface
Interface CommentMarker

All Superinterfaces:

Component, Event, InterchangeObject, Segment

All Known Subinterfaces:

DescriptiveMarker

All Known Implementing Classes:

CommentMarker, DescriptiveMarker

public interface CommentMarker
extends Event

Specifies a user comment associated with a point in time. A comment marker may have a source reference that specifies a text or audio annotation.

Author:

Richard Cartwright

See Also:

DescriptiveMarker

Method Summary

SourceReferenceSegment	getAnnotation() Returns the annotation for this comment marker, which specifies a text or audio annotation.
void	setAnnotation(SourceReferenceSegment annotation) Sets the annotation marker for this comment marker, which specifies a text or audio annotation.

Methods inherited from interface tv.amwa.maj.iface.Event

getComment, getPosition, setComment, setPosition

Methods inherited from interface tv.amwa.maj.iface.Segment

segmentOffsetToTC, segmentTCToOffset

Methods inherited from interface tv.amwa.maj.iface.Component

appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, countAttributes, countComments, countKLVData, getAttributes, getComments, getDataDefinition, getKLVData, getLength, removeAttribute, removeComment, removeKLVData, setDataDefinition, setLength

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject

countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue

Method Detail

getAnnotation

SourceReferenceSegment getAnnotation()
                                     throws PropertyNotPresentException

Returns the annotation for this comment marker, which specifies a text or audio annotation. This is an optional property.

Returns:

Text or audio annotation.

Throws:

PropertyNotPresentException - The optional annotation property is not present in this comment marker.

setAnnotation

void setAnnotation(SourceReferenceSegment annotation)

Sets the annotation marker for this comment marker, which specifies a text or audio annotation. Set this value to null to omit this optional property.

Parameters:

annotation - Specifies a text or audio annotation.