Main class to run FFprobe
commands. Supports executing commands both synchronously and
* asynchronously.
*
* FFprobeSession *session = [FFprobeKit execute:@"-hide_banner -v error -show_entries format=size -of default=noprint_wrappers=1 file1.mp4"]; * * FFprobeSession *asyncSession = [FFprobeKit executeAsync:@"-hide_banner -v error -show_entries format=size -of default=noprint_wrappers=1 file1.mp4" withExecuteCallback:executeCallback]; **
Provides overloaded execute
methods to define session specific callbacks.
*
* FFprobeSession *session = [FFprobeKit executeAsync:@"-hide_banner -v error -show_entries format=size -of default=noprint_wrappers=1 file1.mp4" withExecuteCallback:executeCallback withLogCallback:logCallback]; **
It can extract media information for a file or a url, using getMediaInformation method. *
* MediaInformationSession *session = [FFprobeKit getMediaInformation:@"file1.mp4"]; **/ @interface FFprobeKit : NSObject /** *
Synchronously executes FFprobe with arguments provided. * * @param arguments FFprobe command options/arguments as string array * @return FFprobe session created for this execution */ + (FFprobeSession*)executeWithArguments:(NSArray*)arguments; /** *
Starts an asynchronous FFprobe execution with arguments provided. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * ExecuteCallback if you want to be notified about the result. * * @param arguments FFprobe command options/arguments as string array * @param executeCallback callback that will be called when the execution is completed * @return FFprobe session created for this execution */ + (FFprobeSession*)executeWithArgumentsAsync:(NSArray*)arguments withExecuteCallback:(ExecuteCallback)executeCallback; /** *
Starts an asynchronous FFprobe execution with arguments provided. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * ExecuteCallback if you want to be notified about the result. * * @param arguments FFprobe command options/arguments as string array * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @return FFprobe session created for this execution */ + (FFprobeSession*)executeWithArgumentsAsync:(NSArray*)arguments withExecuteCallback:(ExecuteCallback)executeCallback withLogCallback:(LogCallback)logCallback; /** *
Starts an asynchronous FFprobe execution with arguments provided. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * ExecuteCallback if you want to be notified about the result. * * @param arguments FFprobe command options/arguments as string array * @param executeCallback callback that will be called when the execution is completed * @param queue dispatch queue that will be used to run this asynchronous operation * @return FFprobe session created for this execution */ + (FFprobeSession*)executeWithArgumentsAsync:(NSArray*)arguments withExecuteCallback:(ExecuteCallback)executeCallback onDispatchQueue:(dispatch_queue_t)queue; /** *
Starts an asynchronous FFprobe execution with arguments provided. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * ExecuteCallback if you want to be notified about the result. * * @param arguments FFprobe command options/arguments as string array * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @param queue dispatch queue that will be used to run this asynchronous operation * @return FFprobe session created for this execution */ + (FFprobeSession*)executeWithArgumentsAsync:(NSArray*)arguments withExecuteCallback:(ExecuteCallback)executeCallback withLogCallback:(LogCallback)logCallback onDispatchQueue:(dispatch_queue_t)queue; /** *
Synchronously executes FFprobe 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 FFprobe command * @return FFprobe session created for this execution */ + (FFprobeSession*)execute:(NSString*)command; /** *
Starts an asynchronous FFprobe 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 * ExecuteCallback if you want to be notified about the result. * * @param command FFprobe command * @param executeCallback callback that will be called when the execution is completed * @return FFprobe session created for this execution */ + (FFprobeSession*)executeAsync:(NSString*)command withExecuteCallback:(ExecuteCallback)executeCallback; /** *
Starts an asynchronous FFprobe 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 * ExecuteCallback if you want to be notified about the result. * * @param command FFprobe command * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @return FFprobe session created for this execution */ + (FFprobeSession*)executeAsync:(NSString*)command withExecuteCallback:(ExecuteCallback)executeCallback withLogCallback:(LogCallback)logCallback; /** *
Starts an asynchronous FFprobe 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 * ExecuteCallback if you want to be notified about the result. * * @param command FFprobe command * @param executeCallback callback that will be called when the execution is completed * @param queue dispatch queue that will be used to run this asynchronous operation * @return FFprobe session created for this execution */ + (FFprobeSession*)executeAsync:(NSString*)command withExecuteCallback:(ExecuteCallback)executeCallback onDispatchQueue:(dispatch_queue_t)queue; /** *
Starts an asynchronous FFprobe 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 * ExecuteCallback if you want to be notified about the result. * * @param command FFprobe command * @param executeCallback callback that will be called when the execution is completed * @param logCallback callback that will receive logs * @param queue dispatch queue that will be used to run this asynchronous operation * @return FFprobe session created for this execution */ + (FFprobeSession*)executeAsync:(NSString*)command withExecuteCallback:(ExecuteCallback)executeCallback withLogCallback:(LogCallback)logCallback onDispatchQueue:(dispatch_queue_t)queue; /** *
Extracts media information for the file specified with path. * * @param path path or uri of a media file * @return media information session created for this execution */ + (MediaInformationSession*)getMediaInformation:(NSString*)path; /** *
Extracts media information for the file specified with path. * * @param path path or uri of a media file * @param waitTimeout max time to wait until media information is transmitted * @return media information session created for this execution */ + (MediaInformationSession*)getMediaInformation:(NSString*)path withTimeout:(int)waitTimeout; /** *
Starts an asynchronous FFprobe execution to extract the media information for the specified file. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * ExecuteCallback if you want to be notified about the result. * * @param path path or uri of a media file * @param executeCallback callback that will be called when the execution is completed * @return media information session created for this execution */ + (MediaInformationSession*)getMediaInformationAsync:(NSString*)path withExecuteCallback:(ExecuteCallback)executeCallback; /** *
Starts an asynchronous FFprobe execution to extract the media information for the specified file. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * ExecuteCallback if you want to be notified about the result. * * @param path path or uri of a media file * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @param waitTimeout max time to wait until media information is transmitted * @return media information session created for this execution */ + (MediaInformationSession*)getMediaInformationAsync:(NSString*)path withExecuteCallback:(ExecuteCallback)executeCallback withLogCallback:(LogCallback)logCallback withTimeout:(int)waitTimeout; /** *
Starts an asynchronous FFprobe execution to extract the media information for the specified file. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * ExecuteCallback if you want to be notified about the result. * * @param path path or uri of a media file * @param executeCallback callback that will be called when the execution is completed * @param queue dispatch queue that will be used to run this asynchronous operation * @return media information session created for this execution */ + (MediaInformationSession*)getMediaInformationAsync:(NSString*)path withExecuteCallback:(ExecuteCallback)executeCallback onDispatchQueue:(dispatch_queue_t)queue; /** *
Starts an asynchronous FFprobe execution to extract the media information for the specified file. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * ExecuteCallback if you want to be notified about the result. * * @param path path or uri of a media file * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @param queue dispatch queue that will be used to run this asynchronous operation * @param waitTimeout max time to wait until media information is transmitted * @return media information session created for this execution */ + (MediaInformationSession*)getMediaInformationAsync:(NSString*)path withExecuteCallback:(ExecuteCallback)executeCallback withLogCallback:(LogCallback)logCallback onDispatchQueue:(dispatch_queue_t)queue withTimeout:(int)waitTimeout; /** *
Extracts media information using the command provided asynchronously. * * @param command FFprobe command that prints media information for a file in JSON format * @return media information session created for this execution */ + (MediaInformationSession*)getMediaInformationFromCommand:(NSString*)command; /** *
Starts an asynchronous FFprobe execution to extract media information using a command. The command passed to * this method must generate the output in JSON format in order to successfully extract media information from it. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * ExecuteCallback if you want to be notified about the result. * * @param command FFprobe command that prints media information for a file in JSON format * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @param queue dispatch queue that will be used to run this asynchronous operation * @param waitTimeout max time to wait until media information is transmitted * @return media information session created for this execution */ + (MediaInformationSession*)getMediaInformationFromCommandAsync:(NSString*)command withExecuteCallback:(ExecuteCallback)executeCallback withLogCallback:(LogCallback)logCallback onDispatchQueue:(dispatch_queue_t)queue withTimeout:(int)waitTimeout; /** *
Lists all FFprobe sessions in the session history. * * @return all FFprobe sessions in the session history */ + (NSArray*)listSessions; @end #endif // FFPROBE_KIT_H