org.opencastproject.metadata.mpeg7.VideoText 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.awt.Rectangle;
/**
* The VideoText element represents parts of the video with superimposed text. It is a subtype of a moving
* region (mpeg7:MovingRegionType).
*
*
* <complexType name="VideoTextType">
* <complexContent>
* <extension base="mpeg7:MovingRegionType">
* <sequence>
* <element name="Text" type="mpeg7:TextualType" minOccurs="0"/>
* </sequence>
* <attribute name="textType" use="optional">
* <simpleType>
* <union>
* <simpleType>
* <restriction base="NMTOKEN">
* <enumeration value="superimposed"/>
* <enumeration value="scene"/>
* </restriction>
* </simpleType>
* <simpleType>
* <restriction base="mpeg7:termAliasReferenceType"/>
* </simpleType>
* <simpleType>
* <restriction base="mpeg7:termURIReferenceType"/>
* </simpleType>
* </union>
* </simpleType>
* </attribute>
* <attribute name="fontSize" type="positiveInteger" use="optional"/>
* <attribute name="fontType" type="string" use="optional"/>
* </extension>
* </complexContent>
* </complexType>
*
*/
public interface VideoText extends MovingRegion {
/** Video text type */
enum Type {
superimposed, scene
};
/**
* Sets the segment identifier.
*
* @param id
* the identifier
*/
void setIdentifier(String id);
/**
* Returns the segment identifier.
*
* @return the identifier
*/
String getIdentifier();
/**
* Sets the text.
*
* @param text
* the text
*/
void setText(Textual text);
/**
* Returns the text.
*
* @return the text
*/
Textual getText();
/**
* Sets the videotext type.
*
* @param type
* the type
*/
void setType(Type type);
/**
* Rerturns the videotext type.
*
* @return the type
*/
Type getType();
/**
* Sets the optional font type.
*
* @param fontType
* the font type
*/
void setFontType(String fontType);
/**
* Returns the font type.
*
* @return the font type
*/
String getFontType();
/**
* Sets the optional font size.
*
* @param size
* the font size
*/
void setFontSize(int size);
/**
* Returns the font size.
*
* @return the font size
*/
int getFontSize();
/**
* Sets the text's bounding box.
*
* @param rectangle
* the bounding box
*/
void setBoundary(Rectangle rectangle);
/**
* Returns the text's bounding box.
*
* @return the bounding box
*/
Rectangle getBoundary();
}