public interface DescriptiveMarker extends CommentMarker
Specifies descriptive metadata associated with a point in time and the tracks that the description refers to. A descriptive marker may contain a descriptive framework that specifies the metadata.
If a descriptive marker refers to a static track, the extent of the description is for the entire package.
DescriptiveFramework,
DescriptiveClip| Modifier and Type | Interface and Description |
|---|---|
static class |
DescriptiveMarker.AllTracksDescribed
Contrived inner class that represents the set of all positive integers and zero.
|
| Modifier and Type | Field and Description |
|---|---|
static Set<Integer> |
AllTracksDescribed
Default value for the described tracks parameter.
|
static Set<Integer> |
NoTracksDescribed
No tracks are described by the marker.
|
| Modifier and Type | Method and Description |
|---|---|
DescriptiveMarker |
clone()
Create a cloned copy of this descriptive marker.
|
Set<Integer> |
getDescribedTrackIDs()
Returns the set of described track ids that are referenced by this descriptive marker.
|
int |
getDescribedTrackIDsSize()
Returns the number of track ids referred to by this descriptive
marker.
|
DescriptiveFramework |
getDescriptiveFrameworkObject()
Returns the
descriptive framework that specifies the metadata for
this descriptive marker. |
String |
getDescriptiveMetadataApplicationEnvironmentID()
Returns the application environment identifier, an Uniform
Resource Identifier (RFC 3986) that identifies the application to which the information in this plugin
object applies.
|
AUID |
getDescriptiveMetadataPluginID()
Returns the immutable identifier for this descriptive metadata plugin instance.
|
ExtensionScheme |
getDescriptiveMetadataScheme()
Returns the descriptive metadata scheme that is referenced by the descriptive framework
object.
|
void |
setDescribedTrackIDs(Set<Integer> describedTrackIDs)
|
void |
setDescriptiveFrameworkObject(DescriptiveFramework descriptiveFramework)
Sets the
descriptive framework that specifies the metadata for
this descriptive marker. |
void |
setDescriptiveMetadataApplicationEnvironmentID(String descriptiveMetadataApplicationEnvironmentID)
Sets the application environment identifier, an Uniform
Resource Identifier (RFC 3986) that identifies the application to which the information in this plugin
object applies.
|
void |
setDescriptiveMetadataPluginID(AUID descriptiveMetadataPluginID)
Sets the immutable identifier for this descriptive metadata plugin instance.
|
void |
setDescriptiveMetadataScheme(ExtensionScheme extensionScheme)
Sets the descriptive metadata scheme that is referenced by the descriptive framework
object.
|
getAnnotationSource, setAnnotationgetEventComment, getEventPosition, setEventComment, setEventPositiongenerateSequence, 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, setPersistentIndexstatic final Set<Integer> AllTracksDescribed
Default value for the described tracks parameter. This value is a set that contains all track
indexes from 0 to Integer.MAX_VALUE.
void setDescribedTrackIDs(@TrackID Set<Integer> describedTrackIDs) throws IllegalArgumentException
Specifies the track ids in the package to which
this descriptive marker refers. Set this optional property to null to
omit it, which indicates that all tracks are described. Set to NoTracksDescribed
to indicate that the marker does not refer to any tracks.
describedTrackIDs - Track id for the tracks in the associated package that this
descriptive marker describes.IllegalArgumentException - One or more of the track ids in the given set is negative.AllTracksDescribed,
Track@TrackID Set<Integer> getDescribedTrackIDs() throws PropertyNotPresentException
Returns the set of described track ids that are referenced by this descriptive marker. If the value returned
is equal to AllTracksDescribed, this descriptive marker describes all tracks in the
associated package.
PropertyNotPresentException - The optional described tracks property is not present in this
descriptive marker.@UInt32 int getDescribedTrackIDsSize() throws PropertyNotPresentException
Returns the number of track ids referred to by this descriptive
marker.Note that the default value is AllTracksDescribed, which has Integer.MAX_VALUE
track ids. Care should be taken not to end up iterating over all of these entries!
PropertyNotPresentException - The optional described tracks property is not present in this
descriptive marker.void setDescriptiveFrameworkObject(DescriptiveFramework descriptiveFramework)
Sets the descriptive framework that specifies the metadata for
this descriptive marker. Set this optional property to null to omit it.
descriptiveFramework - Specifies the descriptive framework.DescriptiveFrameworkDescriptiveFramework getDescriptiveFrameworkObject() throws PropertyNotPresentException
Returns the descriptive framework that specifies the metadata for
this descriptive marker.
PropertyNotPresentException - The optional descriptive framework property is not present
in this descriptive marker.DescriptiveFrameworkAUID getDescriptiveMetadataPluginID() throws PropertyNotPresentException
Returns the immutable identifier for this descriptive metadata plugin instance.
PropertyNotPresentException - The optional descriptive metadata plugin identifier
is not present for this descriptive marker.void setDescriptiveMetadataPluginID(AUID descriptiveMetadataPluginID)
Sets the immutable identifier for this descriptive metadata plugin instance.
descriptiveMetadataPluginID - Immutable identifier for this descriptive metadata plugin
instance.ExtensionScheme getDescriptiveMetadataScheme() throws PropertyNotPresentException
Returns the descriptive metadata scheme that is referenced by the descriptive framework object. A descriptive metadata scheme is represented by an extension scheme. This is an optional property.
PropertyNotPresentException - The optional descriptive metadata scheme property is
not present for this descriptive marker.getDescriptiveFrameworkObject(),
Root.getRootExtensions()void setDescriptiveMetadataScheme(ExtensionScheme extensionScheme)
Sets the descriptive metadata scheme that is referenced by the descriptive framework
object. A descriptive metadata scheme is represented by an
extension scheme. Set this optional property
to null to omit it.
extensionScheme - Descriptive metadata scheme that is referenced by the descriptive framework
object.setDescriptiveFrameworkObject(DescriptiveFramework)String getDescriptiveMetadataApplicationEnvironmentID() throws PropertyNotPresentException
Returns the application environment identifier, an Uniform Resource Identifier (RFC 3986) that identifies the application to which the information in this plugin object applies. This is an optional property.
PropertyNotPresentException - The optional descriptive metadata application environment identifier
is not present for this descriptive marker.void setDescriptiveMetadataApplicationEnvironmentID(String descriptiveMetadataApplicationEnvironmentID)
Sets the application environment identifier, an Uniform
Resource Identifier (RFC 3986) that identifies the application to which the information in this plugin
object applies. Set this optional property to null to omit it.
descriptiveMetadataApplicationEnvironmentID - Application environment identifier.DescriptiveMarker clone()
Create a cloned copy of this descriptive marker.
clone in interface CommentMarkerclone in interface Componentclone in interface Eventclone in interface InterchangeObjectclone in interface MediaEntityclone in interface Segment(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.