org.opencastproject.mediapackage.track

Class TrackImpl

java.lang.Object

org.opencastproject.mediapackage.AbstractMediaPackageElement

org.opencastproject.mediapackage.track.TrackImpl

All Implemented Interfaces:

Serializable, Cloneable, Comparable<MediaPackageElement>, ManifestContributor, MediaPackageElement, Track

public class TrackImpl
extends AbstractMediaPackageElement
implements Track

This class is the base implementation for a media track, which itself is part of a media package, representing e. g. the speaker video or the slide presentation movie.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrackImpl.Adapter
static class	TrackImpl.StreamingProtocol

Nested classes/interfaces inherited from interface org.opencastproject.mediapackage.MediaPackageElement

MediaPackageElement.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AudioStream>	audio
protected Long	duration The duration in milliseconds
protected boolean	live
protected TrackImpl.StreamingProtocol	transport
protected List<VideoStream>	video

Fields inherited from class org.opencastproject.mediapackage.AbstractMediaPackageElement

checksum, description, elementType, flavor, id, mediaPackage, mimeType, reference, size, tags, uri

Fields inherited from interface org.opencastproject.mediapackage.Track

TYPE

Constructor Summary

Constructors

Constructor and Description
TrackImpl() Needed by JAXB

Method Summary

Modifier and Type	Method and Description
void	addStream(AbstractStreamImpl stream) Add a stream to the track.
static TrackImpl	fromURI(URI uri) Creates a new track from the given url.
List<AudioStream>	getAudio()
String	getDescription() This implementation returns the track's mime type.
Long	getDuration() Returns the track duration in milliseconds or null if the duration is not available.
Stream[]	getStreams() Return the streams that make up the track.
TrackImpl.StreamingProtocol	getTransport()
List<VideoStream>	getVideo()
boolean	hasAudio() Returns true if the track features an audio stream.
boolean	hasVideo() Returns true if the track features a video stream.
boolean	isLive() Returns true if the track is a live track.
void	setAudio(List<AudioStream> audio)
void	setDuration(Long duration) Sets the track's duration in milliseconds.
void	setLive(boolean isLive)
void	setTransport(TrackImpl.StreamingProtocol transport)
void	setVideo(List<VideoStream> video)
Node	toManifest(Document document, MediaPackageSerializer serializer) This method returns an XML serialization of the object to be stored in the media package manifest.

Methods inherited from class org.opencastproject.mediapackage.AbstractMediaPackageElement

addTag, clearReference, clearTags, clone, compareTo, containsTag, containsTag, equals, getChecksum, getElementDescription, getElementType, getFlavor, getIdentifier, getMediaPackage, getMimeType, getReference, getSize, getTags, getURI, hashCode, referTo, referTo, referTo, removeTag, setChecksum, setElementDescription, setFlavor, setIdentifier, setMimeType, setReference, setSize, setURI, toString, verify

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opencastproject.mediapackage.MediaPackageElement

addTag, clearReference, clearTags, clone, containsTag, containsTag, getChecksum, getElementDescription, getElementType, getFlavor, getIdentifier, getMediaPackage, getMimeType, getReference, getSize, getTags, getURI, referTo, referTo, referTo, removeTag, setChecksum, setElementDescription, setFlavor, setIdentifier, setMimeType, setReference, setSize, setURI, verify

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

duration

protected Long duration

The duration in milliseconds

audio

protected List<AudioStream> audio

video

protected List<VideoStream> video

transport

protected TrackImpl.StreamingProtocol transport

live

protected boolean live

Constructor Detail

TrackImpl

public TrackImpl()

Needed by JAXB

Method Detail

fromURI

public static TrackImpl fromURI(URI uri)

Creates a new track from the given url.

Parameters:

uri - the track location

Returns:

the track

setDuration

public void setDuration(Long duration)

Sets the track's duration in milliseconds.

Parameters:

duration - the duration

getDuration

public Long getDuration()

Description copied from interface: Track

Returns the track duration in milliseconds or null if the duration is not available.

Specified by:

getDuration in interface Track

Returns:

the track duration

See Also:

Track.getDuration()

getStreams

public Stream[] getStreams()

Description copied from interface: Track

Return the streams that make up the track. Tracks consist of at least one stream.

Specified by:

getStreams in interface Track

addStream

public void addStream(AbstractStreamImpl stream)

Add a stream to the track.

hasAudio

public boolean hasAudio()

Returns true if the track features an audio stream.

Specified by:

hasAudio in interface Track

Returns:

true if the track has an audio stream

See Also:

Track.hasAudio()

hasVideo

public boolean hasVideo()

Returns true if the track features a video stream.

Specified by:

hasVideo in interface Track

Returns:

true if the track has a video stream

See Also:

Track.hasVideo()

getAudio

public List<AudioStream> getAudio()

setAudio

public void setAudio(List<AudioStream> audio)

getVideo

public List<VideoStream> getVideo()

setVideo

public void setVideo(List<VideoStream> video)

setLive

public void setLive(boolean isLive)

isLive

public boolean isLive()

Description copied from interface: Track

Returns true if the track is a live track.

Specified by:

isLive in interface Track

Returns:

true if live track; false otherwise

See Also:

Track.isLive()

toManifest

public Node toManifest(Document document,
                       MediaPackageSerializer serializer)
                throws MediaPackageException

Description copied from interface: ManifestContributor

This method returns an XML serialization of the object to be stored in the media package manifest. It should be possible to reconstruct the object from this data.

For creating MediaPackageElements from a manifest, please use MediaPackageElementBuilder.elementFromManifest(org.w3c.dom.Node, MediaPackageSerializer). All other objects shall provide their own implementation specific reconstruction mechanism.

Specified by:

toManifest in interface ManifestContributor

Overrides:

toManifest in class AbstractMediaPackageElement

Parameters:

document - the parent

serializer - the media package serializer

Returns:

the object's xml representation

Throws:

MediaPackageException - if the mediapackage can't be serialized

See Also:

AbstractMediaPackageElement.toManifest(org.w3c.dom.Document, MediaPackageSerializer)

getDescription

public String getDescription()

This implementation returns the track's mime type.

Specified by:

getDescription in interface Track

Returns:

the track description.

See Also:

Track.getDescription()

setTransport

public void setTransport(TrackImpl.StreamingProtocol transport)

getTransport

public TrackImpl.StreamingProtocol getTransport()