tv.amwa.maj.iface
Interface CompositionMob

All Superinterfaces:

InterchangeObject, Mob

All Known Implementing Classes:

CompositionMob

public interface CompositionMob
extends Mob

Specifies 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.

Author:

Richard Cartwright

See Also:

makeCompositionMob()

Method Summary

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.
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	setRendering(MobID mobId) Set the mob id of a rendering of this composition mob, which specifies a mixdown of the composition.

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

Method Detail

getDefaultFade

DefaultFade getDefaultFade()
                           throws PropertyNotPresentException

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.

Returns:

Default fade for the composition.

Throws:

PropertyNotPresentException - The optional default fade properties are not present in this composition mob.

setDefaultFade

void setDefaultFade(@LengthType
                    long fadeLength,
                    FadeType fadeType,
                    Rational fadeEditUnit)
                    throws BadLengthException

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.

Parameters:

fadeLength - Default fade length for the fade.

fadeType - Default fade type for the fade.

fadeEditUnit - Default fade edit unit for the fade.

Throws:

BadLengthException - Fade length is negative.

setDefaultFade

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. The default fade properties are optional and can be omitted by calling this method with null.

Parameters:

defaultFade - Default fade properties for this composition mob.

See Also:

DefaultFade.DefaultFade(long, FadeType, Rational)

setRendering

void setRendering(MobID mobId)

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.

Parameters:

mobId - Mob id for a rendering of this composition mob.

getRendering

MobID getRendering()
                   throws PropertyNotPresentException

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.

Returns:

Mob id of a rendering of the composition.

Throws:

PropertyNotPresentException - The optional rendering property is not present in this composition mob.