Package org.opencastproject.caption.api

Interface CaptionService

All Known Implementing Classes:

CaptionServiceImpl, CaptionServiceRemoteImpl

public interface CaptionService

Provides captioning support. This service makes use of CaptionConverter instances that need to be registered in the OSGi registry.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_TYPE

Method Summary

Modifier and Type	Method	Description
Job	convert(MediaPackageElement input, String inputFormat, String outputFormat)	Converts captions from one format to another.
Job	convert(MediaPackageElement input, String inputFormat, String outputFormat, String language)	Converts captions from one format to another.
String[]	getLanguageList(MediaPackageElement input, String format)	Returns list of languages available in captions (if such information is stored).

Field Details

JOB_TYPE

static final String JOB_TYPE

See Also:

• Constant Field Values

Method Details

convert

Job convert(MediaPackageElement input,
 String inputFormat,
 String outputFormat)
     throws UnsupportedCaptionFormatException,
CaptionConverterException,
MediaPackageException

Converts captions from one format to another. Language parameter is used for those formats that store information about language.

Parameters:

input - MediaPackageElement containing captions

inputFormat - format of imported captions

outputFormat - format of exported captions

Throws:

UnsupportedCaptionFormatException - if there is no matching engine registered for given input or output

CaptionConverterException - if exception occurs while converting

MediaPackageException - if the catalog is invalid

convert

Job convert(MediaPackageElement input,
 String inputFormat,
 String outputFormat,
 String language)
     throws UnsupportedCaptionFormatException,
CaptionConverterException,
MediaPackageException

Converts captions from one format to another. Language parameter is used for those formats that store information about language.

Parameters:

input - MediaPackageElement containing captions

inputFormat - format of imported captions

outputFormat - format of exported captions

language - language of captions

Throws:

UnsupportedCaptionFormatException - if there is no matching engine registered for given input or output

CaptionConverterException - if exception occurs while converting

MediaPackageException - if the catalog is invalid

getLanguageList

String[] getLanguageList(MediaPackageElement input,
 String format)
                  throws UnsupportedCaptionFormatException,
CaptionConverterException

Returns list of languages available in captions (if such information is stored).

Parameters:

input - Catalog containing captions

format - captions' format

Returns:

Array of languages available in captions

Throws:

UnsupportedCaptionFormatException - if there is no matching engine registered for given input or output

CaptionConverterException - if parser encounters exception