Index (Opencast :: smil-api 18-SNAPSHOT API)

A C F G I L O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addClip(Smil, String, Track, long, long) - Method in interface org.opencastproject.smil.api.SmilService: Add a SmilMediaElement based on given track and start/duration information.
addClip(Smil, String, Track, long, long, String) - Method in interface org.opencastproject.smil.api.SmilService: Add a SmilMediaElement based on given track and start/duration information.
addClips(Smil, String, Track[], long, long) - Method in interface org.opencastproject.smil.api.SmilService: Add a list of SmilMediaElements based on given tracks and start/duration information.
addMeta(Smil, String, String) - Method in interface org.opencastproject.smil.api.SmilService: Add a meta element to Smil head.
addParallel(Smil) - Method in interface org.opencastproject.smil.api.SmilService: Add new par element to Smil.
addParallel(Smil, String) - Method in interface org.opencastproject.smil.api.SmilService: Add new par element to Smil inside an element with given Id.
addSequence(Smil) - Method in interface org.opencastproject.smil.api.SmilService: Add new seq element to Smil.
addSequence(Smil, String) - Method in interface org.opencastproject.smil.api.SmilService: Add new seq element to Smil inside an element with given Id.
addTrack(Document, SmilUtil.TrackType, boolean, long, long, URI, String) - Static method in class org.opencastproject.smil.api.util.SmilUtil: Adds a track to the SMIL document.
AUDIO - Enum constant in enum class org.opencastproject.smil.entity.media.element.api.SmilMediaElement.MediaType

C

createNewSmil() - Method in interface org.opencastproject.smil.api.SmilService: Create a new Smil.
createNewSmil(MediaPackage) - Method in interface org.opencastproject.smil.api.SmilService: Create a new Smil and store the MediaPackage Id as meta data.
createSmil() - Static method in class org.opencastproject.smil.api.util.SmilUtil: Creates a skeleton SMIL document

F

fromXml(File) - Method in interface org.opencastproject.smil.api.SmilService: Returns Smil from Xml File.
fromXml(String) - Method in interface org.opencastproject.smil.api.SmilService: Returns Smil from Xml String.

G

get(String) - Method in interface org.opencastproject.smil.entity.api.Smil: Returns element with given Id.
getBody() - Method in interface org.opencastproject.smil.entity.api.Smil: Returns body of the SMIL.
getClipBegin() - Method in interface org.opencastproject.smil.entity.media.element.api.SmilMediaElement: Returns clip start position.
getClipBeginMS() - Method in interface org.opencastproject.smil.entity.media.element.api.SmilMediaElement: Returns clip start position in milliseconds.
getClipEnd() - Method in interface org.opencastproject.smil.entity.media.element.api.SmilMediaElement: Returns clip end position.
getClipEndMS() - Method in interface org.opencastproject.smil.entity.media.element.api.SmilMediaElement: Returns clip end position in milliseconds.
getContainerType() - Method in interface org.opencastproject.smil.entity.media.container.api.SmilMediaContainer: Returns the type of the container.
getContent() - Method in interface org.opencastproject.smil.entity.api.SmilMeta: Returns meta content.
getElements() - Method in interface org.opencastproject.smil.entity.media.container.api.SmilMediaContainer: Returns media elements or containers inside as List of SmilMediaObjects.
getEntities() - Method in interface org.opencastproject.smil.api.SmilResponse: Returns SmilObjects if there are any or throws SmilException.
getEntitiesCount() - Method in interface org.opencastproject.smil.api.SmilResponse: Returns number of entities defined with this response.
getEntity() - Method in interface org.opencastproject.smil.api.SmilResponse: Returns SmilObject if only one entity stored.
getHead() - Method in interface org.opencastproject.smil.entity.api.Smil: Returns head of the SMIL.
getId() - Method in interface org.opencastproject.smil.entity.api.SmilObject: Returns the Id of the Smil element.
getMediaElements() - Method in interface org.opencastproject.smil.entity.api.SmilBody: Returns the SMIL elements inside the body.
getMediaType() - Method in interface org.opencastproject.smil.entity.media.element.api.SmilMediaElement: Returns media element type.
getMetas() - Method in interface org.opencastproject.smil.entity.api.SmilHead: Returns List of meta elements inside.
getName() - Method in interface org.opencastproject.smil.entity.api.SmilMeta: Returns meta name.
getName() - Method in interface org.opencastproject.smil.entity.media.param.api.SmilMediaParam: Returns param name.
getParamGroup() - Method in interface org.opencastproject.smil.entity.media.element.api.SmilMediaElement: Returns SmilMediaParamGroup Id given with this element.
getParamGroups() - Method in interface org.opencastproject.smil.entity.api.SmilHead: Returns List of paramGroup elements.
getParams() - Method in interface org.opencastproject.smil.entity.media.element.api.SmilMediaElement: Returns SmilMediaParams for this media element.
getParams() - Method in interface org.opencastproject.smil.entity.media.param.api.SmilMediaParamGroup: Returns List of SmilMediaParam elements inside.
getSmil() - Method in interface org.opencastproject.smil.api.SmilResponse: Returns Smil object from response.
getSmilDocumentFromMediaPackage(MediaPackage, MediaPackageElementFlavor, Workspace) - Static method in class org.opencastproject.smil.api.util.SmilUtil
getSrc() - Method in interface org.opencastproject.smil.entity.media.element.api.SmilMediaElement: Returns media source URI.
getValue() - Method in interface org.opencastproject.smil.entity.media.param.api.SmilMediaParam: Returns param value.

I

IMAGE - Enum constant in enum class org.opencastproject.smil.entity.media.element.api.SmilMediaElement.MediaType
isContainer() - Method in interface org.opencastproject.smil.entity.media.api.SmilMediaObject: Returns true if this element is an container for other media elements.
isParentOf(String) - Method in interface org.opencastproject.smil.entity.media.container.api.SmilMediaContainer: Returns true, if has a child element with same Id.

L

loadSmilDocument(InputStream, MediaPackageElement) - Static method in class org.opencastproject.smil.api.util.SmilUtil: Load the SMIL document identified by mpe.

O

org.opencastproject.smil.api - package org.opencastproject.smil.api
org.opencastproject.smil.api.util - package org.opencastproject.smil.api.util
org.opencastproject.smil.entity.api - package org.opencastproject.smil.entity.api
org.opencastproject.smil.entity.media.api - package org.opencastproject.smil.entity.media.api
org.opencastproject.smil.entity.media.container.api - package org.opencastproject.smil.entity.media.container.api
org.opencastproject.smil.entity.media.element.api - package org.opencastproject.smil.entity.media.element.api
org.opencastproject.smil.entity.media.param.api - package org.opencastproject.smil.entity.media.param.api

P

PAR - Enum constant in enum class org.opencastproject.smil.entity.media.container.api.SmilMediaContainer.ContainerType
PARAM_NAME_TRACK - Static variable in interface org.opencastproject.smil.entity.media.param.api.SmilMediaParam
PARAM_NAME_TRACK_FLAVOR - Static variable in interface org.opencastproject.smil.entity.media.param.api.SmilMediaParam
PARAM_NAME_TRACK_ID - Static variable in interface org.opencastproject.smil.entity.media.param.api.SmilMediaParam
PARAM_NAME_TRACK_SRC - Static variable in interface org.opencastproject.smil.entity.media.param.api.SmilMediaParam
PRESENTATION - Enum constant in enum class org.opencastproject.smil.api.util.SmilUtil.TrackType
PRESENTER - Enum constant in enum class org.opencastproject.smil.api.util.SmilUtil.TrackType

R

REF - Enum constant in enum class org.opencastproject.smil.entity.media.element.api.SmilMediaElement.MediaType
removeSmilElement(Smil, String) - Method in interface org.opencastproject.smil.api.SmilService: Remove element (identified by elementId) from Smil if exists.

S

SEQ - Enum constant in enum class org.opencastproject.smil.entity.media.container.api.SmilMediaContainer.ContainerType
Smil - Interface in org.opencastproject.smil.entity.api: Represent a SMIL document.
SMIL_META_NAME_CATALOG_ID - Static variable in interface org.opencastproject.smil.entity.api.SmilMeta
SMIL_META_NAME_MEDIA_PACKAGE_ID - Static variable in interface org.opencastproject.smil.entity.api.SmilMeta
SMIL_META_NAME_TRACK_DURATION - Static variable in interface org.opencastproject.smil.entity.api.SmilMeta
SMIL_META_NAME_TRACK_ID - Static variable in interface org.opencastproject.smil.entity.api.SmilMeta
SMIL_META_NAME_WORKFLOW_ID - Static variable in interface org.opencastproject.smil.entity.api.SmilMeta
SMIL_NODE_NAME - Static variable in class org.opencastproject.smil.api.util.SmilUtil
SMIL_NS_URI - Static variable in class org.opencastproject.smil.api.util.SmilUtil
SmilBody - Interface in org.opencastproject.smil.entity.api: Represent a SMIL body element.
SmilException - Exception Class in org.opencastproject.smil.api: Will be thrown, if editing Smil fail.
SmilException(String) - Constructor for exception class org.opencastproject.smil.api.SmilException
SmilException(String, Throwable) - Constructor for exception class org.opencastproject.smil.api.SmilException
SmilHead - Interface in org.opencastproject.smil.entity.api: Represent a SMIL head element.
SmilMediaContainer - Interface in org.opencastproject.smil.entity.media.container.api: Represent a media container like par, seq,...
SmilMediaContainer.ContainerType - Enum Class in org.opencastproject.smil.entity.media.container.api: SMIL media container type.
SmilMediaElement - Interface in org.opencastproject.smil.entity.media.element.api: Represent a media element like audio, video,...
SmilMediaElement.MediaType - Enum Class in org.opencastproject.smil.entity.media.element.api: SMIL media element type.
SmilMediaObject - Interface in org.opencastproject.smil.entity.media.api: Represent Smil media elements and containers.
SmilMediaParam - Interface in org.opencastproject.smil.entity.media.param.api: Represent SMIL param element (inside media elements).
SmilMediaParamGroup - Interface in org.opencastproject.smil.entity.media.param.api: Represent SMIL paramGroup element with params inside.
SmilMeta - Interface in org.opencastproject.smil.entity.api: Represent a SMIL meta element.
SmilObject - Interface in org.opencastproject.smil.entity.api: All Smil objects should extend this interface.
SmilResponse - Interface in org.opencastproject.smil.api: SmilService response container for Smil and SmilObjects as entities.
SmilService - Interface in org.opencastproject.smil.api: SmilService provides Smil manipulation.
SmilUtil - Class in org.opencastproject.smil.api.util: General purpose utility functions for dealing with SMIL.
SmilUtil.TrackType - Enum Class in org.opencastproject.smil.api.util

T

toXml() - Method in interface org.opencastproject.smil.api.SmilResponse: Return XML serialized instance of this SmilResponse.
toXML() - Method in interface org.opencastproject.smil.entity.api.Smil: Serialize this object.

V

valueOf(String) - Static method in enum class org.opencastproject.smil.api.util.SmilUtil.TrackType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.opencastproject.smil.entity.media.container.api.SmilMediaContainer.ContainerType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.opencastproject.smil.entity.media.element.api.SmilMediaElement.MediaType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.opencastproject.smil.api.util.SmilUtil.TrackType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.opencastproject.smil.entity.media.container.api.SmilMediaContainer.ContainerType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.opencastproject.smil.entity.media.element.api.SmilMediaElement.MediaType: Returns an array containing the constants of this enum class, in the order they are declared.
VIDEO - Enum constant in enum class org.opencastproject.smil.entity.media.element.api.SmilMediaElement.MediaType

A C F G I L O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form