tv.amwa.maj.iface
Interface TimecodeStream12M

All Superinterfaces:

Component, InterchangeObject, Segment, TimecodeStream

All Known Implementing Classes:

TimecodeStream12M

public interface TimecodeStream12M
extends TimecodeStream

Specifies a stream of timecode data in the SMPTE 12M format.

Author:

Richard Cartwright

Field Summary

static boolean

INCLUDESYNC_DEFAULT Default value for the include sync property, which is false.

Method Summary

boolean	getIncludeSync() Returns true if the synchronization data is included in the timecode stream; otherwise false if the synchronization data has a fixed value and is omitted from the timecode stream.
void	setIncludeSync(Boolean includeSync) Sets true if synchronization data is included in this timecode stream and false if the synchronization data has a fixed value and is omitted from the timecode stream.

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

getPositionTimecode, getSampleRate, getSampleSize, getSource, getSourceBufferLength, getSourceType, getUserDataAtPosition, getUserDataLength, setPositionTimecode, setSampleRate, setSource, setSourceType, setUserDataAtPosition

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

Field Detail

INCLUDESYNC_DEFAULT

static final boolean INCLUDESYNC_DEFAULT

Default value for the include sync property, which is false.

See Also:

getIncludeSync(), setIncludeSync(Boolean), Constant Field Values

Method Detail

setIncludeSync

void setIncludeSync(@Bool
                    Boolean includeSync)

Sets true if synchronization data is included in this timecode stream and false if the synchronization data has a fixed value and is omitted from the timecode stream.

The default value for this optional property is false. Set this optional property to null to omit it.

Parameters:

includeSync - Is synchronization data included in the timecode stream?

See Also:

INCLUDESYNC_DEFAULT

getIncludeSync

@Bool
boolean getIncludeSync()

Returns true if the synchronization data is included in the timecode stream; otherwise false if the synchronization data has a fixed value and is omitted from the timecode stream.

If this optional property is omitted, the default value of false is returned.

Returns:

Is synchronization data included in the timecode stream?

See Also:

INCLUDESYNC_DEFAULT