com.netflix.imflibrary.writerTools.utils

Class IMFUtils

java.lang.Object

com.netflix.imflibrary.writerTools.utils.IMFUtils

public class IMFUtils
extends java.lang.Object

A class that provides utility methods to help with serializing an IMF CPL to an XML document

Method Summary

Modifier and Type	Method and Description
static javax.xml.datatype.XMLGregorianCalendar	createXMLGregorianCalendar() A utility method to create an XMLGregorianCalendar
static byte[]	generateHashAndBase64Encode(java.io.File file) A method that generates a SHA-256 hash of the file and Base64 encode the result.
static java.lang.String	generateTimecodeStartAddress() A method that generates a CPL schema valid TimecodeStartAddress string
static <T extends org.smpte_ra.schemas.st2067_2_2013.BaseResourceType> T	safeCast(org.smpte_ra.schemas.st2067_2_2013.BaseResourceType baseResourceType, java.lang.Class<T> cls) A method to cast the object that was passed in to the specified subclass safely
static void	writeCPLToFile(org.smpte_ra.schemas.st2067_2_2013.CompositionPlaylistType compositionPlaylistType, java.io.File outputFile) A utility method that writes out the serialized IMF CPL document to a file

Methods inherited from class java.lang.Object

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

Method Detail

createXMLGregorianCalendar

@Nullable
public static javax.xml.datatype.XMLGregorianCalendar createXMLGregorianCalendar()

A utility method to create an XMLGregorianCalendar

Returns:

the constructed XMLGregorianCalendar

generateTimecodeStartAddress

public static java.lang.String generateTimecodeStartAddress()

A method that generates a CPL schema valid TimecodeStartAddress string

Returns:

a string representing the time code start address compliant with its regex definition

generateHashAndBase64Encode

public static byte[] generateHashAndBase64Encode(java.io.File file)
                                          throws java.io.IOException

A method that generates a SHA-256 hash of the file and Base64 encode the result.

Parameters:

file - - the file whose SHA-256 hash is to be generated

Returns:

a byte[] representing the generated base64 encoded hash of the file

Throws:

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

safeCast

public static <T extends org.smpte_ra.schemas.st2067_2_2013.BaseResourceType> T safeCast(org.smpte_ra.schemas.st2067_2_2013.BaseResourceType baseResourceType,
                                                                                         java.lang.Class<T> cls)
                                                                                  throws IMFException

A method to cast the object that was passed in to the specified subclass safely

Type Parameters:

T - the type of BaseResource

Parameters:

baseResourceType - - the object that needs to cast to the subclass of this type

cls - the Class for the casted type

Returns:

T casted type

Throws:

IMFException - - a class cast failure is exposed through an IMFException

writeCPLToFile

public static void writeCPLToFile(org.smpte_ra.schemas.st2067_2_2013.CompositionPlaylistType compositionPlaylistType,
                                  java.io.File outputFile)
                           throws java.io.IOException

A utility method that writes out the serialized IMF CPL document to a file

Parameters:

compositionPlaylistType - an instance of the composition playlist type

outputFile - the file that the serialized XML is written to

Throws:

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