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" withCompleteCallback:completeCallback]; **
Provides overloaded execute
methods to define session
* specific callbacks.
FFmpegSession *asyncSession = [FFmpegKit * executeAsync:@"-i file1.mp4 -c:v libxvid file1.avi" * withCompleteCallback:completeCallback withLogCallback:logCallback * withStatisticsCallback:statisticsCallback]; **/ @interface FFmpegKit : NSObject /** *
Synchronously executes FFmpeg with arguments provided. * * @param arguments FFmpeg command options/arguments as string array * @return FFmpeg session created for this execution */ + (FFmpegSession *)executeWithArguments:(NSArray *)arguments; /** *
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. * * @param arguments FFmpeg command options/arguments as string array * @param completeCallback callback that will be called when the execution has * completed * @return FFmpeg session created for this execution */ + (FFmpegSession *)executeWithArgumentsAsync:(NSArray *)arguments withCompleteCallback: (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. * * @param arguments FFmpeg command options/arguments as string array * @param completeCallback callback that will be called when the execution * has completed * @param logCallback callback that will receive logs * @param statisticsCallback callback that will receive statistics * @return FFmpeg session created for this execution */ + (FFmpegSession *) executeWithArgumentsAsync:(NSArray *)arguments withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback withLogCallback:(LogCallback)logCallback withStatisticsCallback:(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. * * @param arguments FFmpeg command options/arguments as string array * @param completeCallback callback that will be called when the execution has * completed * @param queue dispatch queue that will be used to run this * asynchronous operation * @return FFmpeg session created for this execution */ + (FFmpegSession *)executeWithArgumentsAsync:(NSArray *)arguments withCompleteCallback: (FFmpegSessionCompleteCallback)completeCallback onDispatchQueue:(dispatch_queue_t)queue; /** *
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. * * @param arguments FFmpeg command options/arguments as string array * @param completeCallback callback that will be called when the execution * has completed * @param logCallback callback that will receive logs * @param statisticsCallback callback that will receive statistics * @param queue dispatch queue that will be used to run this * asynchronous operation * @return FFmpeg session created for this execution */ + (FFmpegSession *) executeWithArgumentsAsync:(NSArray *)arguments withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback withLogCallback:(LogCallback)logCallback withStatisticsCallback:(StatisticsCallback)statisticsCallback onDispatchQueue:(dispatch_queue_t)queue; /** *
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. * * @param command FFmpeg command * @return FFmpeg session created for this execution */ + (FFmpegSession *)execute:(NSString *)command; /** *
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. * * @param command FFmpeg command * @param completeCallback callback that will be called when the execution has * completed * @return FFmpeg session created for this execution */ + (FFmpegSession *)executeAsync:(NSString *)command withCompleteCallback:(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. * * @param command FFmpeg command * @param completeCallback callback that will be called when the execution * has completed * @param logCallback callback that will receive logs * @param statisticsCallback callback that will receive statistics * @return FFmpeg session created for this execution */ + (FFmpegSession *)executeAsync:(NSString *)command withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback withLogCallback:(LogCallback)logCallback withStatisticsCallback:(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. * * @param command FFmpeg command * @param completeCallback callback that will be called when the execution has * completed * @param queue dispatch queue that will be used to run this * asynchronous operation * @return FFmpeg session created for this execution */ + (FFmpegSession *)executeAsync:(NSString *)command withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback onDispatchQueue:(dispatch_queue_t)queue; /** *
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. * * @param command FFmpeg command * @param completeCallback callback that will be called when the execution * has completed * @param logCallback callback that will receive logs * @param statisticsCallback callback that will receive statistics * @param queue dispatch queue that will be used to run this * asynchronous operation * @return FFmpeg session created for this execution */ + (FFmpegSession *)executeAsync:(NSString *)command withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback withLogCallback:(LogCallback)logCallback withStatisticsCallback:(StatisticsCallback)statisticsCallback onDispatchQueue:(dispatch_queue_t)queue; /** *
Cancels all running sessions. * *
This method does not wait for termination to complete and returns * immediately. */ + (void)cancel; /** *
Cancels the session specified with sessionId
.
*
*
This method does not wait for termination to complete and returns * immediately. * * @param sessionId id of the session that will be cancelled */ + (void)cancel:(long)sessionId; /** *
Lists all FFmpeg sessions in the session history. * * @return all FFmpeg sessions in the session history */ + (NSArray *)listSessions; @end #endif // FFMPEG_KIT_H