tv.amwa.maj.iface
Interface DescriptiveClip

All Superinterfaces:

Component, InterchangeObject, Segment, SourceClip, SourceReferenceSegment

All Known Implementing Classes:

DescriptiveClip

public interface DescriptiveClip
extends SourceClip

Specifies what is being described in terms of mob slots and references a mob to provide that description. This enables a segment in a descriptive metadata mob slot to reference a section of descriptive metadata in the mob slot of another mob. Typically, the referenced mob slot would contain descriptive markers.

Author:

Richard Cartwright

See Also:

makeDescriptiveClip()

Method Summary

void	addDescribedSlotID(int describedSlotID) Adds the given described slot id to the list of described slot ids referenced by this descriptive clip,which specify which of the essence mob slots in the mob are being referenced.
int	countDescribedSlotIDs() Returns the number of described slot ids in the set of described slot ids referenced by this descriptive clip, which specify which of the essence mob slots in the mob are being referenced.
Set<Integer>	getDescribedSlotIDs() Returns a copy of the set of descriptive slot ids referenced by this descriptive clip, which specify which of the essence mob slots in the mob are being referenced.
boolean	isDescribedSlotIDPresent(int describedSlotId) Returns true if the given described slot id is present in the set of described slot ids referenced from this source clip, hich specify which of the essence mob slots in the mob are being referenced.
void	removeDescribedSlotID(int describedSlotId) Removes the given described slot id from the list of described slot ids referenced by this descriptive clip, which specify which of the essence mob slots in the mob are being referenced.

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

getFade, getSourceReference, resolveRef, setFade, setFade, setSourceReference

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

countDescribedSlotIDs

@UInt32
int countDescribedSlotIDs()

Returns the number of described slot ids in the set of described slot ids referenced by this descriptive clip, which specify which of the essence mob slots in the mob are being referenced.

Returns:

Number of described slot ids in the set of described slot ids referenced by this descriptive clip.

getDescribedSlotIDs

@UInt32
Set<Integer> getDescribedSlotIDs()

Returns a copy of the set of descriptive slot ids referenced by this descriptive clip, which specify which of the essence mob slots in the mob are being referenced.

Returns:

A copy of the set of descriptive slot ids referenced by this descriptive clip.

isDescribedSlotIDPresent

boolean isDescribedSlotIDPresent(@UInt32
                                 int describedSlotId)

Returns true if the given described slot id is present in the set of described slot ids referenced from this source clip, hich specify which of the essence mob slots in the mob are being referenced.

Parameters:

describedSlotId - Described slot id to check to see if it is contained in the set of described slot ids of this descriptive clip.

Returns:

Is the given described slot id present in the set of described slot ids referenced by this descriptive clip?

Throws:

IllegalArgumentException - The given slot id is negative.

addDescribedSlotID

void addDescribedSlotID(@UInt32
                        int describedSlotID)
                        throws IllegalArgumentException,
                               InvalidParameterException

Adds the given described slot id to the list of described slot ids referenced by this descriptive clip,which specify which of the essence mob slots in the mob are being referenced.

Parameters:

describedSlotID - Descriptive slot id to add to the set of described slot ids referenced by this descriptive clip.

Throws:

IllegalArgumentException - The given slot id is negative.

InvalidParameterException - The given described slot id is already contained in the list of described slot ids referenced by this descriptive clip.

removeDescribedSlotID

void removeDescribedSlotID(@UInt32
                           int describedSlotId)
                           throws InvalidParameterException

Removes the given described slot id from the list of described slot ids referenced by this descriptive clip, which specify which of the essence mob slots in the mob are being referenced. In effect, optional property empty sets become not present when the last element is removed.

Parameters:

describedSlotId - Described slot id to remove from this descriptive clip.

Throws:

IllegalArgumentException - A given slot id is negative.

InvalidParameterException - The given slot id is not in the set of descriptive slot ids of this descriptive clip.