Media Authoring
with Java API

tv.amwa.maj.entity
Class MobSlot

java.lang.Object
  extended by tv.amwa.maj.entity.InterchangeObject
      extended by tv.amwa.maj.entity.MobSlot
All Implemented Interfaces:
Serializable, Cloneable, InterchangeObject, MobSlot, XMLSerializable
Direct Known Subclasses:
EventMobSlot, StaticMobSlot, TimelineMobSlot

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=14336,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="MobSlot",
          description="The MobSlot class represents an individual track in a Mob.")
public abstract class MobSlot
extends InterchangeObject
implements MobSlot, Serializable, Cloneable

Implements the representation of 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.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:
Richard Cartwright
See Also:
Serialized Form

Nested Class Summary
static class MobSlot.MobSlotSegmentXMLHandler
           
static class MobSlot.XMLHandler
           
 
Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject
InterchangeObject.InterchangeObjectXMLHandler
 
Field Summary
static String MOBSLOT_ITEM
           
 
Constructor Summary
MobSlot()
           
 
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.
 MobSlot clone()
           
 boolean equals(Object o)
           
 DataDefinition getDataDefinition()
          Returns the data definition describing the type of essence represented by the value of this mob slot.
 long getId()
           
 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.
 int hashCode()
           
 void setId(long id)
           
 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 setPropertiesFromInterface(MobSlot castFrom)
           
 void setSegment(Segment segment)
          Sets the segment for this mob slot, which is the value of the slot.
 void setSlotID(int value)
          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 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, wait, wait, wait
 
Methods inherited from interface tv.amwa.maj.iface.InterchangeObject
countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue
 

Field Detail

MOBSLOT_ITEM

public static final String MOBSLOT_ITEM
See Also:
Constant Field Values
Constructor Detail

MobSlot

public MobSlot()
Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(MobSlot castFrom)
See Also:
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)

getDataDefinition

public DataDefinition getDataDefinition()
Description copied from interface: MobSlot

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

Specified by:
getDataDefinition in interface MobSlot
Returns:
Data definition object associated with the segment in the mob slot.
See Also:
DataDefinition, DataDefinitionConstant, MobSlot.getSegment(), Component.getDataDefinition()

getName

@AAFProperty(uuid1=17236226,
             uuid2=256,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="SlotName",
             typeName="String",
             optional=true,
             uniqueIdentifier=false,
             pid=18434)
public String getName()
               throws PropertyNotPresentException
Description copied from interface: MobSlot

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

Specified by:
getName in interface MobSlot
Returns:
Name of this mob slot.
Throws:
PropertyNotPresentException - The optional name property is not present for this mob slot.

setName

public void setName(String name)
Description copied from interface: MobSlot

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

Specified by:
setName in interface MobSlot
Parameters:
name - Name of this mob slot.

getPhysicalNumber

@AAFProperty(uuid1=17039619,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="PhysicalTrackNumber",
             typeName="UInt32",
             optional=true,
             uniqueIdentifier=false,
             pid=18436)
public int getPhysicalNumber()
                      throws PropertyNotPresentException
Description copied from interface: MobSlot

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.

Specified by:
getPhysicalNumber in interface MobSlot
Returns:
The physical output channel associated with this mob slot.
Throws:
PropertyNotPresentException - The mob slot is not a physical slot.

setPhysicalNumber

public void setPhysicalNumber(Integer physicalTrackNumber)
                       throws IllegalArgumentException
Description copied from interface: MobSlot

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.

Specified by:
setPhysicalNumber in interface MobSlot
Parameters:
physicalTrackNumber - Physical track number for this mob slot.
Throws:
IllegalArgumentException - The given physical track number is negative.

getSegment

@AAFProperty(uuid1=100729092,
             uuid2=516,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Segment",
             typeName="StrongReference to Segment",
             optional=false,
             uniqueIdentifier=false,
             pid=18435)
public Segment getSegment()
Description copied from interface: MobSlot

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

Specified by:
getSegment in interface MobSlot
Returns:
Segment specifying the value of this mob slot.

setSegment

public void setSegment(Segment segment)
                throws NullPointerException
Description copied from interface: MobSlot

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

Specified by:
setSegment in interface MobSlot
Parameters:
segment - Segment representing the value for this mob slot.
Throws:
NullPointerException - The given segment is null.

getSlotID

@AAFProperty(uuid1=17236225,
             uuid2=0,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="SlotID",
             typeName="UInt32",
             optional=false,
             uniqueIdentifier=false,
             pid=18433)
public int getSlotID()
Description copied from interface: MobSlot

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

Specified by:
getSlotID in interface MobSlot
Returns:
Slot id of this mob slot.

setSlotID

public void setSlotID(int value)
               throws IllegalArgumentException
Description copied from interface: MobSlot

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

Specified by:
setSlotID in interface MobSlot
Parameters:
value - Slot id for this mob slot.
Throws:
IllegalArgumentException - The given slot id is negative.
See Also:
SlotExistsException

getId

public long getId()

setId

public void setId(long id)

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

clone

public MobSlot clone()
Overrides:
clone in class Object

appendXMLChildren

public void appendXMLChildren(Node parent)
Description copied from interface: XMLSerializable

Append child elements to the given parent node to serialize the value of an object to an XML fragment. Methods of the XMLBuilder class are provided to help with this process.

Specified by:
appendXMLChildren in interface XMLSerializable
Overrides:
appendXMLChildren in class InterchangeObject
Parameters:
parent - XML parent element to append child nodes to.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.