tv.amwa.maj.iface
Interface TimecodeSegment

All Superinterfaces:

Component, InterchangeObject, Segment

All Known Implementing Classes:

TimecodeSegment

public interface TimecodeSegment
extends Segment

Specifies the storage of video tape or audio tape timecode information.

In contrast to a timecode stream, a timecode segment specifies timecode by specifying the single starting timecode value; other timecode values are calculated from the starting timecode and the time offset.

See the section on naming conflicts in the package documentation.

Author:

Richard Cartwright

See Also:

makeTimecodeSegment(), TimecodeValue

Method Summary

TimecodeValue	getTimecode() Returns the timecode value for this timecode segment, which specifies the start timecode for the segment, the frames per second of the tape and whether the timecode is drop or non-drop.
void	setTimecode(TimecodeValue timecode) Set the timecode value for this timecode segment, which specifies the start timecode for the segment, the frames per second of the tape and whether the timecode is drop or non-drop.

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

getTimecode

TimecodeValue getTimecode()

Returns the timecode value for this timecode segment, which specifies the start timecode for the segment, the frames per second of the tape and whether the timecode is drop or non-drop.

Returns:

Timecode value for the timecode segment.

See Also:

TimecodeValue.getStartOffset(), TimecodeValue.getFps(), TimecodeValue.getDrop()

setTimecode

void setTimecode(TimecodeValue timecode)
                 throws NullPointerException

Set the timecode value for this timecode segment, which specifies the start timecode for the segment, the frames per second of the tape and whether the timecode is drop or non-drop.

Parameters:

timecode - Timecode value for this timecode segment.

Throws:

NullPointerException - The given value for the timecode is null.

See Also:

AAFFactory.makeTimecodeValue(long, short, boolean)