| Package | Description |
|---|---|
| org.opencastproject.mediapackage | |
| org.opencastproject.mediapackage.attachment | |
| org.opencastproject.mediapackage.elementbuilder | |
| org.opencastproject.mediapackage.selector | |
| org.opencastproject.mediapackage.track | |
| org.opencastproject.serviceregistry.api |
Service implementation classes
|
| org.opencastproject.util |
Utility classes for dealing with media packages, collections, URLs, files, and streams.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
MediaPackageElementSelector<T extends MediaPackageElement>
A
MedikaPackageElementSelector is the way to set up rules for extracting elements from a media package
dependent on their flavor. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
Attachment
This interface describes methods and fields for attachments as part of a media package.
|
interface |
Catalog
General definition for metadata catalogs.
|
interface |
Publication
The presentation element describes where a media package can be consumed.
|
interface |
Track
This interface describes methods and fields for audio and video tracks as part of a media package.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractMediaPackageElement
This class provides base functionality for media package elements.
|
class |
CatalogImpl
This is a basic implementation for handling simple catalogs of metadata.
|
class |
PublicationImpl |
class |
XMLCatalogImpl
This is a basic implementation for handling simple catalogs of metadata.
|
| Modifier and Type | Method and Description |
|---|---|
static <A extends MediaPackageElement> |
MediaPackageSupport.Filters.byType(Class<A> type) |
static <A extends MediaPackageElement> |
MediaPackageElementParser.getAsXml()
|
static <A extends MediaPackageElement> |
MediaPackageSupport.modify(A mpe,
Effect<A> e)
Immutable modification of a media package element.
|
static <A extends MediaPackageElement> |
MediaPackageSupport.Filters.ofType(Class<A> type) |
| Modifier and Type | Method and Description |
|---|---|
MediaPackageElement |
MediaPackageImpl.add(URI url)
Adds an arbitrary
URI to this media package, utilizing a MediaPackageBuilder to create a suitable
media package element out of the url. |
MediaPackageElement |
MediaPackage.add(URI uri)
Adds an arbitrary
URI to this media package, utilizing a MediaPackageBuilder to create a suitable
media package element out of the url. |
MediaPackageElement |
MediaPackageImpl.add(URI uri,
MediaPackageElement.Type type,
MediaPackageElementFlavor flavor) |
MediaPackageElement |
MediaPackage.add(URI uri,
MediaPackageElement.Type type,
MediaPackageElementFlavor flavor)
Adds an arbitrary
URI to this media package, utilizing a MediaPackageBuilder to create a suitable
media package element out of the url. |
static MediaPackageElement |
MediaPackageSupport.copy(MediaPackageElement mpe)
Create a copy of the given media package element.
|
MediaPackageElement |
MediaPackageElementBuilderImpl.elementFromManifest(Node node,
MediaPackageSerializer serializer) |
MediaPackageElement |
MediaPackageElementBuilder.elementFromManifest(Node elementNode,
MediaPackageSerializer serializer)
Creates a media package element from the DOM element.
|
MediaPackageElement |
MediaPackageElementBuilderImpl.elementFromURI(URI uri) |
MediaPackageElement |
MediaPackageElementBuilder.elementFromURI(URI uri)
Creates a media package element from the given file that was previously accepted.
|
MediaPackageElement |
MediaPackageElementBuilderImpl.elementFromURI(URI uri,
MediaPackageElement.Type type,
MediaPackageElementFlavor flavor) |
MediaPackageElement |
MediaPackageElementBuilder.elementFromURI(URI uri,
MediaPackageElement.Type type,
MediaPackageElementFlavor flavor)
Creates a media package element from the given file that was previously accepted, while
type and
flavor may be taken as strong hints and may both be null. |
MediaPackageElement[] |
MediaPackageImpl.getDerived(MediaPackageElement sourceElement,
MediaPackageElementFlavor derivateFlavor)
Returns those media package elements that are derivates of
sourceElement and feature the flavor
derivateFlavor. |
MediaPackageElement[] |
MediaPackage.getDerived(MediaPackageElement sourceElement,
MediaPackageElementFlavor derivateFlavor)
Returns those media package elements that are derivates of
sourceElement and feature the flavor
derivateFlavor. |
MediaPackageElement |
UnsupportedElementException.getElement()
Returns the element.
|
MediaPackageElement |
MediaPackageImpl.getElementById(String id) |
MediaPackageElement |
MediaPackage.getElementById(String id)
Returns the element that is identified by the given identifier or
null if no such element exists. |
MediaPackageElement |
MediaPackageImpl.getElementByReference(MediaPackageReference reference)
Returns the element that is identified by the given reference or
null if no such element exists. |
MediaPackageElement |
MediaPackage.getElementByReference(MediaPackageReference reference)
Returns the element that is identified by the given reference or
null if no such element exists. |
MediaPackageElement[] |
MediaPackageImpl.getElements()
Returns all of the elements.
|
MediaPackageElement[] |
MediaPackage.getElements()
Returns all of the elements.
|
MediaPackageElement[] |
MediaPackageImpl.getElementsByFlavor(MediaPackageElementFlavor flavor)
Returns all elements of this media package with the given flavor.
|
MediaPackageElement[] |
MediaPackage.getElementsByFlavor(MediaPackageElementFlavor flavor)
Returns all elements of this media package with the given flavor.
|
MediaPackageElement[] |
MediaPackageImpl.getElementsByTag(String tag) |
MediaPackageElement[] |
MediaPackage.getElementsByTag(String tag)
Returns the elements that are tagged with the given tag or an empty array if no such elements are found.
|
MediaPackageElement[] |
MediaPackageImpl.getElementsByTags(Collection<String> tags)
Returns the elements that are tagged with any of the given tags or an empty array if no such elements are found.
|
MediaPackageElement[] |
MediaPackage.getElementsByTags(Collection<String> tags)
Returns the elements that are tagged with any of the given tags or an empty array if no such elements are found.
|
static MediaPackageElement |
MediaPackageElementParser.getFromXml(String xml)
Parses the serialized media package element and returns its object representation.
|
MediaPackageElement[] |
MediaPackageImpl.getUnclassifiedElements()
Returns media package elements that are neither, attachments, catalogs nor tracks.
|
MediaPackageElement[] |
MediaPackage.getUnclassifiedElements()
Returns media package elements that are neither, attachments, catalogs nor tracks.
|
MediaPackageElement[] |
MediaPackageImpl.getUnclassifiedElements(MediaPackageElementFlavor flavor)
Returns media package elements that are neither, attachments, catalogs nor tracks but have the given element
flavor.
|
MediaPackageElement[] |
MediaPackage.getUnclassifiedElements(MediaPackageElementFlavor flavor)
Returns media package elements that are neither, attachments, catalogs nor tracks but have the given element
flavor.
|
MediaPackageElement |
MediaPackageElementBuilderImpl.newElement(MediaPackageElement.Type type,
MediaPackageElementFlavor flavor) |
MediaPackageElement |
MediaPackageElementBuilder.newElement(MediaPackageElement.Type type,
MediaPackageElementFlavor flavor)
Creates a new media package elment of the specified type.
|
MediaPackageElement |
MediaPackageImpl.removeElementById(String id)
Removes the element with the given identifier from the mediapackage and returns it.
|
MediaPackageElement |
MediaPackage.removeElementById(String id)
Removes the element with the given identifier from the mediapackage and returns it.
|
| Modifier and Type | Method and Description |
|---|---|
static Function<MediaPackageElement,List<MediaPackageElement>> |
MediaPackageSupport.Filters.byFlavor(MediaPackageElementFlavor flavor) |
static Function<MediaPackageElement,List<MediaPackageElement>> |
MediaPackageSupport.Filters.byFlavor(MediaPackageElementFlavor flavor) |
static Function<MediaPackageElement,List<MediaPackageElement>> |
MediaPackageSupport.Filters.byTags(List<String> tags) |
static Function<MediaPackageElement,List<MediaPackageElement>> |
MediaPackageSupport.Filters.byTags(List<String> tags) |
static <A extends MediaPackageElement> |
MediaPackageSupport.Filters.byType(Class<A> type) |
Iterable<MediaPackageElement> |
MediaPackageImpl.elements()
Returns an iteration of the media package elements.
|
Iterable<MediaPackageElement> |
MediaPackage.elements()
Returns an iteration of the media package elements.
|
static List<? extends MediaPackageElement> |
MediaPackageElementParser.getArrayFromXml(String xml)
Parses the serialized media package element list.
|
static List<? extends MediaPackageElement> |
MediaPackageElementParser.getArrayFromXmlUnchecked(String xml)
Same as getArrayFromXml(), but throwing a RuntimeException instead of a checked exception.
|
static Function<MediaPackageElement,Boolean> |
MediaPackageSupport.Filters.hasTag(String tag) |
static Function<MediaPackageElement,Boolean> |
MediaPackageSupport.Filters.hasTagAny(List<String> tags)
Check if mediapackage element has any of the given tags.
|
static Function<MediaPackageElement,Boolean> |
MediaPackageSupport.Filters.matchesFlavor(MediaPackageElementFlavor flavor)
Return true if the element has a flavor that matches
flavor. |
static Function<MediaPackageElement,Boolean> |
MediaPackageSupport.Filters.ofTags(List<String> tags)
containsTag(java.util.Collection) as a function. |
static <A extends MediaPackageElement> |
MediaPackageSupport.Filters.ofType(Class<A> type) |
static Effect<MediaPackageElement> |
MediaPackageSupport.updateElement(MediaPackage mp)
|
| Modifier and Type | Method and Description |
|---|---|
void |
MediaPackageImpl.add(MediaPackageElement element)
Adds an arbitrary
MediaPackageElement to this media package. |
void |
MediaPackage.add(MediaPackageElement element)
Adds an arbitrary
MediaPackageElement to this media package. |
void |
MediaPackageImpl.addDerived(MediaPackageElement derivedElement,
MediaPackageElement sourceElement)
Adds an element to this media package that represents a derived version of
sourceElement. |
void |
MediaPackage.addDerived(MediaPackageElement derivedElement,
MediaPackageElement sourceElement)
Adds an element to this media package that represents a derived version of
sourceElement. |
void |
MediaPackageImpl.addDerived(MediaPackageElement derivedElement,
MediaPackageElement sourceElement,
Map<String,String> properties)
Adds an element to this media package that represents a derived version of
sourceElement. |
void |
MediaPackage.addDerived(MediaPackageElement derivedElement,
MediaPackageElement sourceElement,
Map<String,String> properties)
Adds an element to this media package that represents a derived version of
sourceElement. |
static void |
PublicationImpl.addElementToPublication(Publication publication,
MediaPackageElement element)
Adds a
MediaPackageElement to this publication by determining its type. |
int |
AbstractMediaPackageElement.compareTo(MediaPackageElement o) |
boolean |
MediaPackageImpl.contains(MediaPackageElement element) |
boolean |
MediaPackage.contains(MediaPackageElement element)
Returns
true if the given element is part of the media package. |
static MediaPackageElement |
MediaPackageSupport.copy(MediaPackageElement mpe)
Create a copy of the given media package element.
|
void |
MediaPackageObserver.elementAdded(MediaPackageElement element)
This method is called if an element is added to the media package.
|
void |
MediaPackageObserver.elementRemoved(MediaPackageElement element)
This method is called if an element is removed from a media package.
|
static String |
MediaPackageElementParser.getAsXml(MediaPackageElement element)
Serializes the media package element to a string.
|
MediaPackageElement[] |
MediaPackageImpl.getDerived(MediaPackageElement sourceElement,
MediaPackageElementFlavor derivateFlavor)
Returns those media package elements that are derivates of
sourceElement and feature the flavor
derivateFlavor. |
MediaPackageElement[] |
MediaPackage.getDerived(MediaPackageElement sourceElement,
MediaPackageElementFlavor derivateFlavor)
Returns those media package elements that are derivates of
sourceElement and feature the flavor
derivateFlavor. |
static com.entwinemedia.fn.data.Opt<String> |
MediaPackageSupport.getFileName(MediaPackageElement mpe)
Extract the file name from a media package elements URI.
|
void |
MediaPackageElement.referTo(MediaPackageElement element)
Adds a reference to the media package element
element. |
void |
AbstractMediaPackageElement.referTo(MediaPackageElement element) |
void |
MediaPackageImpl.remove(MediaPackageElement element)
Removes an arbitrary media package element.
|
void |
MediaPackage.remove(MediaPackageElement element)
Removes an arbitrary media package element.
|
static void |
MediaPackageSupport.updateElement(MediaPackage mp,
MediaPackageElement e)
Update a mediapackage element of a mediapackage.
|
| Modifier and Type | Method and Description |
|---|---|
static String |
MediaPackageElementParser.getArrayAsXml(Collection<? extends MediaPackageElement> elements)
Serializes media package element list to a string.
|
static Effect<MediaPackage> |
MediaPackageSupport.removeElements(List<MediaPackageElement> es) |
static void |
MediaPackageSupport.removeElements(List<MediaPackageElement> es,
MediaPackage mp) |
static void |
MediaPackageSupport.replaceElements(MediaPackage mp,
List<MediaPackageElement> es)
Replaces all elements of
mp with es. |
Collection<T> |
MediaPackageElementSelector.select(List<MediaPackageElement> elements,
boolean withTagsAndFlavors)
Returns the media package elements that are matched by this selector.
|
| Constructor and Description |
|---|
MediaPackageReferenceImpl(MediaPackageElement mediaPackageElement)
Creates a reference to the specified media package element.
|
UnsupportedElementException(MediaPackageElement element,
String message)
Creates a new exception for the given element with the given message.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AttachmentImpl
Basic implementation of an attachment.
|
| Modifier and Type | Method and Description |
|---|---|
MediaPackageElement |
AbstractAttachmentBuilderPlugin.elementFromManifest(Node elementNode,
MediaPackageSerializer serializer) |
MediaPackageElement |
CatalogBuilderPlugin.elementFromManifest(Node elementNode,
MediaPackageSerializer serializer)
Creates a media package element from the DOM element.
|
MediaPackageElement |
TrackBuilderPlugin.elementFromManifest(Node elementNode,
MediaPackageSerializer serializer) |
MediaPackageElement |
MediaPackageElementBuilderPlugin.elementFromManifest(Node elementNode,
MediaPackageSerializer serializer)
Deprecated.
Creates a media package element from the DOM element.
|
MediaPackageElement |
PublicationBuilderPlugin.elementFromManifest(Node elementNode,
MediaPackageSerializer serializer) |
MediaPackageElement |
AbstractAttachmentBuilderPlugin.elementFromURI(URI uri)
Utility method that returns an attachment object from the given url.
|
MediaPackageElement |
CatalogBuilderPlugin.elementFromURI(URI uri) |
MediaPackageElement |
TrackBuilderPlugin.elementFromURI(URI uri) |
MediaPackageElement |
MediaPackageElementBuilderPlugin.elementFromURI(URI uri)
Deprecated.
Creates a media package element from the given url that was previously accepted.
|
MediaPackageElement |
PublicationBuilderPlugin.elementFromURI(URI uri) |
MediaPackageElement |
AbstractAttachmentBuilderPlugin.elementFromURI(URI uri,
MediaPackageElement.Type type,
MediaPackageElementFlavor flavor) |
MediaPackageElement |
AbstractAttachmentBuilderPlugin.newElement(MediaPackageElement.Type type,
MediaPackageElementFlavor flavor) |
MediaPackageElement |
CatalogBuilderPlugin.newElement(MediaPackageElement.Type type,
MediaPackageElementFlavor flavor)
Creates a new media package element of the specified type.
|
MediaPackageElement |
TrackBuilderPlugin.newElement(MediaPackageElement.Type type,
MediaPackageElementFlavor flavor) |
MediaPackageElement |
MediaPackageElementBuilderPlugin.newElement(MediaPackageElement.Type type,
MediaPackageElementFlavor flavor)
Deprecated.
Creates a new media package element of the specified type.
|
MediaPackageElement |
PublicationBuilderPlugin.newElement(MediaPackageElement.Type type,
MediaPackageElementFlavor flavor) |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractMediaPackageElementSelector<T extends MediaPackageElement>
This selector will return any
MediaPackageElements from a MediaPackage that matches the tag
and flavors. |
class |
FlavorPrioritySelector<T extends MediaPackageElement>
This selector will return one or zero
MediaPackageElements from a MediaPackage, following
these rules:
Elements will be returned depending on tags that have been set
If no tags have been specified, all the elements will be taken into account
The result is one or zero elements
The element is selected based on the order of flavors
|
| Modifier and Type | Method and Description |
|---|---|
Collection<T> |
AbstractMediaPackageElementSelector.select(List<MediaPackageElement> elements,
boolean withTagsAndFlavors) |
| Modifier and Type | Class and Description |
|---|---|
class |
TrackImpl
This class is the base implementation for a media track, which itself is part of a media package, representing e.
|
| Modifier and Type | Field and Description |
|---|---|
static Function<org.apache.http.HttpResponse,Option<List<MediaPackageElement>>> |
RemoteBase.elementsFromHttpResponse |
| Modifier and Type | Method and Description |
|---|---|
static Function<Job,MediaPackageElement> |
JobUtil.payloadAsMediaPackageElement(Job waiter,
ServiceRegistry reg)
Interpret the payload of a completed
Job as a MediaPackageElement. |
static Function<Job,MediaPackageElement> |
JobUtil.payloadAsMediaPackageElement(ServiceRegistry reg)
Interpret the payload of a completed
Job as a MediaPackageElement. |
Copyright © 2009–2021 Opencast Project. All rights reserved.