Package org.opencastproject.timelinepreviews.api

Interface TimelinePreviewsService

All Known Implementing Classes:
TimelinePreviewsServiceImpl, TimelinePreviewsServiceRemote
public interface TimelinePreviewsService
Api for timeline preview generation implementations, that create preview images to be shown on the timeline of a video.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    JOB_TYPE
    Job type

  • Method Summary

    Modifier and Type
    Method
    Description
    Job
    createTimelinePreviewImages(Track track, int imageCount)
    Takes the given track and returns the job that can be used to generate timeline preview images.

  • Field Details

  • Method Details

    • createTimelinePreviewImages

      Job createTimelinePreviewImages(Track track, int imageCount) throws TimelinePreviewsException, MediaPackageException
      Takes the given track and returns the job that can be used to generate timeline preview images.
      Parameters:
      track - track to generate preview images for
      imageCount - number of preview images that will be generated
      Returns:
      the job that can generate the preview images
      Throws:
      TimelinePreviewsException - if the timeline preview images could not be generated
      MediaPackageException - if the track is invalid