ffmpeg-kit/docs/android/javadoc/com/arthenica/ffmpegkit/FFmpegKit.html

728 lines
52 KiB
HTML
Raw Normal View History

2022-09-17 20:29:42 +03:00
<!DOCTYPE HTML>
2021-03-02 01:25:17 +02:00
<!-- NewPage -->
2023-08-22 23:00:49 +03:00
<html lang="en"><head>
<title>FFmpegKit </title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2020-03-25">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../dokka-javadoc-stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
<script type="text/javascript" src="../../../search.js"></script>
<script async type="text/javascript" src="../../../module-search-index.js"></script>
<script async type="text/javascript" src="../../../package-search-index.js"></script>
<script async type="text/javascript" src="../../../type-search-index.js"></script>
<script async type="text/javascript" src="../../../member-search-index.js"></script>
<script async type="text/javascript" src="../../../tag-search-index.js"></script>
</head><body>
<script type="text/javascript">
2022-09-17 20:29:42 +03:00
var pathtoroot = "../../../";
2023-08-22 23:00:49 +03:00
</script>
2021-03-02 01:25:17 +02:00
<noscript>
2023-08-22 23:00:49 +03:00
<div>JavaScript is disabled on your browser.</div>
</noscript><header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a>
</div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li>Help</li>
</ul></div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top" style="display: block;">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
2022-09-17 20:29:42 +03:00
</ul>
2023-08-22 23:00:49 +03:00
2022-09-17 20:29:42 +03:00
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
2023-08-22 23:00:49 +03:00
<input type="text" id="search" value="search" class="ui-autocomplete-input" autocomplete="off" placeholder="Search">
<input type="reset" id="reset" value="reset">
2022-09-17 20:29:42 +03:00
</li>
2021-03-02 01:25:17 +02:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
2022-09-17 20:29:42 +03:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2021-03-02 01:25:17 +02:00
</div>
2022-09-17 20:29:42 +03:00
<a id="skip.navbar.top">
2021-03-02 01:25:17 +02:00
<!-- -->
2023-08-22 23:00:49 +03:00
</a></div><!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
2022-09-17 20:29:42 +03:00
</header>
2021-03-02 01:25:17 +02:00
2023-08-22 23:00:49 +03:00
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html"></a></div>
<h2 title="Class FFmpegKit" class="title">Class FFmpegKit</h2>
</div>
<div class="contentContainer">
<!-- <ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>adaptation.Adaptation</li>
</ul>
</li>
</ul> TODO inheritance tree -->
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre class="wrap-overflow">
2022-09-17 20:29:42 +03:00
2023-08-22 23:00:49 +03:00
public class <span class="typeNameLabel"><a href=FFmpegKit.html>FFmpegKit</a></span>
2021-03-02 01:25:17 +02:00
2023-08-22 23:00:49 +03:00
</pre>
<div class="block"><p>Main class to run <code>FFmpeg</code> commands. Supports executing commands both synchronously and asynchronously. </p><pre><code>FFmpegSession session = FFmpegKit.execute("-i file1.mp4 -c:v libxvid file1.avi");
2021-03-02 01:25:17 +02:00
2023-08-22 23:00:49 +03:00
FFmpegSession asyncSession = FFmpegKit.executeAsync("-i file1.mp4 -c:v libxvid file1.avi", completeCallback);
</code></pre><p>Provides overloaded <code>execute</code> methods to define session specific callbacks. </p><pre><code>FFmpegSession asyncSession = FFmpegKit.executeAsync("-i file1.mp4 -c:v libxvid file1.avi", completeCallback, logCallback, statisticsCallback);
</code></pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal">
<button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button>
<!-- TODO: Instance and Concrete Methods #1118 -->
</div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href=FFmpegSession.html>FFmpegSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#executeWithArguments(Array)>executeWithArguments</a>(<a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; arguments) </code>
</th>
<td class="colLast">Synchronously executes FFmpeg with arguments provided.</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href=FFmpegSession.html>FFmpegSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback)>executeWithArgumentsAsync</a>(<a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; arguments, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback) </code>
</th>
<td class="colLast">Starts an asynchronous FFmpeg execution with arguments provided.</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href=FFmpegSession.html>FFmpegSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback)>executeWithArgumentsAsync</a>(<a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; arguments, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=LogCallback.html>LogCallback</a> logCallback, <a href=StatisticsCallback.html>StatisticsCallback</a> statisticsCallback) </code>
</th>
<td class="colLast">Starts an asynchronous FFmpeg execution with arguments provided.</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href=FFmpegSession.html>FFmpegSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback,ExecutorService)>executeWithArgumentsAsync</a>(<a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; arguments, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/ExecutorService.html>ExecutorService</a> executorService) </code>
</th>
<td class="colLast">Starts an asynchronous FFmpeg execution with arguments provided.</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href=FFmpegSession.html>FFmpegSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback,ExecutorService)>executeWithArgumentsAsync</a>(<a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; arguments, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=LogCallback.html>LogCallback</a> logCallback, <a href=StatisticsCallback.html>StatisticsCallback</a> statisticsCallback, <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/ExecutorService.html>ExecutorService</a> executorService) </code>
</th>
<td class="colLast">Starts an asynchronous FFmpeg execution with arguments provided.</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href=FFmpegSession.html>FFmpegSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#execute(String)>execute</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> command) </code>
</th>
<td class="colLast">Synchronously executes FFmpeg command provided.</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href=FFmpegSession.html>FFmpegSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#executeAsync(String,FFmpegSessionCompleteCallback)>executeAsync</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> command, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback) </code>
</th>
<td class="colLast">Starts an asynchronous FFmpeg execution for the given command.</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href=FFmpegSession.html>FFmpegSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#executeAsync(String,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback)>executeAsync</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> command, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=LogCallback.html>LogCallback</a> logCallback, <a href=StatisticsCallback.html>StatisticsCallback</a> statisticsCallback) </code>
</th>
<td class="colLast">Starts an asynchronous FFmpeg execution for the given command.</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href=FFmpegSession.html>FFmpegSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#executeAsync(String,FFmpegSessionCompleteCallback,ExecutorService)>executeAsync</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> command, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/ExecutorService.html>ExecutorService</a> executorService) </code>
</th>
<td class="colLast">Starts an asynchronous FFmpeg execution for the given command.</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href=FFmpegSession.html>FFmpegSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#executeAsync(String,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback,ExecutorService)>executeAsync</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> command, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=LogCallback.html>LogCallback</a> logCallback, <a href=StatisticsCallback.html>StatisticsCallback</a> statisticsCallback, <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/ExecutorService.html>ExecutorService</a> executorService) </code>
</th>
<td class="colLast">Starts an asynchronous FFmpeg execution for the given command.</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static void</code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#cancel()>cancel</a>() </code>
</th>
<td class="colLast">Cancels all running sessions.</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static void</code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#cancel(long)>cancel</a>(long sessionId) </code>
</th>
<td class="colLast">Cancels the session specified with <code>sessionId</code>.</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a>&lt;<a href=FFmpegSession.html>FFmpegSession</a>&gt;</code>
</td>
<th class="colSecond" scope="row"><code><a href=FFmpegKit.html#listSessions()>listSessions</a>() </code>
</th>
<td class="colLast">Lists all FFmpeg sessions in the session history.</td>
</tr>
</tbody>
</table>
</div>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="executeWithArguments(Array)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>executeWithArguments</h4>
<pre class="methodSignature"> static <a href=FFmpegSession.html>FFmpegSession</a> <a href=FFmpegKit.html#executeWithArguments(Array)>executeWithArguments</a>(<a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; arguments)</pre>
<div class="block"><p>Synchronously executes FFmpeg with arguments provided.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - FFmpeg command options/arguments as string array</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>executeWithArgumentsAsync</h4>
<pre class="methodSignature"> static <a href=FFmpegSession.html>FFmpegSession</a> <a href=FFmpegKit.html#executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback)>executeWithArgumentsAsync</a>(<a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; arguments, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback)</pre>
<div class="block"><p>Starts an asynchronous FFmpeg execution with arguments provided.</p><p>Note that this method returns immediately and does not wait the execution to complete.You must use an <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> if you want to be notified about theresult.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - FFmpeg command options/arguments as string array</dd>
<dd><code>completeCallback</code> - callback that will be called when the execution has completed</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>executeWithArgumentsAsync</h4>
<pre class="methodSignature"> static <a href=FFmpegSession.html>FFmpegSession</a> <a href=FFmpegKit.html#executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback)>executeWithArgumentsAsync</a>(<a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; arguments, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=LogCallback.html>LogCallback</a> logCallback, <a href=StatisticsCallback.html>StatisticsCallback</a> statisticsCallback)</pre>
<div class="block"><p>Starts an asynchronous FFmpeg execution with arguments provided.</p><p>Note that this method returns immediately and does not wait the execution to complete.You must use an <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> if you want to be notified about theresult.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - FFmpeg command options/arguments as string array</dd>
<dd><code>completeCallback</code> - callback that will be called when the execution has completed</dd>
<dd><code>logCallback</code> - callback that will receive logs</dd>
<dd><code>statisticsCallback</code> - callback that will receive statistics</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback,ExecutorService)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>executeWithArgumentsAsync</h4>
<pre class="methodSignature"> static <a href=FFmpegSession.html>FFmpegSession</a> <a href=FFmpegKit.html#executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback,ExecutorService)>executeWithArgumentsAsync</a>(<a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; arguments, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/ExecutorService.html>ExecutorService</a> executorService)</pre>
<div class="block"><p>Starts an asynchronous FFmpeg execution with arguments provided.</p><p>Note that this method returns immediately and does not wait the execution to complete.You must use an <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> if you want to be notified about theresult.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - FFmpeg command options/arguments as string array</dd>
<dd><code>completeCallback</code> - callback that will be called when the execution has completed</dd>
<dd><code>executorService</code> - executor service that will be used to run this asynchronous operation</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback,ExecutorService)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>executeWithArgumentsAsync</h4>
<pre class="methodSignature"> static <a href=FFmpegSession.html>FFmpegSession</a> <a href=FFmpegKit.html#executeWithArgumentsAsync(Array,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback,ExecutorService)>executeWithArgumentsAsync</a>(<a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; arguments, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=LogCallback.html>LogCallback</a> logCallback, <a href=StatisticsCallback.html>StatisticsCallback</a> statisticsCallback, <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/ExecutorService.html>ExecutorService</a> executorService)</pre>
<div class="block"><p>Starts an asynchronous FFmpeg execution with arguments provided.</p><p>Note that this method returns immediately and does not wait the execution to complete.You must use an <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> if you want to be notified about theresult.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - FFmpeg command options/arguments as string array</dd>
<dd><code>completeCallback</code> - callback that will be called when the execution has completed</dd>
<dd><code>logCallback</code> - callback that will receive logs</dd>
<dd><code>statisticsCallback</code> - callback that will receive statistics</dd>
<dd><code>executorService</code> - executor service that will be used to run this asynchronousoperation</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="execute(String)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature"> static <a href=FFmpegSession.html>FFmpegSession</a> <a href=FFmpegKit.html#execute(String)>execute</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> command)</pre>
<div class="block"><p>Synchronously executes FFmpeg command provided. Space character is used to split commandinto arguments. You can use single or double quote characters to specify arguments insideyour command.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - FFmpeg command</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="executeAsync(String,FFmpegSessionCompleteCallback)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature"> static <a href=FFmpegSession.html>FFmpegSession</a> <a href=FFmpegKit.html#executeAsync(String,FFmpegSessionCompleteCallback)>executeAsync</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> command, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback)</pre>
<div class="block"><p>Starts an asynchronous FFmpeg execution for the given command. Space character is used tosplit the command into arguments. You can use single or double quote characters to specifyarguments inside your command.</p><p>Note that this method returns immediately and does not wait the execution to complete.You must use an <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> if you want to be notified about theresult.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - FFmpeg command</dd>
<dd><code>completeCallback</code> - callback that will be called when the execution has completed</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="executeAsync(String,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature"> static <a href=FFmpegSession.html>FFmpegSession</a> <a href=FFmpegKit.html#executeAsync(String,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback)>executeAsync</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> command, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=LogCallback.html>LogCallback</a> logCallback, <a href=StatisticsCallback.html>StatisticsCallback</a> statisticsCallback)</pre>
<div class="block"><p>Starts an asynchronous FFmpeg execution for the given command. Space character is used tosplit the command into arguments. You can use single or double quote characters to specifyarguments inside your command.</p><p>Note that this method returns immediately and does not wait the execution to complete.You must use an <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> if you want to be notified about theresult.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - FFmpeg command</dd>
<dd><code>completeCallback</code> - callback that will be called when the execution has completed</dd>
<dd><code>logCallback</code> - callback that will receive logs</dd>
<dd><code>statisticsCallback</code> - callback that will receive statistics</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="executeAsync(String,FFmpegSessionCompleteCallback,ExecutorService)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature"> static <a href=FFmpegSession.html>FFmpegSession</a> <a href=FFmpegKit.html#executeAsync(String,FFmpegSessionCompleteCallback,ExecutorService)>executeAsync</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> command, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/ExecutorService.html>ExecutorService</a> executorService)</pre>
<div class="block"><p>Starts an asynchronous FFmpeg execution for the given command. Space character is used tosplit the command into arguments. You can use single or double quote characters to specifyarguments inside your command.</p><p>Note that this method returns immediately and does not wait the execution to complete.You must use an <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> if you want to be notified about theresult.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - FFmpeg command</dd>
<dd><code>completeCallback</code> - callback that will be called when the execution has completed</dd>
<dd><code>executorService</code> - executor service that will be used to run this asynchronous operation</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="executeAsync(String,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback,ExecutorService)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature"> static <a href=FFmpegSession.html>FFmpegSession</a> <a href=FFmpegKit.html#executeAsync(String,FFmpegSessionCompleteCallback,LogCallback,StatisticsCallback,ExecutorService)>executeAsync</a>(<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> command, <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> completeCallback, <a href=LogCallback.html>LogCallback</a> logCallback, <a href=StatisticsCallback.html>StatisticsCallback</a> statisticsCallback, <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/ExecutorService.html>ExecutorService</a> executorService)</pre>
<div class="block"><p>Starts an asynchronous FFmpeg execution for the given command. Space character is used tosplit the command into arguments. You can use single or double quote characters to specifyarguments inside your command.</p><p>Note that this method returns immediately and does not wait the execution to complete.You must use an <a href=FFmpegSessionCompleteCallback.html>FFmpegSessionCompleteCallback</a> if you want to be notified about theresult.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - FFmpeg command</dd>
<dd><code>completeCallback</code> - callback that will be called when the execution has completed</dd>
<dd><code>logCallback</code> - callback that will receive logs</dd>
<dd><code>statisticsCallback</code> - callback that will receive statistics</dd>
<dd><code>executorService</code> - executor service that will be used to run this asynchronous operation</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="cancel()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>cancel</h4>
<pre class="methodSignature"> static void <a href=FFmpegKit.html#cancel()>cancel</a>()</pre>
<div class="block"><p>Cancels all running sessions.</p><p>This method does not wait for termination to complete and returns immediately.</p></div>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="cancel(long)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>cancel</h4>
<pre class="methodSignature"> static void <a href=FFmpegKit.html#cancel(long)>cancel</a>(long sessionId)</pre>
<div class="block"><p>Cancels the session specified with <code>sessionId</code>.</p><p>This method does not wait for termination to complete and returns immediately.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sessionId</code> - id of the session that will be cancelled</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="listSessions()">
<!-- -->
</a>
<ul class=
"blockListLast"
>
<li class="blockList">
<h4>listSessions</h4>
<pre class="methodSignature"> static <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a>&lt;<a href=FFmpegSession.html>FFmpegSession</a>&gt; <a href=FFmpegKit.html#listSessions()>listSessions</a>()</pre>
<div class="block"><p>Lists all FFmpeg sessions in the session history.</p></div>
<!-- TODO missing return annotation -->
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
2022-09-17 20:29:42 +03:00
</main>
<footer role="contentinfo">
2023-08-22 23:00:49 +03:00
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a>
</div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li>Help</li>
</ul></div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top" style="display: block;">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
2021-03-02 01:25:17 +02:00
</ul>
<div>
<script type="text/javascript"><!--
2023-08-22 23:00:49 +03:00
allClassesLink = document.getElementById("allclasses_navbar_top");
2021-03-02 01:25:17 +02:00
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
2022-09-17 20:29:42 +03:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2021-03-02 01:25:17 +02:00
</div>
2023-08-22 23:00:49 +03:00
<a id="skip.navbar.top">
2021-03-02 01:25:17 +02:00
<!-- -->
2023-08-22 23:00:49 +03:00
</a></div><!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer><ul class="ui-autocomplete ui-front ui-menu ui-widget ui-widget-content" id="ui-id-1" tabindex="0"
style="display: none;"></ul>
<span role="status" aria-live="assertive" aria-relevant="additions" class="ui-helper-hidden-accessible"></span>
2021-03-02 01:25:17 +02:00
</body>
</html>