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

Class VideoTool

java.lang.Object

org.nuxeo.ecm.platform.video.tools.VideoTool

Direct Known Subclasses:

VideoClosedCaptionsExtractor, VideoConcat, VideoSlicer, VideoWatermarker

public abstract class VideoTool
extends Object

Common interface to setup the video tools.

Since:

8.4

Field Summary

Fields

Modifier and Type	Field	Description
protected String	commandLineName
protected String	name
protected static String	OUTPUT_FILE_PATH_PARAM
protected static String	OUTPUT_MIMETYPE_PARAM
protected static String	SOURCE_FILE_PATH_PARAM
protected static String	VIDEO_TOOLS_DIRECTORY

Constructor Summary

Constructors

Constructor	Description
VideoTool(String name, String commandLineName)

Method Summary

Modifier and Type	Method	Description
BlobHolder	buildResult(String mimeType, Map<String,String> parameters)	Returns a BlobHolder containing the result of the command.
void	cleanupInputs(Map<String,String> parameters)	Removes any temporary input files that were used for command execution.
String	getCommandLineName()
String	getName()
static Blob	getTemporaryBlob(String path, String mimeType)	Gets a temporary blob for the given temporary path.
Map<String,String>	setupParameters(BlobHolder input, Map<String,Object> parameters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected String name

commandLineName

protected String commandLineName

SOURCE_FILE_PATH_PARAM

protected static final String SOURCE_FILE_PATH_PARAM

See Also:

Constant Field Values

OUTPUT_FILE_PATH_PARAM

protected static final String OUTPUT_FILE_PATH_PARAM

See Also:

Constant Field Values

OUTPUT_MIMETYPE_PARAM

protected static final String OUTPUT_MIMETYPE_PARAM

See Also:

Constant Field Values

VIDEO_TOOLS_DIRECTORY

protected static final String VIDEO_TOOLS_DIRECTORY

See Also:

Constant Field Values

Constructor Detail

VideoTool

public VideoTool(String name,
                 String commandLineName)

Method Detail

getName

public String getName()

getCommandLineName

public String getCommandLineName()

setupParameters

public Map<String,String> setupParameters(BlobHolder input,
                                                Map<String,Object> parameters)

cleanupInputs

public void cleanupInputs(Map<String,String> parameters)

Removes any temporary input files that were used for command execution.

buildResult

public BlobHolder buildResult(String mimeType,
                              Map<String,String> parameters)

Returns a BlobHolder containing the result of the command.

Parameters:

mimeType - the MIME type

parameters - the parameters

Returns:

the blob holder

getTemporaryBlob

public static Blob getTemporaryBlob(String path,
                                    String mimeType)

Gets a temporary blob for the given temporary path.

The temporary blob is backed by a temporary file in a new location. The old file is removed.

Parameters:

path - the path to a temporary file

mimeType - the blob MIME type

Returns:

a temporary Blob