Package org.opencastproject.coverimage

Interface CoverImageService

All Known Implementing Classes:

AbstractCoverImageService, CoverImageServiceOsgiImpl, CoverImageServiceRemoteImpl

public interface CoverImageService

Provides capabilities to generate a cover image

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_TYPE

Method Summary

Modifier and Type	Method	Description
Job	generateCoverImage(String xml, String xsl, String width, String height, String posterImageUri, String targetFlavor)	Creates a job for creating a cover image for movie/media package.

Field Details

JOB_TYPE

static final String JOB_TYPE

See Also:

• Constant Field Values

Method Details

generateCoverImage

Job generateCoverImage(String xml,
 String xsl,
 String width,
 String height,
 String posterImageUri,
 String targetFlavor)
                throws CoverImageException

Creates a job for creating a cover image for movie/media package.

Parameters:

xml - metadata as XML. Will be handed over to the XSL transformation. Optional, if not given, there should be a fallback

xsl - the XSL stylesheet used to create the SVG version of the cover image

width - the width of the resulting image

height - the height of the resulting image

posterImageUri - file URI to an additional poster image (optional)

targetFlavor - target flavor

Returns:

a job instance

Throws:

CoverImageException - if there is an error while creating the job