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 Summary
Modifier and TypeMethodDescriptionConvert theoriginalVideo
using the givenconversionName
.Returns the available registered video conversions that can be run on a Video document.getProgressStatus
(String repositoryName, String docId, String conversionName) Returns the status of the video conversion with the given conversion name on the given document.getVideoConversion
(String conversionName) default void
Launch all the registered automatic video conversions on the givendoc
.void
launchAutomaticConversions
(DocumentModel doc, boolean onlyMissing) Launch registered automatic video conversions on the givendoc
.void
launchConversion
(DocumentModel doc, String conversionName) Launch an asynchronously video conversion of the givendoc
.
-
Method Details
-
getAvailableVideoConversions
Collection<VideoConversion> getAvailableVideoConversions()Returns the available registered video conversions that can be run on a Video document. -
getAvailableVideoConversionsNames
-
launchConversion
Launch an asynchronously video conversion of the givendoc
.- Parameters:
doc
- the video document to be convertedconversionName
- the video conversion to use
-
launchAutomaticConversions
Launch all the registered automatic video conversions on the givendoc
.- Parameters:
doc
- the video document to be converted
-
launchAutomaticConversions
Launch registered automatic video conversions on the givendoc
.If
onlyMissing
istrue
, 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 convertedonlyMissing
- whether to launch only the missing video conversions- Since:
- 11.5
-
convert
Convert theoriginalVideo
using the givenconversionName
.- Parameters:
originalVideo
- the video to convertconversionName
- the video conversion to use- Returns:
- a
TranscodedVideo
object of the converted video.
-
getProgressStatus
Returns the status of the video conversion with the given conversion name on the given document.- Since:
- 5.7.3
-
getVideoConversion
- Since:
- 7.2
-
getConfiguration
Configuration getConfiguration()- Since:
- 7.4
-