|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecttv.amwa.maj.entity.InterchangeObject
tv.amwa.maj.entity.Mob
tv.amwa.maj.entity.CompositionMob
@AAFClass(uuid1=218169601, uuid2=257, uuid3=13568, uuid4={6,14,43,52,2,6,1,1}, definedName="CompositionMob", description="The CompositionMob class specifies how to combine essence elements into a sequence, how to modify essence elements, and how to synchronize essence elements.") public class CompositionMob
Implements a material object that describes how to combine content data elements into a sequence, how to modify content data elements, and how to synchronize content data elements.
THE COMMENTS IN THIS CLASS ARE INCOMPLETE.
Nested Class Summary | |
---|---|
static class |
CompositionMob.XMLHandler
|
Nested classes/interfaces inherited from class tv.amwa.maj.entity.Mob |
---|
Mob.MobAttributesXMLHandler, Mob.MobKLVDataXMLHandler, Mob.MobUserCommentsXMLHandler, Mob.SlotsXMLHandler |
Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject |
---|
InterchangeObject.InterchangeObjectXMLHandler |
Field Summary | |
---|---|
static String |
COMPOSITIONMOB_TAG
|
Fields inherited from class tv.amwa.maj.entity.Mob |
---|
MOB_ITEM |
Constructor Summary | |
---|---|
CompositionMob(MobID mobID,
String name)
Creates and initializes a composition mob, which specifies how to combine essence elements into a sequence, how to modify essence elements, and how to synchronize essence elements. |
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. |
CompositionMob |
clone()
Creates a cloned copy of this entity. |
DefaultFade |
getDefaultFade()
Returns the default fade for this composition mob, which specifies the default fade to be applied to all audio source clips that do not specify their own audio fade properties. |
Rational |
getDefaultFadeEditUnit()
|
long |
getDefaultFadeLength()
|
FadeType |
getDefaultFadeType()
|
MobID |
getRendering()
Returns the mob id of a rendering of this composition mob, which specifies a mixdown of the composition. |
void |
setDefaultFade(DefaultFade defaultFade)
Sets the default fade properties for this composition mob, which specifies the default fade to be applied to all audio source clips that do not specify their own audio fade properties. |
void |
setDefaultFade(long fadeLength,
FadeType fadeType,
Rational fadeEditUnit)
Sets the default fade properties of this composition mob, which specifies the default fade to be applied to all audio source clips that do not specify their own audio fade properties. |
void |
setPropertiesFromInterface(CompositionMob castFrom)
|
void |
setRendering(MobID mobID)
Set the mob id of a rendering of this composition mob, which specifies a mixdown of the composition. |
Methods inherited from class tv.amwa.maj.entity.Mob |
---|
appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, appendNewEventSlot, appendNewStaticSlot, appendNewTimelineSlot, appendSlot, changeReference, cloneExternal, copy, countAttributes, countComments, countKLVData, countSlots, equals, getAttributes, getComments, getCreateTime, getKLVData, getMobID, getModTime, getName, getSlotAt, getSlots, getUsageCode, hashCode, insertSlotAt, lookupSlot, offsetToMobTimecode, prependSlot, removeAttribute, removeComment, removeKLVData, removeSlotAt, setCreateTime, setMobID, setModTime, setName, setPropertiesFromInterface, setUsageCode |
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 |
---|
equals, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface tv.amwa.maj.iface.Mob |
---|
appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, appendNewEventSlot, appendNewStaticSlot, appendNewTimelineSlot, appendSlot, changeReference, cloneExternal, copy, countAttributes, countComments, countKLVData, countSlots, getAttributes, getComments, getCreateTime, getKLVData, getMobID, getModTime, getName, getSlotAt, getSlots, getUsageCode, insertSlotAt, lookupSlot, offsetToMobTimecode, prependSlot, removeAttribute, removeComment, removeKLVData, removeSlotAt, setCreateTime, setMobID, setModTime, setName, setUsageCode |
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 |
---|
equals, hashCode, toString |
Field Detail |
---|
public static final String COMPOSITIONMOB_TAG
Constructor Detail |
---|
public CompositionMob(MobID mobID, @AAFString String name) throws NullPointerException
Creates and initializes a composition mob, which specifies how to combine
essence elements into a sequence, how to modify essence elements, and how to synchronize
essence elements. The required properties of creation time and last modified time will
be set automatically to the time of calling this method. These timestamp values can be
set manually by calling
setCreateTime()
and
and setModTime()
.
mobID
- Unique material identifier for the new composition mob.name
- Name of the new composition mob.
NullPointerException
- Unique material identifier argument is null
.Method Detail |
---|
public final void setPropertiesFromInterface(CompositionMob castFrom)
InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)
public DefaultFade getDefaultFade() throws PropertyNotPresentException
CompositionMob
Returns the default fade for this composition mob, which specifies the default fade to be applied to all audio source clips that do not specify their own audio fade properties. The default fade properties are optional.
getDefaultFade
in interface CompositionMob
PropertyNotPresentException
- The optional default fade properties are
not present in this composition mob.public void setDefaultFade(long fadeLength, FadeType fadeType, Rational fadeEditUnit) throws BadLengthException
CompositionMob
Sets the default fade properties of this composition mob, which specifies the default
fade to be applied to all audio source clips that do not specify their
own audio fade properties. The default fade properties are optional and can be omitted
by calling this method with null
for either the fade type or fade edit unit
properties.
setDefaultFade
in interface CompositionMob
fadeLength
- Default fade length for the fade.fadeType
- Default fade type for the fade.fadeEditUnit
- Default fade edit unit for the fade.
BadLengthException
- Fade length is negative.public void setDefaultFade(DefaultFade defaultFade)
CompositionMob
Sets the default fade properties for this composition mob, which specifies the default
fade to be applied to all audio source clips that do not specify their
own audio fade properties. The default fade properties are optional and can be omitted
by calling this method with null
.
setDefaultFade
in interface CompositionMob
defaultFade
- Default fade properties for this composition mob.DefaultFade.DefaultFade(long, FadeType, Rational)
@AAFProperty(uuid1=117572097, uuid2=261, uuid3=256, uuid4={6,14,43,52,1,1,1,2}, definedName="DefaultFadeLength", typeName="LengthType", optional=true, uniqueIdentifier=false, pid=17665) public long getDefaultFadeLength() throws PropertyNotPresentException
PropertyNotPresentException
@AAFProperty(uuid1=87032321, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="DefFadeType", typeName="FadeType", optional=true, uniqueIdentifier=false, pid=17666) public FadeType getDefaultFadeType() throws PropertyNotPresentException
PropertyNotPresentException
@AAFProperty(uuid1=87032835, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="DefFadeEditUnit", typeName="Rational", optional=true, uniqueIdentifier=false, pid=17667) public Rational getDefaultFadeEditUnit() throws PropertyNotPresentException
PropertyNotPresentException
@AAFProperty(uuid1=100729092, uuid2=266, uuid3=0, uuid4={6,14,43,52,1,1,1,8}, definedName="Rendering", typeName="MobIDType", optional=true, uniqueIdentifier=false, pid=17668) public MobID getRendering() throws PropertyNotPresentException
CompositionMob
Returns the mob id of a rendering of this composition mob, which specifies a mixdown of the composition. The start of the mixdown and the start of the composition are assumed to be co-timed.
getRendering
in interface CompositionMob
PropertyNotPresentException
- The optional rendering property is not
present in this composition mob.public void setRendering(MobID mobID)
CompositionMob
Set the mob id of a rendering of this composition
mob, which specifies a mixdown of the composition. The start of the mixdown
and the start of the composition are assumed to be co-timed. Set the rendering to
null
to omit this optional property.
setRendering
in interface CompositionMob
mobID
- Mob id for a rendering of this composition mob.public CompositionMob clone()
MAJCommon
Creates a cloned copy of this entity. The clone will be initialized to have the same value as this value but exists independently from then on. Changes to this value will not effect the clone and changes to the clone will not effect this. MAJ API clones are true deep clones with no shared references to areas of memory within the original.
This method does not throw a CloneNotSupportedException
as all
entity values must implement the Cloneable
interface. If a cloning
error does occur, a null
value will be returned but this is very unlikely
to happen.
clone
in interface MAJCommon
clone
in class Mob
Object.clone()
public void appendXMLChildren(Node parent)
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.
appendXMLChildren
in interface XMLSerializable
appendXMLChildren
in class Mob
parent
- XML parent element to append child nodes to.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |