Package org.nuxeo.ecm.platform.video.tools

Interface VideoToolsService

All Known Implementing Classes:

VideoToolsServiceImpl

public interface VideoToolsService

Service that allows the execution of different operations in video blobs through the execution of VideoTool.

Since:

8.4

Method Summary

Modifier and Type	Method	Description
Blob	concat(List<Blob> videos)	Concat the input video blobs into a single video blob.
Blob	extractClosedCaptions(Blob video, String outputFormat, String startAt, String endAt)	Extracts the closed captions from a video blob.
boolean	isToolAvailable(String toolName)	Checks if a determined tool is available.
List<Blob>	slice(Blob video, String startAt, String duration, boolean encode)	Slices a video blob from a start time and the input duration.
Blob	watermark(Blob video, Blob picture, String x, String y)	Add a watermark to a video blob.

Method Detail

extractClosedCaptions

Blob extractClosedCaptions(Blob video,
                           String outputFormat,
                           String startAt,
                           String endAt)

Extracts the closed captions from a video blob.

Parameters:

video - the input blob

outputFormat - the outformat of the captions (srt, txt, ttxt is the default)

startAt - the start time in format "xx:xx"

endAt - the end time in format "xx:xx"

Returns:

the closed captions if any were found

concat

Blob concat(List<Blob> videos)

Concat the input video blobs into a single video blob.

Returns:

video blob with the videos concatenated

slice

List<Blob> slice(Blob video,
                 String startAt,
                 String duration,
                 boolean encode)

Slices a video blob from a start time and the input duration. If start it empty, the blob will be sliced in n-parts with similar duration. If duration is empty, the video blob will be sliced from startAt until the end.

Parameters:

video - the input blob

startAt - the start time in "xx:xx" format

duration - the duration of the sliced blob in seconds

encode - option to re-encode the ouptut video blob

Returns:

video blobs generated by the slicer

watermark

Blob watermark(Blob video,
               Blob picture,
               String x,
               String y)

Add a watermark to a video blob.

Parameters:

video - the input blob

picture - the picture blob to be used as the watermark

x - the x offset starting from the left

y - the y offset starting from the top

Returns:

a video blob with a watermark at the position specified

isToolAvailable

boolean isToolAvailable(String toolName)

Checks if a determined tool is available.

Parameters:

toolName - the name of the tool

Returns:

true if the tool is available or false otherwise