@MediaClass(uuid1=218169601, uuid2=257, uuid3=17664, uuid4={6,14,43,52,2,6,1,1}, definedName="DescriptiveClip", description="A descriptive clip specifies what is being described and references a package to provide that description.", symbol="DescriptiveClip") public class DescriptiveClipImpl extends SourceClipImpl implements DescriptiveClip, Serializable, Cloneable
Implements a means to identify what is being described in terms of tracks and references a package to provide that description. This enables a segment in a descriptive metadata track to reference a section of descriptive metadata in the track of another package. Typically, the referenced track would contain descriptive markers.
ObjectClassPropertyID| Constructor and Description |
|---|
DescriptiveClipImpl() |
DescriptiveClipImpl(DataDefinition dataDefinition,
long length,
SourceReferenceValue sourceReference)
Creates and initializes a new descriptive clip, which specifies what is being described and
references a package to provide that description.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addDescribedTrackID(int describedTrackID)
|
void |
clearDescribedTrackIDs()
Clears the list of described track ids of this descriptive clip, omitting this
optional property.
|
DescriptiveClip |
clone()
Create a cloned copy of this interchange object.
|
int |
countDescribedTrackIDs()
|
Set<Integer> |
getDescribedTrackIDs()
|
boolean |
isDescribedTrackIDPresent(int describedTrackID)
|
void |
removeDescribedTrackID(int describedTrackID)
|
getFade, getFadeInLength, getFadeInType, getFadeOutLength, getFadeOutType, getRushBlob, getRushChannelMask, getSourceReference, getStartPosition, resolveRef, setFade, setFade, setFadeInLength, setFadeInType, setFadeOutLength, setFadeOutType, setRushBlob, setRushChannelMask, setSourceReference, setStartPositionclearChannelIDs, clearMonoSourceTrackIDs, getChannelIDs, getChannelIDsSize, getMonoSourceTrackIDs, getMonoSourceTrackIDsSize, getSourcePackageID, getSourcePackageIDString, getSourceTrackID, initializeSourceTrackID, setChannelIDs, setMonoSourceTrackIDs, setSourcePackageID, setSourcePackageIDString, setSourceTrackIDgenerateSequence, getCutPoint, getKeyOffset, getPackLayerKeyIndicator, getSegmentBlob, getTrackBlob, getTrackKeyRenderSequence, getTrackName, getTrackRenderSequence, segmentOffsetToTC, segmentTCToOffset, setCutPoint, setKeyOffset, setPackLayerKeyIndicator, setSegmentBlob, setTrackBlob, setTrackKeyRenderSequence, setTrackName, setTrackRenderSequenceappendComponentAttribute, appendComponentAttribute, appendComponentKLVData, appendComponentUserComment, appendComponentUserComment, clearComponentAttributes, clearComponentKLVData, clearComponentUserComments, countComponentAttributes, countComponentKLVData, countComponentUserComments, getComment, getComponentAttributes, getComponentDataDefinition, getComponentKLVData, getComponentLength, getComponentUserComments, getEditName, getJupiterClipOffset, getJupiterID, getLengthPresent, initializeComponentDataDefinition, prependComponentAttribute, prependComponentKLVData, prependComponentUserComment, removeComponentAttribute, removeComponentKLVData, removeComponentUserComment, setComponentDataDefinition, setComponentLength, setComponentLengthFromStream, setEditName, setJupiterClipOffset, setJupiterID, setLengthPresentaddApplicationPlugin, appendXMLChildren, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getLinkedGenerationIDString, getObjectClass, getPersistentID, getPersistentIndex, hashCode, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setLinkedGenerationIDString, setObjectClass, setPersistentID, setPersistentIndex, toStringgetFade, getFadeInLength, getFadeInType, getFadeOutLength, getFadeOutType, getSourceReference, getStartPosition, resolveRef, setFade, setFade, setSourceReference, setStartPositiongetChannelIDs, getChannelIDsSize, getMonoSourceTrackIDs, getMonoSourceTrackIDsSize, getSourcePackageID, getSourceTrackID, setChannelIDs, setMonoSourceTrackIDs, setSourcePackageID, setSourceTrackIDgenerateSequence, segmentOffsetToTC, segmentTCToOffsetappendComponentAttribute, appendComponentAttribute, appendComponentKLVData, appendComponentUserComment, appendComponentUserComment, clearComponentAttributes, clearComponentKLVData, clearComponentUserComments, countComponentAttributes, countComponentKLVData, countComponentUserComments, getComponentAttributes, getComponentDataDefinition, getComponentKLVData, getComponentLength, getComponentUserComments, getLengthPresent, removeComponentAttribute, removeComponentKLVData, removeComponentUserComment, setComponentDataDefinition, setComponentLength, setLengthPresentaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexpublic DescriptiveClipImpl()
public DescriptiveClipImpl(DataDefinition dataDefinition, long length, SourceReferenceValue sourceReference) throws NullPointerException, BadLengthException
Creates and initializes a new descriptive clip, which specifies what is being described and references a package to provide that description.
dataDefinition - Kind of data represented by this component.length - Length of the source clip component.sourceReference - Reference to the package providing the description.NullPointerException - The data definition and/or source reference arguments are
null.BadLengthException - The length of a descriptive clip cannot be negative.@MediaProperty(uuid1=17236230, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="DescriptiveClipDescribedTrackIDs", aliases="DescribedSlotIDs", typeName="UInt32Set", optional=true, uniqueIdentifier=false, pid=24835, symbol="DescriptiveClipDescribedTrackIDs") public Set<Integer> getDescribedTrackIDs()
DescriptiveClipReturns a copy of the set of descriptive track ids referenced by this descriptive clip, which specify which of the tracks in the package are being referenced.
getDescribedTrackIDs in interface DescriptiveClip@MediaSetAdd(value="DescriptiveClipDescribedTrackIDs") public void addDescribedTrackID(int describedTrackID) throws IllegalArgumentException, InvalidParameterException
DescriptiveClipAdds the given described track id to the set of described track ids referenced by this descriptive clip, which specify which of the tracks in the package are being referenced.
addDescribedTrackID in interface DescriptiveClipdescribedTrackID - Descriptive track id to add to the set of described track ids
referenced by this descriptive clip.IllegalArgumentException - The given track id is negative.InvalidParameterException - The given described track id is already contained
in the set of described track ids referenced by this descriptive clip.@MediaPropertyCount(value="DescriptiveClipDescribedTrackIDs") public int countDescribedTrackIDs()
DescriptiveClipReturns the number of described track ids in the set of described track ids referenced by this descriptive clip, which specify which of the tracks in the package are being referenced.
countDescribedTrackIDs in interface DescriptiveClip@MediaPropertyContains(value="DescriptiveClipDescribedTrackIDs") public boolean isDescribedTrackIDPresent(int describedTrackID) throws IllegalArgumentException
DescriptiveClipReturns true if the given described track id is present in the
set of described track ids referenced from this descriptive clip, which specify which of the
tracks in the package are being referenced.
isDescribedTrackIDPresent in interface DescriptiveClipdescribedTrackID - Described track id to check to see if it is contained in the set
of described track ids of this descriptive clip.IllegalArgumentException - The given track id is negative.@MediaPropertyRemove(value="DescriptiveClipDescribedTrackIDs") public void removeDescribedTrackID(int describedTrackID) throws IllegalArgumentException, InvalidParameterException
DescriptiveClipRemoves the given described track id from the list of described track ids referenced by this descriptive clip, which specify which of the tracks in the package are being referenced. In effect, optional property empty sets become not present when the last element is removed.
removeDescribedTrackID in interface DescriptiveClipdescribedTrackID - Described track id to remove from this descriptive clip.IllegalArgumentException - A given track id is negative.InvalidParameterException - The given track id is not in the set of descriptive
track ids of this descriptive clip.@MediaPropertyClear(value="DescriptiveClipDescribedTrackIDs") public void clearDescribedTrackIDs()
DescriptiveClipClears the list of described track ids of this descriptive clip, omitting this optional property.
clearDescribedTrackIDs in interface DescriptiveClippublic DescriptiveClip clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface Componentclone in interface DescriptiveClipclone in interface InterchangeObjectclone in interface Segmentclone in interface SourceClipclone in interface SourceReferenceSegmentclone in class SourceClipImpl(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.