org.opencastproject.metadata.mpeg7.VideoSegment Maven / Gradle / Ivy
/*
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
*
* The Apereo Foundation licenses this file to you under the Educational
* Community License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of the License
* at:
*
* http://opensource.org/licenses/ecl2.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*
*/
package org.opencastproject.metadata.mpeg7;
/**
* A video segment represents a temporal decomposition of the video stream that may have properties like text
* annotations attached to it.
*
*
* <complexType name="VideoSegmentType">
* <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="VisualDescriptor" type="mpeg7:VisualDType"/>
* <element name="VisualDescriptionScheme" type="mpeg7:VisualDSType"/>
* <element name="VisualTimeSeriesDescriptor" type="mpeg7:VisualTimeSeriesType"/>
* </choice>
* <element name="MultipleView" type="mpeg7:MultipleViewType" minOccurs="0"/>
* <element name="Mosaic" type="mpeg7:MosaicType" minOccurs="0" maxOccurs="unbounded"/>
* <choice minOccurs="0" maxOccurs="unbounded">
* <element name="SpatialDecomposition" type="mpeg7:VideoSegmentSpatialDecompositionType"/>
* <element name="TemporalDecomposition" type="mpeg7:VideoSegmentTemporalDecompositionType"/>
* <element name="SpatioTemporalDecomposition" type="mpeg7:VideoSegmentSpatioTemporalDecompositionType"/>
* <element name="MediaSourceDecomposition" type="mpeg7:VideoSegmentMediaSourceDecompositionType"/>
* </choice>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*/
public interface VideoSegment extends Segment {
/**
* Returns true if there is a spatio temporal decomposition as part of this segment.
*
* @return true if there is a spatio temporal decomposition
*/
boolean hasSpatioTemporalDecomposition();
/**
* Creates a spatio temporal decomposition in this video segment.
*
* @param gap
* true if there may be gap between the elements
* @param overlap
* true if elements may overlap
* @return the new decomposition
* @throws IllegalStateException
* if there is already such a decomposition
*/
SpatioTemporalDecomposition createSpatioTemporalDecomposition(boolean gap, boolean overlap)
throws IllegalStateException;
/**
* Returns the spatio temporal decomposition that contains information about elements on the segment such as text
* elements.
*
* @return the spatio temporal decomposition
*/
SpatioTemporalDecomposition getSpatioTemporalDecomposition();
}