Package org.nuxeo.ecm.platform.video.service

Interface VideoService

All Known Implementing Classes:
VideoServiceImpl
public interface VideoService
Service to asynchronously launch and monitor video conversions.

Since:
5.5
Author:
Thomas Roger

  • Method Details

    • getAvailableVideoConversions

      Collection<VideoConversion> getAvailableVideoConversions()
      Returns the available registered video conversions that can be run on a Video document.

    • getAvailableVideoConversionsNames

      List<String> getAvailableVideoConversionsNames()

    • getAutomaticVideoConversionsNames

      List<String> getAutomaticVideoConversionsNames()
      Returns:
      the list of video conversions configured to run automatically
      Since:
      2025.0

    • launchConversion

      void launchConversion(DocumentModel doc, String conversionName)
      Launch an asynchronously video conversion of the given doc.
      Parameters:
      doc - the video document to be converted
      conversionName - the video conversion to use

    • launchAutomaticConversions

      default void launchAutomaticConversions(DocumentModel doc)
      Launch all the registered automatic video conversions on the given doc.
      Parameters:
      doc - the video document to be converted

    • launchAutomaticConversions

      void launchAutomaticConversions(DocumentModel doc, boolean onlyMissing)
      Launch registered automatic video conversions on the given doc.

      If onlyMissing is true, launch only the automatic video conversions that are not on the video document, otherwise launch all the registered automatic video conversions

      Parameters:
      doc - the video document to be converted
      onlyMissing - whether to launch only the missing video conversions
      Since:
      11.5

    • convert

      TranscodedVideo convert(Video originalVideo, String conversionName)
      Convert the originalVideo using the given conversionName.
      Parameters:
      originalVideo - the video to convert
      conversionName - the video conversion to use
      Returns:
      a TranscodedVideo object of the converted video.

    • getProgressStatus

      VideoConversionStatus getProgressStatus(String repositoryName, String docId, String conversionName)
      Returns the status of the video conversion with the given conversion name on the given document.
      Since:
      5.7.3

    • getVideoConversion

      VideoConversion getVideoConversion(String conversionName)
      Since:
      7.2

    • getConfiguration

      Configuration getConfiguration()
      Since:
      7.4