com.arthenica.mobileffmpeg

Class FFmpeg

java.lang.Object

com.arthenica.mobileffmpeg.FFmpeg

public class FFmpeg
extends java.lang.Object

Main class for FFmpeg operations. Supports synchronous execute(String...) and asynchronous executeAsync(String, ExecuteCallback) methods to execute FFmpeg commands.

      int rc = FFmpeg.execute("-i file1.mp4 -c:v libxvid file1.avi");
      Log.i(Config.TAG, String.format("Command execution %s.", (rc == 0?"completed successfully":"failed with rc=" + rc));
 

      long executionId = FFmpeg.executeAsync("-i file1.mp4 -c:v libxvid file1.avi", executeCallback);
      Log.i(Config.TAG, String.format("Asynchronous execution %d started.", executionId));
 

Since:

v1.0

Method Summary

Modifier and Type	Method and Description
static void	cancel() Cancels an ongoing operation.
static void	cancel(long executionId) Cancels an ongoing operation.
static int	execute(java.lang.String command) Synchronously executes FFmpeg command provided.
static int	execute(java.lang.String[] arguments) Synchronously executes FFmpeg with arguments provided.
static int	execute(java.lang.String command, java.lang.String delimiter) Deprecated. argument splitting mechanism used in this method is pretty simple and prone to errors. Consider using a more advanced method like execute(String) or execute(String[])
static long	executeAsync(java.lang.String[] arguments, ExecuteCallback executeCallback) Asynchronously executes FFmpeg with arguments provided.
static long	executeAsync(java.lang.String[] arguments, ExecuteCallback executeCallback, java.util.concurrent.Executor executor) Asynchronously executes FFmpeg with arguments provided.
static long	executeAsync(java.lang.String command, ExecuteCallback executeCallback) Asynchronously executes FFmpeg command provided.
static long	executeAsync(java.lang.String command, ExecuteCallback executeCallback, java.util.concurrent.Executor executor) Asynchronously executes FFmpeg command provided.
static java.util.List<FFmpegExecution>	listExecutions() Lists ongoing executions.

Methods inherited from class java.lang.Object

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

Method Detail

execute

public static int execute(java.lang.String[] arguments)

Synchronously executes FFmpeg with arguments provided.

Parameters:

arguments - FFmpeg command options/arguments as string array

Returns:

0 on successful execution, 255 on user cancel, other non-zero codes on error

executeAsync

public static long executeAsync(java.lang.String[] arguments,
                                ExecuteCallback executeCallback)

Asynchronously executes FFmpeg with arguments provided.

Parameters:

arguments - FFmpeg command options/arguments as string array

executeCallback - callback that will be notified when execution is completed

Returns:

returns a unique id that represents this execution

executeAsync

public static long executeAsync(java.lang.String[] arguments,
                                ExecuteCallback executeCallback,
                                java.util.concurrent.Executor executor)

Asynchronously executes FFmpeg with arguments provided.

Parameters:

arguments - FFmpeg command options/arguments as string array

executeCallback - callback that will be notified when execution is completed

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

Returns:

returns a unique id that represents this execution

execute

public static int execute(java.lang.String command,
                          java.lang.String delimiter)

Deprecated. argument splitting mechanism used in this method is pretty simple and prone to errors. Consider using a more advanced method like execute(String) or execute(String[])

Synchronously executes FFmpeg command provided. Command is split into arguments using provided delimiter character.

Parameters:

command - FFmpeg command

delimiter - delimiter used to split arguments

Returns:

0 on successful execution, 255 on user cancel, other non-zero codes on error

Since:

3.0

execute

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

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

Parameters:

command - FFmpeg command

Returns:

0 on successful execution, 255 on user cancel, other non-zero codes on error

executeAsync

public static long executeAsync(java.lang.String command,
                                ExecuteCallback executeCallback)

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

Parameters:

command - FFmpeg command

executeCallback - callback that will be notified when execution is completed

Returns:

returns a unique id that represents this execution

executeAsync

public static long executeAsync(java.lang.String command,
                                ExecuteCallback executeCallback,
                                java.util.concurrent.Executor executor)

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

Parameters:

command - FFmpeg command

executeCallback - callback that will be notified when execution is completed

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

Returns:

returns a unique id that represents this execution

cancel

public static void cancel()

Cancels an ongoing operation.

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

cancel

public static void cancel(long executionId)

Cancels an ongoing operation.

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

Parameters:

executionId - id of the execution

listExecutions

public static java.util.List<FFmpegExecution> listExecutions()

Lists ongoing executions.

Returns:

list of ongoing executions