Package 

Class FFprobeKit

  • 
public class FFprobeKit

    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", completeCallback);

    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", completeCallback, logCallback);

    It can extract media information for a file or a url, using getMediaInformation method. 

    MediaInformationSession session = FFprobeKit.getMediaInformation("file1.mp4");

    • Method Detail

      • executeWithArgumentsAsync

         static FFprobeSession executeWithArgumentsAsync(Array<String> arguments, FFprobeSessionCompleteCallback completeCallback, 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 FFprobeSessionCompleteCallback if you want to be notified about theresult.

        Parameters:
        arguments - FFprobe command options/arguments as string array
        completeCallback - callback that will be notified when execution has completed
        logCallback - callback that will receive logs

      • executeWithArgumentsAsync

         static FFprobeSession executeWithArgumentsAsync(Array<String> arguments, FFprobeSessionCompleteCallback completeCallback, ExecutorService executorService)

        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 FFprobeSessionCompleteCallback if you want to be notified about theresult.

        Parameters:
        arguments - FFprobe 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

      • executeWithArgumentsAsync

         static FFprobeSession executeWithArgumentsAsync(Array<String> arguments, FFprobeSessionCompleteCallback completeCallback, LogCallback logCallback, ExecutorService executorService)

        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 FFprobeSessionCompleteCallback if you want to be notified about theresult.

        Parameters:
        arguments - FFprobe command options/arguments as string array
        completeCallback - callback that will be notified when execution has completed
        logCallback - callback that will receive logs
        executorService - executor service that will be used to run this asynchronous operation

      • execute

         static FFprobeSession execute(String command)

        Synchronously executes FFprobe command provided. Space character is used to split commandinto arguments. You can use single or double quote characters to specify arguments insideyour command.

        Parameters:
        command - FFprobe command

      • executeAsync

         static FFprobeSession executeAsync(String command, FFprobeSessionCompleteCallback completeCallback)

        Starts an asynchronous FFprobe execution for the given command. Space character is usedto split the command into arguments. You can use single or double quote characters tospecify arguments inside your command.

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

        Parameters:
        command - FFprobe command
        completeCallback - callback that will be called when the execution has completed

      • executeAsync

         static FFprobeSession executeAsync(String command, FFprobeSessionCompleteCallback completeCallback, LogCallback logCallback)

        Starts an asynchronous FFprobe execution for the given command. Space character is usedto split the command into arguments. You can use single or double quote characters tospecify arguments inside your command.

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

        Parameters:
        command - FFprobe command
        completeCallback - callback that will be notified when execution has completed
        logCallback - callback that will receive logs

      • executeAsync

         static FFprobeSession executeAsync(String command, FFprobeSessionCompleteCallback completeCallback, ExecutorService executorService)

        Starts an asynchronous FFprobe execution for the given command. Space character is usedto split the command into arguments. You can use single or double quote characters tospecify arguments inside your command.

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

        Parameters:
        command - FFprobe command
        completeCallback - callback that will be called when the execution has completed
        executorService - executor service that will be used to run this asynchronous operation

      • executeAsync

         static FFprobeSession executeAsync(String command, FFprobeSessionCompleteCallback completeCallback, LogCallback logCallback, ExecutorService executorService)

        Starts an asynchronous FFprobe execution for the given command. Space character is usedto split the command into arguments. You can use single or double quote characters tospecify arguments inside your command.

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

        Parameters:
        command - FFprobe command
        completeCallback - callback that will be called when the execution has completed
        logCallback - callback that will receive logs
        executorService - executor service that will be used to run this asynchronous operation

      • getMediaInformation

         static MediaInformationSession getMediaInformation(String path, int waitTimeout)

        Extracts media information for the file specified with path.

        Parameters:
        path - path or uri of a media file
        waitTimeout - max time to wait until media information is transmitted

      • getMediaInformationAsync

         static MediaInformationSession getMediaInformationAsync(String path, MediaInformationSessionCompleteCallback completeCallback, LogCallback logCallback, int waitTimeout)

        Starts an asynchronous FFprobe execution to extract the media information for thespecified file.

        Note that this method returns immediately and does not wait the execution to complete.You must use a MediaInformationSessionCompleteCallback if you want to be notifiedabout the result.

        Parameters:
        path - path or uri of a media file
        completeCallback - callback that will be notified when execution has completed
        logCallback - callback that will receive logs
        waitTimeout - max time to wait until media information is transmitted

      • getMediaInformationAsync

         static MediaInformationSession getMediaInformationAsync(String path, MediaInformationSessionCompleteCallback completeCallback, LogCallback logCallback, ExecutorService executorService, int waitTimeout)

        Starts an asynchronous FFprobe execution to extract the media information for thespecified file.

        Note that this method returns immediately and does not wait the execution to complete.You must use a MediaInformationSessionCompleteCallback if you want to be notifiedabout the result.

        Parameters:
        path - path or uri of a media file
        completeCallback - callback that will be notified when execution has completed
        logCallback - callback that will receive logs
        executorService - executor service that will be used to run this asynchronous operation
        waitTimeout - max time to wait until media information is transmitted

      • getMediaInformationFromCommandAsync

         static MediaInformationSession getMediaInformationFromCommandAsync(String command, MediaInformationSessionCompleteCallback completeCallback, LogCallback logCallback, int waitTimeout)

        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 tosuccessfully extract media information from it.

        Note that this method returns immediately and does not wait the execution to complete.You must use a MediaInformationSessionCompleteCallback if you want to be notifiedabout the result.

        Parameters:
        command - FFprobe command that prints media information for a file in JSONformat
        completeCallback - callback that will be notified when execution has completed
        logCallback - callback that will receive logs
        waitTimeout - max time to wait until media information is transmitted