TimecodeStream (MAJ API)

Overview

Package

Class

Tree

Deprecated

Index

Media Authoring
with Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tv.amwa.maj.entity
Class TimecodeStream

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.Component
          tv.amwa.maj.entity.Segment
              tv.amwa.maj.entity.TimecodeStream

All Implemented Interfaces:: Serializable, Cloneable, MAJCommon, Component, InterchangeObject, Segment, TimecodeStream, XMLSerializable

Direct Known Subclasses:: TimecodeStream12M

@AAFClass(uuid1=218169601, uuid2=257, uuid3=5376, uuid4={6,14,43,52,2,6,1,1}, definedName="TimecodeStream", description="The TimecodeStream class specifies a stream of timecode data.") public abstract class TimecodeStream
extends Segment
implements TimecodeStream, Serializable, Cloneable, MAJCommon
extends Segment
implements TimecodeStream, Serializable, Cloneable, MAJCommon

Implements a representation of a stream of timecode data.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:: Richard Cartwright
See Also:: Serialized Form

Nested Class Summary
`static class`	`TimecodeStream.XMLHandler`

Nested classes/interfaces inherited from class tv.amwa.maj.entity.Segment
`Segment.SegmentXMLHandler`

Nested classes/interfaces inherited from class tv.amwa.maj.entity.Component
`Component.ComponentAttributesXMLHandler, Component.ComponentUserCommentsXMLHandler, Component.ComponentXMLHandler, Component.KLVDataXMLHandler`

Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject
`InterchangeObject.InterchangeObjectXMLHandler`

Field Summary

Fields inherited from class tv.amwa.maj.entity.Component
`COMPONENT_ITEM`

Constructor Summary
`TimecodeStream()`

Method Summary
`void`	`appendXMLChildren(Node parent)` Append child elements to the given parent node to serialize the value of an object to an XML fragment.
`boolean`	`equals(Object o)` Tests to see if the given object is equal to this interchange object.
`TimecodeValue`	`getPositionTimecode(long position)` Returns the timecode value for a given frame of this timecode stream.
`Rational`	`getSampleRate()` Returns the sample rate of the timecode stream, which specifies the sample rate of the timecode data contained in the source property.
`abstract int`	`getSampleSize()` Returns the size of one sample of the timecode data of this timecode stream, measured in bytes.
`byte[]`	`getSource()` Returns the data buffer containing the stream of timecode data of this timecode stream.
`int`	`getSourceBufferLength()` Returns the length of the timecode stream buffer contained within the timecode stream object.
`TCSource`	`getSourceType()` Returns the kind of timecode of this timecode stream, which is one of LTC or VITC.
`byte[]`	`getUserDataAtPosition(long position)` Returns the user data (user-bits) for a particular frame of this timecode stream.
`abstract int`	`getUserDataLength()` Returns the length of user data for one frame of this timecode stream.
`int`	`hashCode()` Returns a hash code value for this interchange object.
`abstract byte[]`	`packTimecode(TimecodeValue timecode, byte[] packedBuffer)` Pack a given timecode value into a give byte array.
`abstract byte[]`	`packUserBits(byte[] userBits, byte[] packedBuffer)` Pack user data from the given byte array into the given packed buffer.
`TimecodeValue`	`segmentOffsetToTC(long offset)` Converts the given segment offset to a timecode value.
`long`	`segmentTCToOffset(TimecodeValue timecode, Rational editRate)` Converts the given timecode and edit rate to a segment offset value.
`void`	`setPositionTimecode(long position, TimecodeValue timecode)` Sets the timecode value for a given frame of this timecode stream.
`void`	`setPropertiesFromInterface(TimecodeStream castFrom)`
`void`	`setSampleRate(Rational sampleRate)` Sets the sample rate of this timecode stream, which specifies the sample rate of the timecode data contained in the source property.
`void`	`setSource(byte[] value)` Sets the data buffer containing the stream of timecode data of this timecode stream.
`void`	`setSourceType(TCSource sourceType)` Sets the kind of timecode of this timecode stream, which is one of LTC or VITC.
`void`	`setUserDataAtPosition(long position, byte[] buffer)` Sets the user data (userbits) for a particular frame of the timecode stream.
`abstract TimecodeValue`	`unpackTimecode(byte[] buffer, short fps)` Unpack a timecode value from the given buffer for the given number of frames per second.
`abstract byte[]`	`unpackUserBits(byte[] buffer)` Unpack user data from the given sample of the timecode stream.

Methods inherited from class tv.amwa.maj.entity.Segment
`clone, setPropertiesFromInterface`

Methods inherited from class tv.amwa.maj.entity.Component
`appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, countAttributes, countComments, countKLVData, getAttributes, getComments, getDataDefinition, getKLVData, getLength, getLengthPresent, removeAttribute, removeComment, removeKLVData, setDataDefinition, setLength, setLengthPresent, setPropertiesFromInterface`

Methods inherited from class tv.amwa.maj.entity.InterchangeObject
`castFromInterface, countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, registerImplementation, setPropertiesFromInterface, setPropertyValue, toString`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, toString, wait, wait, wait`

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`

Methods inherited from interface tv.amwa.maj.entity.MAJCommon
`clone, toString`

Constructor Detail

TimecodeStream

public TimecodeStream()

Method Detail