tv.amwa.maj.iface
Interface SourceClip

All Superinterfaces:

Component, InterchangeObject, Segment, SourceReferenceSegment

All Known Subinterfaces:

DescriptiveClip

All Known Implementing Classes:

DescriptiveClip, SourceClip

public interface SourceClip
extends SourceReferenceSegment

Specifies a representation of essence and identifies the source of the essence. This interface uses the source reference values to manage the properties of a source clip.

Source clips can by explicit, in context or indicating that the mob in which the clip is contained is the original source. For more information, see the description of the source clip factory method.

Author:

Richard Cartwright

See Also:

makeSourceClip(), SourceReferenceValue, SourceReferenceValue

Method Summary

Fade	getFade() Deprecated. The fade properties of a source clip are deprecated in the AAF specification. Use a transition with an appropriate effect instead.
SourceReferenceValue	getSourceReference() The method returns the source reference of this source clip.
Mob	resolveRef() Returns the mob that this source clip references.
void	setFade(Fade fade) Deprecated. The fade properties of a source clip are deprecated in the AAF specification. Use a transition with an appropriate effect instead.
void	setFade(long fadeInLength, FadeType fadeInType, long fadeOutLength, FadeType fadeOutType) Deprecated. The fade properties of a source clip are deprecated in the AAF specification. Use a transition with an appropriate effect instead.
void	setSourceReference(SourceReferenceValue sourceReference) Sets the source reference of this source clip.

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

getChannelIDs, getChannelIDsSize, getMonoSourceSlotIDs, getMonoSourceSlotIDsSize, getSourceID, getSourceMobSlotID, setChannelIDs, setMonoSourceSlotIDs, setSourceID, setSourceMobSlotID

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

segmentOffsetToTC, segmentTCToOffset

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

appendAttribute, appendAttribute, appendComment, appendComment, appendKLVData, countAttributes, countComments, countKLVData, getAttributes, getComments, getDataDefinition, getKLVData, getLength, removeAttribute, removeComment, removeKLVData, setDataDefinition, setLength

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

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

Method Detail

getFade

@Deprecated
Fade getFade()

Deprecated. The fade properties of a source clip are deprecated in the AAF specification. Use a transition with an appropriate effect instead.

This method returns the optional fade information for this source clip. This function only applies to audio source clips. Length units are specified by the containing mob slot's edit rate.

Returns:

Fade information for this source clip.

resolveRef

Mob resolveRef()
               throws MobNotFoundException

Returns the mob that this source clip references.

Returns:

Mob that the source clip references.

Throws:

MobNotFoundException - The source reference of this source clip could not be resolved to a mob.

getSourceReference

SourceReferenceValue getSourceReference()

The method returns the source reference of this source clip. The source reference includes the start time property of this source clip.

Returns:

Source reference of this source clip.

See Also:

SourceReferenceValue.isContextual(), SourceReferenceValue.isOriginalSource(), SourceReferenceValue.getStartTime()

setFade

@Deprecated
void setFade(@LengthType
                        long fadeInLength,
                        FadeType fadeInType,
                        @LengthType
                        long fadeOutLength,
                        FadeType fadeOutType)
             throws BadLengthException

Deprecated. The fade properties of a source clip are deprecated in the AAF specification. Use a transition with an appropriate effect instead.

Sets the optional fade properties of this source clip. The fade properties only apply to a source clip of data definition (or convertible to a data definition) of type sound. All arguments should be specified. Length units are specified by the containing mob slot's edit rate.

Parameters:

fadeInLength - Fade in length for the source clip.

fadeInType - Fade in type for the source clip.

fadeOutLength - Fade out length for the source clip.

fadeOutType - Fade out type for the source clip.

Throws:

BadLengthException - One or both of the length parameters of the fade is/are negative.

See Also:

Component.getDataDefinition(), DataDefinitionConstant.Sound, setFade(tv.amwa.maj.record.Fade)

setFade

@Deprecated
void setFade(Fade fade)
             throws NullPointerException

Deprecated. The fade properties of a source clip are deprecated in the AAF specification. Use a transition with an appropriate effect instead.

Sets the optional fade properties of this source clip from a set of fade properties. The fade properties only apply to a source clip of data definition (or convertible to a data definition) of type sound. Length units are specified by the containing mob slot's edit rate.

Parameters:

fade - Parameters of a fade for this source clip.

Throws:

NullPointerException - The given set of fade properties is null.

See Also:

Component.getDataDefinition(), DataDefinitionConstant.Sound, Fade.Fade(long, FadeType, long, FadeType), setFade(long, FadeType, long, FadeType)

setSourceReference

void setSourceReference(SourceReferenceValue sourceReference)
                        throws NullPointerException

Sets the source reference of this source clip. The source reference includes the start time property of this source clip.

Parameters:

sourceReference - Source reference of this source clip.

Throws:

NullPointerException - The given source reference is null.

See Also:

SourceReferenceValue.originalSource(), SourceReferenceValue.inContextReference(int), SourceReferenceValue.inContextReference(int, Long), SourceReferenceValue.SourceReferenceValue(tv.amwa.maj.record.MobID, int, Long)