org.opencastproject.metadata.mpeg7.Mpeg7 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;
import java.util.Iterator;
/**
* Root of an mpeg-7 document.
*
*
* <element name="Mpeg7">
* <complexType>
* <complexContent>
* <extension base="mpeg7:Mpeg7Type">
* <choice>
* <element name="DescriptionUnit" type="mpeg7:Mpeg7BaseType"/>
* <element name="Description" type="mpeg7:CompleteDescriptionType" minOccurs="1" maxOccurs="unbounded"/>
* </choice>
* </extension>
* </complexContent>
* </complexType>
* </element>
*
*/
public interface Mpeg7 {
/**
* Returns an iteration of the multimedia content container contained in this mpeg-7 document.
*
* @return the multimedia content container
*/
Iterator> multimediaContent();
/**
* Returns the multimedia content container element for tracks of the given type (either Audio,
* Video or Audiovisual).
*
*
* @return the multimedia content container of the specified type
*/
MultimediaContent getMultimediaContent(MultimediaContent.Type type);
/**
* Adds audio content to the catalog.
*
* @param id
* the audio track id
* @param time
* the audio track time constraints
* @param locator
* the track locator
*/
Audio addAudioContent(String id, MediaTime time, MediaLocator locator);
/**
* Removes the audio content with the specified id.
*
* @param id
* the content id
*/
Audio removeAudioContent(String id);
/**
* Returns true if the catalog contains multimedia content of type AudioType.
*
* @return true if audio content is contained
*/
boolean hasAudioContent();
/**
* Returns an iteration of the tracks of type Audio.
*
* @return the audio tracks
*/
Iterator