Package org.opencastproject.metadata.mpeg7

Interface AudioVisualSegment

All Superinterfaces:

Segment, XmlElement

All Known Implementing Classes:

SegmentImpl

public interface AudioVisualSegment
extends Segment

An audiovisual segment represents a temporal decomposition of the audiovisual stream that may have properties like text annotations attached to it.

 <complexType name="AudioVisualSegmentType">
   <complexContent>
       <extension base="mpeg7:SegmentType">
           <sequence>
               <choice minOccurs="0">
                   <element name="MediaTime" type="mpeg7:MediaTimeType"/>
                   <element name="TemporalMask" type="mpeg7:TemporalMaskType"/>
               </choice>
               <choice minOccurs="0" maxOccurs="unbounded">
                   <element name="SpatialDecomposition"
                       type="mpeg7:AudioVisualSegmentSpatialDecompositionType"/>
                   <element name="TemporalDecomposition"
                       type="mpeg7:AudioVisualSegmentTemporalDecompositionType"/>
                   <element name="SpatioTemporalDecomposition"
                       type="mpeg7:AudioVisualSegmentSpatioTemporalDecompositionType"/>
                   <element name="MediaSourceDecomposition"
                       type="mpeg7:AudioVisualSegmentMediaSourceDecompositionType"/>
               </choice>
           </sequence>
       </extension>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.metadata.mpeg7.Segment

Segment.Type

Method Summary

Modifier and Type	Method	Description
SpatioTemporalDecomposition	createSpatioTemporalDecomposition(boolean gap, boolean overlap)	Creates a spatio temporal decomposition in this video segment.
SpatioTemporalDecomposition	getSpatioTemporalDecomposition()	Returns the spatio temporal decomposition that contains information about elements on the segment such as text elements.
boolean	hasSpatioTemporalDecomposition()	Returns true if there is a spatio temporal decomposition as part of this segment.

Methods inherited from interface org.opencastproject.metadata.mpeg7.Segment

createTextAnnotation, getIdentifier, getMediaTime, getTextAnnotationCount, hasTextAnnotations, hasTextAnnotations, hasTextAnnotations, hasTextAnnotations, setMediaTime, textAnnotations, textAnnotationsByConfidence, textAnnotationsByRelevance

Methods inherited from interface org.opencastproject.mediapackage.XmlElement

toXml

Method Details

hasSpatioTemporalDecomposition

boolean hasSpatioTemporalDecomposition()

Returns true if there is a spatio temporal decomposition as part of this segment.

Returns:

true if there is a spatio temporal decomposition

createSpatioTemporalDecomposition

SpatioTemporalDecomposition createSpatioTemporalDecomposition(boolean gap,
 boolean overlap)
                                                       throws IllegalStateException

Creates a spatio temporal decomposition in this video segment.

Parameters:

gap - true if there may be gap between the elements

overlap - true if elements may overlap

Returns:

the new decomposition

Throws:

IllegalStateException - if there is already such a decomposition

getSpatioTemporalDecomposition

SpatioTemporalDecomposition getSpatioTemporalDecomposition()

Returns the spatio temporal decomposition that contains information about elements on the segment such as text elements.

Returns:

the spatio temporal decomposition