Package org.opencastproject.caption.converters

Class SubRipCaptionConverter

java.lang.Object

org.opencastproject.caption.converters.SubRipCaptionConverter

All Implemented Interfaces:

CaptionConverter

public class SubRipCaptionConverter
extends Object
implements CaptionConverter

Converter engine for SubRip srt caption format. It does not support advanced SubRip format (SubRip format with annotations). Advanced format will be parsed but all annotations will be stripped off.

Constructor Summary

Constructors

Constructor	Description
SubRipCaptionConverter()

Method Summary

Modifier and Type	Method	Description
void	exportCaption(OutputStream outputStream, List<Caption> captions, String language)	Exports caption collection.
MediaPackageElement.Type	getElementType()	Get type of specific caption element (Catalog, Attachment).
String	getExtension()	Get extension of specific caption format.
String[]	getLanguageList(InputStream input)	Reads captions and return information about language if such information is available.
List<Caption>	importCaption(InputStream in, String language)	Imports captions to List.

Methods inherited from class java.lang.Object

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

Constructor Details

SubRipCaptionConverter

public SubRipCaptionConverter()

Method Details

importCaption

public List<Caption> importCaption(InputStream in,
 String language)
                            throws CaptionConverterException

Imports captions to List. If caption format is capable of containing more than one language, language parameter is used to define which captions are parsed. Since srt does not store information about language, language parameter is ignored.

Specified by:

importCaption in interface CaptionConverter

Parameters:

in - stream from where captions are read

language - (optional) captions' language

Returns:

List List of captions

Throws:

CaptionConverterException - if parser encounters an exception

See Also:

• CaptionConverter.importCaption(java.io.InputStream, java.lang.String)

exportCaption

public void exportCaption(OutputStream outputStream,
 List<Caption> captions,
 String language)
                   throws IOException

Exports caption collection. Language parameter is used to set language of the captions for those caption format that are capable of storing information about language. Since srt does not store information about language, language parameter is ignored.

Specified by:

exportCaption in interface CaptionConverter

Parameters:

outputStream - stream to which captions are written

captions - collection to be exported

language - (optional) captions' language

Throws:

IOException - if exception occurs writing to output stream

getLanguageList

public String[] getLanguageList(InputStream input)
                         throws CaptionConverterException

Reads captions and return information about language if such information is available. Returns empty list otherwise. Returns empty list since srt format does not store any information about language.

Specified by:

getLanguageList in interface CaptionConverter

Parameters:

input - stream from where captions are read

Returns:

Array containing languages in captions

Throws:

CaptionConverterException - if parser encounters exception

See Also:

• CaptionConverter.getLanguageList(java.io.InputStream)

getExtension

public String getExtension()

Get extension of specific caption format.

Specified by:

getExtension in interface CaptionConverter

Returns:

caption format extension

See Also:

• CaptionConverter.getExtension()

getElementType

public MediaPackageElement.Type getElementType()

Description copied from interface: CaptionConverter

Get type of specific caption element (Catalog, Attachment).

Specified by:

getElementType in interface CaptionConverter

Returns:

type