com.netflix.imflibrary.st2067_2

Class CompositionPlaylist

java.lang.Object

com.netflix.imflibrary.st2067_2.CompositionPlaylist

@Immutable
public final class CompositionPlaylist
extends java.lang.Object

This class represents a thin, immutable wrapper around the XML type 'CompositionPlaylistType' which is defined in Section 6.1, st2067-3:2013. A CompositionPlaylist object can be constructed from an XML file only if it satisfies all the constraints specified in st2067-3:2013 and st2067-2:2013

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompositionPlaylist.EditRate This class is an immutable implementation of a rational number described as a ratio of two longs and used to hold non-integer frame rate values
static class	CompositionPlaylist.SequenceTypeEnum This class enumerates various types of Sequence that are valid in CompositionPlaylist document that is compliant with st2067-2:2013.
static class	CompositionPlaylist.VirtualTrack The class is an immutable implementation of the virtual track concept defined in Section 6.9.3 of st2067-3:2013.

Constructor Summary

Constructors

Constructor and Description
CompositionPlaylist(java.io.File compositionPlaylistXMLFile, IMFErrorLogger imfErrorLogger) Constructor for a CompositionPlaylist object from a XML file

Method Summary

Modifier and Type	Method and Description
CompositionPlaylist.EditRate	getEditRate() Getter for the composition edit rate as specified in the CompositionPlaylist XML file
java.util.UUID	getUUID() Getter for the UUID corresponding to this CompositionPlaylist document
java.util.Map<java.util.UUID,CompositionPlaylist.VirtualTrack>	getVirtualTrackMap() Getter for the virtual track map associated with this CompositionPlaylist
java.util.Map<java.util.UUID,java.util.List<org.smpte_ra.schemas.st2067_2_2013.TrackFileResourceType>>	getVirtualTrackResourceList() Getter for the lists of type TrackFileResourceType indexed by the VirtualTrackID.
static void	main(java.lang.String[] args)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CompositionPlaylist

public CompositionPlaylist(java.io.File compositionPlaylistXMLFile,
                           @Nullable
                           IMFErrorLogger imfErrorLogger)
                    throws java.io.IOException,
                           org.xml.sax.SAXException,
                           javax.xml.bind.JAXBException,
                           java.net.URISyntaxException

Constructor for a CompositionPlaylist object from a XML file

Parameters:

compositionPlaylistXMLFile - the input XML file that is conformed to schema and constraints specified in st2067-3:2013 and st2067-2:2013

imfErrorLogger - an error logger for recording any errors - can be null

Throws:

java.io.IOException - - any I/O related error is exposed through an IOException

org.xml.sax.SAXException - - exposes any issues with instantiating a Schema object

javax.xml.bind.JAXBException - - any issues in serializing the XML document using JAXB are exposed through a JAXBException

java.net.URISyntaxException - exposes any issues instantiating a URI object

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getEditRate

public CompositionPlaylist.EditRate getEditRate()

Getter for the composition edit rate as specified in the CompositionPlaylist XML file

Returns:

the edit rate associated with the Composition

getVirtualTrackResourceList

public java.util.Map<java.util.UUID,java.util.List<org.smpte_ra.schemas.st2067_2_2013.TrackFileResourceType>> getVirtualTrackResourceList()

Getter for the lists of type TrackFileResourceType indexed by the VirtualTrackID. The VirtualTrack concept is defined in Section 6.9.3 of st2067-3:2013.

Returns:

Map<UUID,List <TrackFileResourceType>>. The UUID key corresponds to VirtualTrackID

getVirtualTrackMap

public java.util.Map<java.util.UUID,CompositionPlaylist.VirtualTrack> getVirtualTrackMap()

Getter for the virtual track map associated with this CompositionPlaylist

Returns:

Map<UUID,VirtualTrack>. The UUID key corresponds to VirtualTrackID

getUUID

public java.util.UUID getUUID()

Getter for the UUID corresponding to this CompositionPlaylist document

Returns:

the uuid of this CompositionPlaylist object

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception