tv.amwa.maj.iface
Interface TimelineMobSlot

All Superinterfaces:

InterchangeObject, MobSlot

All Known Implementing Classes:

TimelineMobSlot

public interface TimelineMobSlot
extends MobSlot

Specifies a track that describes time-varying timeline essence.

If a component is in a timeline mob slot, then it shall have a length property. The timeline mob slot specifies the edit rate for the segment it has. The segment specifies its length in the edit rate set by the timeline mob slot. The segment also specifies its own data kind.

Author:

Richard Cartwright

See Also:

makeTimelineMobSlot(), MasterMob.createEssence(), MasterMob.createMultiEssence(), TimecodeSegment, EdgecodeSegment, TimecodeStream

Method Summary

Rational	getEditRate() Returns the edit rate for this timeline mob slot, which specifies the units of time of the slot.
long	getMarkIn() Returns the mark in property of the timeline mob slot.
long	getMarkOut() Returns the mark out property of this timeline mob slot, which specifies the position of the marked out point as a count of edit units from the zero position of this timeline mob slot.
long	getOrigin() Returns the origin of this timeline mob slot, which specifies the offset used to resolve source clip references in this timeline mob slot.
long	getUserPos() Returns the user position property of the timeline mob slot, which specifies a user position as a count of edit units from the zero position of the timeline mob slot.
void	setEditRate(Rational editRate) Sets the edit rate for this timeline mob slot, which specifies the units of time of the slot.
void	setMarkIn(Long markIn) Sets the mark in property for this timeline mob slot, which specifies the position of the marked in point as a count of edit units from the zero position of this timeline mob slot.
void	setMarkOut(Long markOut) Sets the mark out property of this timeline mob slot, which specifies the position of the marked out point as a count of edit units from the zero position of this timeline mob slot.
void	setOrigin(long origin) Sets the origin of this timeline mob slot, which specifies the offset used to resolve source clip references in this timeline mob slot.
void	setUserPos(Long userPos) Sets the user position property of the timeline mob slot, which specifies a user position as a count of edit units from the zero position of the timeline mob slot.

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

getDataDefinition, getName, getPhysicalNumber, getSegment, getSlotID, setName, setPhysicalNumber, setSegment, setSlotID

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

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

Method Detail

getEditRate

Rational getEditRate()

Returns the edit rate for this timeline mob slot, which specifies the units of time of the slot.

Returns:

Edit rate for this timeline mob slot.

setEditRate

void setEditRate(Rational editRate)
                 throws NullPointerException

Sets the edit rate for this timeline mob slot, which specifies the units of time of the slot.

Parameters:

editRate - Edit rate for this timeline mob slot.

Throws:

NullPointerException - The given edit rate is null.

getOrigin

@PositionType
long getOrigin()

Returns the origin of this timeline mob slot, which specifies the offset used to resolve source clip references in this timeline mob slot. A positive value of origin means that the first sample of the essence is earlier than the zero position. A negative value of origin means that the zero position is earlier than the first sample of the essence.

Returns:

Origin of this timeline mob slot.

setOrigin

void setOrigin(@PositionType
               long origin)

Sets the origin of this timeline mob slot, which specifies the offset used to resolve source clip references in this timeline mob slot. A positive value of origin means that the first sample of the essence is earlier than the zero position. A negative value of origin means that the zero position is earlier than the first sample of the essence.

Parameters:

origin - Origin of this timeline mob slot.

getMarkIn

@PositionType
long getMarkIn()
               throws PropertyNotPresentException

Returns the mark in property of the timeline mob slot. This property specifies the position of the marked in point as a count of edit units from the zero position of the timeline mob slot. This is an optional property.

Note that this property shall not be present for a source mob.

Returns:

Mark in property for the timeline mob slot.

Throws:

PropertyNotPresentException - The optional mark in property is not present in this timeline mob slot.

setMarkIn

void setMarkIn(@PositionType
               Long markIn)

Sets the mark in property for this timeline mob slot, which specifies the position of the marked in point as a count of edit units from the zero position of this timeline mob slot. Set this optional property to null to omit it.

Note that this property shall not be present for a source mob.

Parameters:

markIn - Mark in property for this timeline mob slot.

getMarkOut

@PositionType
long getMarkOut()
                throws PropertyNotPresentException

Returns the mark out property of this timeline mob slot, which specifies the position of the marked out point as a count of edit units from the zero position of this timeline mob slot. This is an optional property.

Note that this property shall not be present for a source mob.

Returns:

Mark out property of this timeline mob slot.

Throws:

PropertyNotPresentException - The optional mark out property is not present in this timeline mob slot.

setMarkOut

void setMarkOut(@PositionType
                Long markOut)

Sets the mark out property of this timeline mob slot, which specifies the position of the marked out point as a count of edit units from the zero position of this timeline mob slot. Set this optional property to null to omit it.

Note that this property shall not be present for a source mob.

Parameters:

markOut - Mark out property of this timeline mob slot.

getUserPos

@PositionType
long getUserPos()
                throws PropertyNotPresentException

Returns the user position property of the timeline mob slot, which specifies a user position as a count of edit units from the zero position of the timeline mob slot. This is an optional property.

Note that this property shall not be present for a source mob.

Returns:

The user position property of this timeline mob slot.

Throws:

PropertyNotPresentException - The optional user position property is not present in this timeline mob slot.

setUserPos

void setUserPos(@PositionType
                Long userPos)

Sets the user position property of the timeline mob slot, which specifies a user position as a count of edit units from the zero position of the timeline mob slot. Set this optional property to null to omit it.

Note that this property shall not be present for a source mob.

Parameters:

userPos - User position property of this timeline mob slot.