Package com.arthenica.ffmpegkit

Class FFmpegKit

java.lang.Object

com.arthenica.ffmpegkit.FFmpegKit

public class FFmpegKit
extends java.lang.Object

Main class to run FFmpeg commands. Supports executing commands both synchronously and asynchronously.

 FFmpegSession session = FFmpegKit.execute("-i file1.mp4 -c:v libxvid file1.avi");

 FFmpegSession asyncSession = FFmpegKit.executeAsync("-i file1.mp4 -c:v libxvid file1.avi", completeCallback);
 

Provides overloaded execute methods to define session specific callbacks.

 FFmpegSession asyncSession = FFmpegKit.executeAsync("-i file1.mp4 -c:v libxvid file1.avi", completeCallback, logCallback, statisticsCallback);
 

Method Summary

Modifier and Type	Method	Description
static void	cancel()	Cancels all running sessions.
static void	cancel(long sessionId)	Cancels the session specified with sessionId.
static FFmpegSession	execute(java.lang.String command)	Synchronously executes FFmpeg command provided.
static FFmpegSession	executeAsync(java.lang.String command, FFmpegSessionCompleteCallback completeCallback)	Starts an asynchronous FFmpeg execution for the given command.
static FFmpegSession	executeAsync(java.lang.String command, FFmpegSessionCompleteCallback completeCallback, LogCallback logCallback, StatisticsCallback statisticsCallback)	Starts an asynchronous FFmpeg execution for the given command.
static FFmpegSession	executeAsync(java.lang.String command, FFmpegSessionCompleteCallback completeCallback, LogCallback logCallback, StatisticsCallback statisticsCallback, java.util.concurrent.ExecutorService executorService)	Starts an asynchronous FFmpeg execution for the given command.
static FFmpegSession	executeAsync(java.lang.String command, FFmpegSessionCompleteCallback completeCallback, java.util.concurrent.ExecutorService executorService)	Starts an asynchronous FFmpeg execution for the given command.
static FFmpegSession	executeWithArguments(java.lang.String[] arguments)	Synchronously executes FFmpeg with arguments provided.
static FFmpegSession	executeWithArgumentsAsync(java.lang.String[] arguments, FFmpegSessionCompleteCallback completeCallback)	Starts an asynchronous FFmpeg execution with arguments provided.
static FFmpegSession	executeWithArgumentsAsync(java.lang.String[] arguments, FFmpegSessionCompleteCallback completeCallback, LogCallback logCallback, StatisticsCallback statisticsCallback)	Starts an asynchronous FFmpeg execution with arguments provided.
static FFmpegSession	executeWithArgumentsAsync(java.lang.String[] arguments, FFmpegSessionCompleteCallback completeCallback, LogCallback logCallback, StatisticsCallback statisticsCallback, java.util.concurrent.ExecutorService executorService)	Starts an asynchronous FFmpeg execution with arguments provided.
static FFmpegSession	executeWithArgumentsAsync(java.lang.String[] arguments, FFmpegSessionCompleteCallback completeCallback, java.util.concurrent.ExecutorService executorService)	Starts an asynchronous FFmpeg execution with arguments provided.
static java.util.List<FFmpegSession>	listSessions()	Lists all FFmpeg sessions in the session history.

Methods inherited from class java.lang.Object

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

Method Detail

executeWithArguments

public static FFmpegSession executeWithArguments(java.lang.String[] arguments)

Synchronously executes FFmpeg with arguments provided.

Parameters:

arguments - FFmpeg command options/arguments as string array

Returns:

FFmpeg session created for this execution

executeWithArgumentsAsync

public static FFmpegSession executeWithArgumentsAsync(java.lang.String[] arguments,
                                                      FFmpegSessionCompleteCallback completeCallback)

Starts an asynchronous FFmpeg execution with arguments provided.

Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback if you want to be notified about the result.

Parameters:

arguments - FFmpeg command options/arguments as string array

completeCallback - callback that will be called when the execution has completed

Returns:

FFmpeg session created for this execution

executeWithArgumentsAsync

public static FFmpegSession executeWithArgumentsAsync(java.lang.String[] arguments,
                                                      FFmpegSessionCompleteCallback completeCallback,
                                                      LogCallback logCallback,
                                                      StatisticsCallback statisticsCallback)

Starts an asynchronous FFmpeg execution with arguments provided.

Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback if you want to be notified about the result.

Parameters:

arguments - FFmpeg command options/arguments as string array

completeCallback - callback that will be called when the execution has completed

logCallback - callback that will receive logs

statisticsCallback - callback that will receive statistics

Returns:

FFmpeg session created for this execution

executeWithArgumentsAsync

public static FFmpegSession executeWithArgumentsAsync(java.lang.String[] arguments,
                                                      FFmpegSessionCompleteCallback completeCallback,
                                                      java.util.concurrent.ExecutorService executorService)

Starts an asynchronous FFmpeg execution with arguments provided.

Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback if you want to be notified about the result.

Parameters:

arguments - FFmpeg command options/arguments as string array

completeCallback - callback that will be called when the execution has completed

executorService - executor service that will be used to run this asynchronous operation

Returns:

FFmpeg session created for this execution

executeWithArgumentsAsync

public static FFmpegSession executeWithArgumentsAsync(java.lang.String[] arguments,
                                                      FFmpegSessionCompleteCallback completeCallback,
                                                      LogCallback logCallback,
                                                      StatisticsCallback statisticsCallback,
                                                      java.util.concurrent.ExecutorService executorService)

Starts an asynchronous FFmpeg execution with arguments provided.

Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback if you want to be notified about the result.

Parameters:

arguments - FFmpeg command options/arguments as string array

completeCallback - callback that will be called when the execution has completed

logCallback - callback that will receive logs

statisticsCallback - callback that will receive statistics

executorService - executor service that will be used to run this asynchronous operation

Returns:

FFmpeg session created for this execution

execute

public static FFmpegSession execute(java.lang.String command)

Synchronously executes FFmpeg command provided. Space character is used to split command into arguments. You can use single or double quote characters to specify arguments inside your command.

Parameters:

command - FFmpeg command

Returns:

FFmpeg session created for this execution

executeAsync

public static FFmpegSession executeAsync(java.lang.String command,
                                         FFmpegSessionCompleteCallback completeCallback)

Starts an asynchronous FFmpeg execution for the given command. Space character is used to split the command into arguments. You can use single or double quote characters to specify arguments inside your command.

Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback if you want to be notified about the result.

Parameters:

command - FFmpeg command

completeCallback - callback that will be called when the execution has completed

Returns:

FFmpeg session created for this execution

executeAsync

public static FFmpegSession executeAsync(java.lang.String command,
                                         FFmpegSessionCompleteCallback completeCallback,
                                         LogCallback logCallback,
                                         StatisticsCallback statisticsCallback)

Starts an asynchronous FFmpeg execution for the given command. Space character is used to split the command into arguments. You can use single or double quote characters to specify arguments inside your command.

Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback if you want to be notified about the result.

Parameters:

command - FFmpeg command

completeCallback - callback that will be called when the execution has completed

logCallback - callback that will receive logs

statisticsCallback - callback that will receive statistics

Returns:

FFmpeg session created for this execution

executeAsync

public static FFmpegSession executeAsync(java.lang.String command,
                                         FFmpegSessionCompleteCallback completeCallback,
                                         java.util.concurrent.ExecutorService executorService)

Starts an asynchronous FFmpeg execution for the given command. Space character is used to split the command into arguments. You can use single or double quote characters to specify arguments inside your command.

Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback if you want to be notified about the result.

Parameters:

command - FFmpeg command

completeCallback - callback that will be called when the execution has completed

executorService - executor service that will be used to run this asynchronous operation

Returns:

FFmpeg session created for this execution

executeAsync

public static FFmpegSession executeAsync(java.lang.String command,
                                         FFmpegSessionCompleteCallback completeCallback,
                                         LogCallback logCallback,
                                         StatisticsCallback statisticsCallback,
                                         java.util.concurrent.ExecutorService executorService)

Starts an asynchronous FFmpeg execution for the given command. Space character is used to split the command into arguments. You can use single or double quote characters to specify arguments inside your command.

Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback if you want to be notified about the result.

Parameters:

command - FFmpeg command

completeCallback - callback that will be called when the execution has completed

logCallback - callback that will receive logs

statisticsCallback - callback that will receive statistics

executorService - executor service that will be used to run this asynchronous operation

Returns:

FFmpeg session created for this execution

cancel

public static void cancel()

Cancels all running sessions.

This method does not wait for termination to complete and returns immediately.

cancel

public static void cancel(long sessionId)

Cancels the session specified with sessionId.

This method does not wait for termination to complete and returns immediately.

Parameters:

sessionId - id of the session that will be cancelled

listSessions

public static java.util.List<FFmpegSession> listSessions()

Lists all FFmpeg sessions in the session history.

Returns:

all FFmpeg sessions in the session history