tv.amwa.maj.iface
Interface Event

All Superinterfaces:

Component, InterchangeObject, Segment

All Known Subinterfaces:

CommentMarker, DescriptiveMarker, GPITrigger

All Known Implementing Classes:

CommentMarker, DescriptiveMarker, Event, GPITrigger

public interface Event
extends Segment

Specifies a text comment, a trigger, or an area in the image that has an associated interactive action.

Author:

Richard Cartwright

See Also:

EventMobSlot

Method Summary

String	getComment() Returns the comment that specifies the purpose of this event.
long	getPosition() Returns the position of this event, which specifies the starting time of the event in an event mob slot.
void	setComment(String comment) Set a comment that specifies the purpose of the event.
void	setPosition(long position) Sets the position of this event, which specifies the starting time of the event in an event mob slot.

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

getPosition

@PositionType
long getPosition()
                 throws BadPropertyException

Returns the position of this event, which specifies the starting time of the event in an event mob slot.

Returns:

Position of this event in an event mob slot.

Throws:

BadPropertyException - The position property is not present in the context of this event.

setPosition

void setPosition(@PositionType
                 long position)
                 throws BadPropertyException

Sets the position of this event, which specifies the starting time of the event in an event mob slot.

Parameters:

position - The position for this event in an event mob slot.

Throws:

BadPropertyException - The position property is not present in the context of this event.

setComment

void setComment(@AAFString
                String comment)

Set a comment that specifies the purpose of the event. Set this optional property to null to omit it.

Parameters:

comment - Comment to set for this event.

getComment

@AAFString
String getComment()
                  throws PropertyNotPresentException

Returns the comment that specifies the purpose of this event. This is an optional property.

Returns:

Comment describing this event.

Throws:

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