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 Summary

Modifier and Type	Method and Description
TranscodedVideo	convert(VideoConversionId id, Video originalVideo, String conversionName) Deprecated. since 5.7.3, use the API without id
TranscodedVideo	convert(Video originalVideo, String conversionName) Convert the originalVideo using the given conversionName.
Collection<VideoConversion>	getAvailableVideoConversions() Returns the available registered video conversions that can be run on a Video document.
Configuration	getConfiguration()
VideoConversionStatus	getProgressStatus(String repositoryName, String docId, String conversionName) Returns the status of the video conversion with the given conversion name on the given document.
VideoConversionStatus	getProgressStatus(VideoConversionId id) Deprecated. since 5.7.3, use the other API with a document
VideoConversion	getVideoConversion(String conversionName)
void	launchAutomaticConversions(DocumentModel doc) Launch all the registered automatic video conversions on the given doc.
void	launchConversion(DocumentModel doc, String conversionName) Launch an asynchronously video conversion of the given doc.

Method Detail

getAvailableVideoConversions

Collection<VideoConversion> getAvailableVideoConversions()

Returns the available registered video conversions that can be run on a Video document.

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

void launchAutomaticConversions(DocumentModel doc)

Launch all the registered automatic video conversions on the given doc.

Parameters:

doc - the video document to be converted

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.

convert

@Deprecated
TranscodedVideo convert(VideoConversionId id,
                                    Video originalVideo,
                                    String conversionName)

Deprecated. since 5.7.3, use the API without id

Convert the originalVideo using the given conversionName.

Parameters:

id - unique identifier of the video conversion calling this method, used for monitoring.

originalVideo - the video to convert

conversionName - the video conversion to use

Returns:

a TranscodedVideo object for the converted video.

See Also:

convert(Video, String)

getProgressStatus

@Deprecated
VideoConversionStatus getProgressStatus(VideoConversionId id)

Deprecated. since 5.7.3, use the other API with a document

Returns the status of the video conversion identified by the given id.

Parameters:

id - unique identifier of the video conversion

See Also:

getProgressStatus(String, String, String)

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.

Parameters:

repositoryName -

docId -

conversionName -

Returns:

Since:

5.7.3

getVideoConversion

VideoConversion getVideoConversion(String conversionName)

Since:

7.2

getConfiguration

Configuration getConfiguration()

Since:

7.4