Class ScreenExtractor


  • public class ScreenExtractor
    extends java.lang.Object
    • Method Summary

      Modifier and Type Method Description
      int getNumberOfScreens()  
      void render​(MultimediaObject multimediaObject, int width, int height, int seconds, java.io.File target, int quality)
      Generate a single screenshot from source video.
      void render​(MultimediaObject multimediaObject, int width, int height, int seconds, java.io.File outputDir, java.lang.String fileNamePrefix, java.lang.String extension, int quality)
      Generates screenshots from source video.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ScreenExtractor

        public ScreenExtractor()
        It builds an extractor using a DefaultFFMPEGLocator instance to locate the ffmpeg executable to use.
      • ScreenExtractor

        public ScreenExtractor​(FFMPEGLocator locator)
        It builds an extractor with a custom FFMPEGLocator.
        Parameters:
        locator - The locator picking up the ffmpeg executable used by the extractor.
    • Method Detail

      • getNumberOfScreens

        public int getNumberOfScreens()
        Returns:
        The number of screens found
      • render

        public void render​(MultimediaObject multimediaObject,
                           int width,
                           int height,
                           int seconds,
                           java.io.File outputDir,
                           java.lang.String fileNamePrefix,
                           java.lang.String extension,
                           int quality)
                    throws InputFormatException,
                           EncoderException
        Generates screenshots from source video.
        Parameters:
        multimediaObject - Source MultimediaObject @see MultimediaObject
        width - Output width
        height - Output height
        seconds - Interval in seconds between screens
        outputDir - Destination of output images
        fileNamePrefix - Name all thumbnails will start with
        extension - Image extension for output (jpg, png, etc)
        quality - The range is between 1-31 with 31 being the worst quality
        Throws:
        InputFormatException - If the source multimedia file cannot be decoded.
        EncoderException - If a problems occurs during the encoding process.
      • render

        public void render​(MultimediaObject multimediaObject,
                           int width,
                           int height,
                           int seconds,
                           java.io.File target,
                           int quality)
                    throws EncoderException
        Generate a single screenshot from source video.
        Parameters:
        multimediaObject - Source MultimediaObject @see MultimediaObject
        width - Output width
        height - Output height
        seconds - Interval in seconds between screens
        target - Destination of output image
        quality - The range is between 1-31 with 31 being the worst quality
        Throws:
        InputFormatException - If the source multimedia file cannot be decoded.
        EncoderException - If a problems occurs during the encoding process.