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 -
Method Summary
Modifier and TypeMethodDescriptionconvert(MediaPackageElement input, String inputFormat, String outputFormat) Converts captions from one format to another.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
- See Also:
-
-
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 captionsinputFormat- format of imported captionsoutputFormat- format of exported captions- Throws:
UnsupportedCaptionFormatException- if there is no matching engine registered for given input or outputCaptionConverterException- if exception occurs while convertingMediaPackageException- 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 captionsinputFormat- format of imported captionsoutputFormat- format of exported captionslanguage- language of captions- Throws:
UnsupportedCaptionFormatException- if there is no matching engine registered for given input or outputCaptionConverterException- if exception occurs while convertingMediaPackageException- 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 captionsformat- captions' format- Returns:
- Array of languages available in captions
- Throws:
UnsupportedCaptionFormatException- if there is no matching engine registered for given input or outputCaptionConverterException- if parser encounters exception
-