tv.amwa.maj.iface
Interface MobSlot

All Superinterfaces:

InterchangeObject

All Known Subinterfaces:

EventMobSlot, StaticMobSlot, TimelineMobSlot

All Known Implementing Classes:

EventMobSlot, MobSlot, StaticMobSlot, TimelineMobSlot

public interface MobSlot
extends InterchangeObject

Specifies a single track in a mob. A track describes the relationship between essence and time. In a master mob, mob slots describe the desired relationship between stored essence and the output timeline.

Author:

Richard Cartwright

See Also:

Mob.appendSlot(MobSlot), Mob.getSlots(), Mob.lookupSlot(int)

Method Summary

DataDefinition	getDataDefinition() Returns the data definition describing the type of essence represented by the value of this mob slot.
String	getName() Returns the name of this mob slot.
int	getPhysicalNumber() Returns the physical output channel associated with this mob slot.
Segment	getSegment() Returns the segment of this mob slot, which is the value of the slot.
int	getSlotID() Returns the slot id of this mob slot, which specifies an integer that is used to reference this mob slot.
void	setName(String name) Sets the name of this mob slot.
void	setPhysicalNumber(Integer physicalTrackNumber) Sets the physical output channel associated with this mob slot.
void	setSegment(Segment segment) Sets the segment for this mob slot, which is the value of the slot.
void	setSlotID(int slotId) This method will set the slot id of this mob slot, which specifies an integer that is used to reference this mob slot.

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

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

Method Detail

setName

void setName(@AAFString
             String name)

Sets the name of this mob slot. Set this optional property to null to omit it.

Parameters:

name - Name of this mob slot.

getName

@AAFString
String getName()
               throws PropertyNotPresentException

Returns the name of this mob slot. This is an optional property.

Returns:

Name of this mob slot.

Throws:

PropertyNotPresentException - The optional name property is not present for this mob slot.

setPhysicalNumber

void setPhysicalNumber(@UInt32
                       Integer physicalTrackNumber)
                       throws IllegalArgumentException

Sets the physical output channel associated with this mob slot. Set this optional property to null to omit it.

The physical track number identifies the physical channel associated with the media. For file source mobs that describe stereo audio media, the left channel should have a physical slot number of 1 and the right channel should have a physical slot of 2.

Parameters:

physicalTrackNumber - Physical track number for this mob slot.

Throws:

IllegalArgumentException - The given physical track number is negative.

getPhysicalNumber

@UInt32
int getPhysicalNumber()
                      throws PropertyNotPresentException

Returns the physical output channel associated with this mob slot. This is an optional property.

The physical track number identifies the physical channel associated with the media. For file source mobs that describe stereo audio media, the left channel should have a physical slot number of 1 and the right channel should have a physical slot of 2.

Returns:

The physical output channel associated with this mob slot.

Throws:

PropertyNotPresentException - The mob slot is not a physical slot.

setSlotID

void setSlotID(@SlotID
               int slotId)
               throws IllegalArgumentException

This method will set the slot id of this mob slot, which specifies an integer that is used to reference this mob slot.

Parameters:

slotId - Slot id for this mob slot.

Throws:

IllegalArgumentException - The given slot id is negative.

See Also:

SlotExistsException

getSlotID

@SlotID
int getSlotID()

Returns the slot id of this mob slot, which specifies an integer that is used to reference this mob slot.

Returns:

Slot id of this mob slot.

setSegment

void setSegment(Segment segment)
                throws NullPointerException

Sets the segment for this mob slot, which is the value of the slot.

Parameters:

segment - Segment representing the value for this mob slot.

Throws:

NullPointerException - The given segment is null.

getSegment

Segment getSegment()

Returns the segment of this mob slot, which is the value of the slot.

Returns:

Segment specifying the value of this mob slot.

getDataDefinition

DataDefinition getDataDefinition()

Returns the data definition describing the type of essence represented by the value of this mob slot.

Returns:

Data definition object associated with the segment in the mob slot.

See Also:

DataDefinition, DataDefinitionConstant, getSegment(), Component.getDataDefinition()