View Javadoc
1   /*
2    * Licensed to The Apereo Foundation under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional
4    * information regarding copyright ownership.
5    *
6    *
7    * The Apereo Foundation licenses this file to you under the Educational
8    * Community License, Version 2.0 (the "License"); you may not use this file
9    * except in compliance with the License. You may obtain a copy of the License
10   * at:
11   *
12   *   http://opensource.org/licenses/ecl2.txt
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
17   * License for the specific language governing permissions and limitations under
18   * the License.
19   *
20   */
21  
22  package org.opencastproject.metadata.mpeg7;
23  
24  import org.opencastproject.mediapackage.XmlElement;
25  
26  /**
27   * A <code>MovingRegion</code> describes the location, the movement and contents of elements on a video segment:
28   *
29   * <pre>
30   * &lt;complexType name="MovingRegionType"&gt;
31   *   &lt;complexContent&gt;
32   *     &lt;extension base="mpeg7:SegmentType"&gt;
33   *       &lt;sequence&gt;
34   *         &lt;choice minOccurs="0"&gt;
35   *           &lt;element name="SpatioTemporalLocator" type="mpeg7:SpatioTemporalLocatorType"/&gt;
36   *           &lt;element name="SpatioTemporalMask" type="mpeg7:SpatioTemporalMaskType"/&gt;
37   *         &lt;/choice&gt;
38   *         &lt;choice minOccurs="0" maxOccurs="unbounded"&gt;
39   *           &lt;element name="VisualDescriptor" type="mpeg7:VisualDType"/&gt;
40   *           &lt;element name="VisualDescriptionScheme" type="mpeg7:VisualDSType"/&gt;
41   *           &lt;element name="VisualTimeSeriesDescriptor" type="mpeg7:VisualTimeSeriesType"/&gt;
42   *           &lt;element name="GofGopFeature" type="mpeg7:GofGopFeatureType"/&gt;
43   *         &lt;/choice&gt;
44   *         &lt;element name="MultipleView" type="mpeg7:MultipleViewType" minOccurs="0"/&gt;
45   *         &lt;choice minOccurs="0" maxOccurs="unbounded"&gt;
46   *           &lt;element name="SpatialDecomposition" type="mpeg7:MovingRegionSpatialDecompositionType"/&gt;
47   *           &lt;element name="TemporalDecomposition" type="mpeg7:MovingRegionTemporalDecompositionType"/&gt;
48   *           &lt;element name="SpatioTemporalDecomposition"
49   *           type="mpeg7:MovingRegionSpatioTemporalDecompositionType"/&gt;
50   *           &lt;element name="MediaSourceDecomposition" type="mpeg7:MovingRegionMediaSourceDecompositionType"/&gt;
51   *         &lt;/choice&gt;
52   *       &lt;/sequence&gt;
53   *     &lt;/extension&gt;
54   *   &lt;/complexContent&gt;
55   * &lt;/complexType&gt;
56   * </pre>
57   */
58  public interface MovingRegion extends XmlElement {
59  
60    /**
61     * Sets the spatio temporal locator.
62     *
63     * @param locator
64     *          the region locator
65     */
66    void setSpatioTemporalLocator(SpatioTemporalLocator locator);
67  
68    /**
69     * Returns the spatio temporal locator.
70     *
71     * @return the locator
72     */
73    SpatioTemporalLocator getSpatioTemporalLocator();
74  
75  }