antonlyap/ffmpeg-kit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
98bb5c7619
ffmpeg-kit/docs/android/javadoc/com/arthenica/ffmpegkit/FFmpegKit.html
Taner Sener 2cf5f9ff0e update documentation
2021-03-03 18:59:41 +00:00

669 lines
32 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>FFmpegKit (FFmpegKit)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FFmpegKit (FFmpegKit)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<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="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</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>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.arthenica.ffmpegkit</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>com.arthenica.ffmpegkit.FFmpegKit</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">FFmpegKit</span>
extends java.lang.Object</pre>
<div class="block"><p>Main class to run <code>FFmpeg</code> commands. Supports executing commands both
synchronously and asynchronously.
<pre>
FFmpegSession session = FFmpegKit.execute("-i file1.mp4 -c:v libxvid file1.avi");
FFmpegSession asyncSession = FFmpegKit.executeAsync("-i file1.mp4 -c:v libxvid file1.avi", executeCallback);
</pre>
<p>Provides overloaded <code>execute</code> methods to define session specific callbacks.
<pre>
FFmpegSession asyncSession = FFmpegKit.executeAsync("-i file1.mp4 -c:v libxvid file1.avi", executeCallback, logCallback, statisticsCallback);
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<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 java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#argumentsToString(java.lang.String%5B%5D)">argumentsToString</a></span>&#8203;(java.lang.String[]&nbsp;arguments)</code></th>
<td class="colLast">
<div class="block">Concatenates arguments into a string adding a space character between two arguments.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancel()">cancel</a></span>()</code></th>
<td class="colLast">
<div class="block">Cancels all running sessions.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancel(long)">cancel</a></span>&#8203;(long&nbsp;sessionId)</code></th>
<td class="colLast">
<div class="block">Cancels the session specified with <code>sessionId</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(java.lang.String)">execute</a></span>&#8203;(java.lang.String&nbsp;command)</code></th>
<td class="colLast">
<div class="block">Synchronously executes FFmpeg command provided.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(java.lang.String%5B%5D)">execute</a></span>&#8203;(java.lang.String[]&nbsp;arguments)</code></th>
<td class="colLast">
<div class="block">Synchronously executes FFmpeg with arguments provided.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeAsync(java.lang.String%5B%5D,com.arthenica.ffmpegkit.ExecuteCallback)">executeAsync</a></span>&#8203;(java.lang.String[]&nbsp;arguments,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes FFmpeg with arguments provided.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeAsync(java.lang.String%5B%5D,com.arthenica.ffmpegkit.ExecuteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback)">executeAsync</a></span>&#8203;(java.lang.String[]&nbsp;arguments,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
<a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback,
<a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a>&nbsp;statisticsCallback)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes FFmpeg with arguments provided.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeAsync(java.lang.String%5B%5D,com.arthenica.ffmpegkit.ExecuteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback,java.util.concurrent.ExecutorService)">executeAsync</a></span>&#8203;(java.lang.String[]&nbsp;arguments,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
<a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback,
<a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a>&nbsp;statisticsCallback,
java.util.concurrent.ExecutorService&nbsp;executorService)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes FFmpeg with arguments provided.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeAsync(java.lang.String%5B%5D,com.arthenica.ffmpegkit.ExecuteCallback,java.util.concurrent.ExecutorService)">executeAsync</a></span>&#8203;(java.lang.String[]&nbsp;arguments,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
java.util.concurrent.ExecutorService&nbsp;executorService)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes FFmpeg with arguments provided.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeAsync(java.lang.String,com.arthenica.ffmpegkit.ExecuteCallback)">executeAsync</a></span>&#8203;(java.lang.String&nbsp;command,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes FFmpeg command provided.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeAsync(java.lang.String,com.arthenica.ffmpegkit.ExecuteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback)">executeAsync</a></span>&#8203;(java.lang.String&nbsp;command,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
<a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback,
<a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a>&nbsp;statisticsCallback)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes FFmpeg command provided.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeAsync(java.lang.String,com.arthenica.ffmpegkit.ExecuteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback,java.util.concurrent.ExecutorService)">executeAsync</a></span>&#8203;(java.lang.String&nbsp;command,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
<a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback,
<a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a>&nbsp;statisticsCallback,
java.util.concurrent.ExecutorService&nbsp;executorService)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes FFmpeg command provided.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeAsync(java.lang.String,com.arthenica.ffmpegkit.ExecuteCallback,java.util.concurrent.ExecutorService)">executeAsync</a></span>&#8203;(java.lang.String&nbsp;command,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
java.util.concurrent.ExecutorService&nbsp;executorService)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes FFmpeg command provided.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static java.util.List&lt;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listSessions()">listSessions</a></span>()</code></th>
<td class="colLast">
<div class="block">Lists all FFmpeg sessions in the session history.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseArguments(java.lang.String)">parseArguments</a></span>&#8203;(java.lang.String&nbsp;command)</code></th>
<td class="colLast">
<div class="block">Parses the given command into arguments.</div>
</td>
</tr>
</table>
<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">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="execute(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;execute&#8203;(java.lang.String[]&nbsp;arguments)</pre>
<div class="block"><p>Synchronously executes FFmpeg with arguments provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - FFmpeg command options/arguments as string array</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpeg session created for this execution</dd>
</dl>
</li>
</ul>
<a id="executeAsync(java.lang.String[],com.arthenica.ffmpegkit.ExecuteCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;executeAsync&#8203;(java.lang.String[]&nbsp;arguments,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback)</pre>
<div class="block"><p>Asynchronously executes FFmpeg with arguments provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - FFmpeg command options/arguments as string array</dd>
<dd><code>executeCallback</code> - callback that will be called when the execution is completed</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpeg session created for this execution</dd>
</dl>
</li>
</ul>
<a id="executeAsync(java.lang.String[],com.arthenica.ffmpegkit.ExecuteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;executeAsync&#8203;(java.lang.String[]&nbsp;arguments,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
<a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback,
<a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a>&nbsp;statisticsCallback)</pre>
<div class="block"><p>Asynchronously executes FFmpeg with arguments provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - FFmpeg command options/arguments as string array</dd>
<dd><code>executeCallback</code> - callback that will be called when the execution is completed</dd>
<dd><code>logCallback</code> - callback that will receive logs</dd>
<dd><code>statisticsCallback</code> - callback that will receive statistics</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpeg session created for this execution</dd>
</dl>
</li>
</ul>
<a id="executeAsync(java.lang.String[],com.arthenica.ffmpegkit.ExecuteCallback,java.util.concurrent.ExecutorService)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;executeAsync&#8203;(java.lang.String[]&nbsp;arguments,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
java.util.concurrent.ExecutorService&nbsp;executorService)</pre>
<div class="block"><p>Asynchronously executes FFmpeg with arguments provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - FFmpeg command options/arguments as string array</dd>
<dd><code>executeCallback</code> - callback that will be called when the execution is completed</dd>
<dd><code>executorService</code> - executor service that will be used to run this asynchronous operation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpeg session created for this execution</dd>
</dl>
</li>
</ul>
<a id="executeAsync(java.lang.String[],com.arthenica.ffmpegkit.ExecuteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback,java.util.concurrent.ExecutorService)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;executeAsync&#8203;(java.lang.String[]&nbsp;arguments,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
<a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback,
<a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a>&nbsp;statisticsCallback,
java.util.concurrent.ExecutorService&nbsp;executorService)</pre>
<div class="block"><p>Asynchronously executes FFmpeg with arguments provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - FFmpeg command options/arguments as string array</dd>
<dd><code>executeCallback</code> - callback that will be called when the execution is 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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpeg session created for this execution</dd>
</dl>
</li>
</ul>
<a id="execute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;execute&#8203;(java.lang.String&nbsp;command)</pre>
<div class="block"><p>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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - FFmpeg command</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpeg session created for this execution</dd>
</dl>
</li>
</ul>
<a id="executeAsync(java.lang.String,com.arthenica.ffmpegkit.ExecuteCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;executeAsync&#8203;(java.lang.String&nbsp;command,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback)</pre>
<div class="block"><p>Asynchronously 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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - FFmpeg command</dd>
<dd><code>executeCallback</code> - callback that will be called when the execution is completed</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpeg session created for this execution</dd>
</dl>
</li>
</ul>
<a id="executeAsync(java.lang.String,com.arthenica.ffmpegkit.ExecuteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;executeAsync&#8203;(java.lang.String&nbsp;command,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
<a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback,
<a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a>&nbsp;statisticsCallback)</pre>
<div class="block"><p>Asynchronously 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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - FFmpeg command</dd>
<dd><code>executeCallback</code> - callback that will be called when the execution is completed</dd>
<dd><code>logCallback</code> - callback that will receive logs</dd>
<dd><code>statisticsCallback</code> - callback that will receive statistics</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpeg session created for this execution</dd>
</dl>
</li>
</ul>
<a id="executeAsync(java.lang.String,com.arthenica.ffmpegkit.ExecuteCallback,java.util.concurrent.ExecutorService)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;executeAsync&#8203;(java.lang.String&nbsp;command,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
java.util.concurrent.ExecutorService&nbsp;executorService)</pre>
<div class="block"><p>Asynchronously 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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - FFmpeg command</dd>
<dd><code>executeCallback</code> - callback that will be called when the execution is completed</dd>
<dd><code>executorService</code> - executor service that will be used to run this asynchronous operation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpeg session created for this execution</dd>
</dl>
</li>
</ul>
<a id="executeAsync(java.lang.String,com.arthenica.ffmpegkit.ExecuteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback,java.util.concurrent.ExecutorService)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAsync</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;executeAsync&#8203;(java.lang.String&nbsp;command,
<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
<a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback,
<a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a>&nbsp;statisticsCallback,
java.util.concurrent.ExecutorService&nbsp;executorService)</pre>
<div class="block"><p>Asynchronously 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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - FFmpeg command</dd>
<dd><code>executeCallback</code> - callback that will be called when the execution is 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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpeg session created for this execution</dd>
</dl>
</li>
</ul>
<a id="cancel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;cancel()</pre>
<div class="block"><p>Cancels all running sessions.
<p>This function does not wait for termination to complete and returns immediately.</div>
</li>
</ul>
<a id="cancel(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;cancel&#8203;(long&nbsp;sessionId)</pre>
<div class="block"><p>Cancels the session specified with <code>sessionId</code>.
<p>This function does not wait for termination to complete and returns immediately.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sessionId</code> - id of the session that will be cancelled</dd>
</dl>
</li>
</ul>
<a id="listSessions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listSessions</h4>
<pre class="methodSignature">public static&nbsp;java.util.List&lt;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&gt;&nbsp;listSessions()</pre>
<div class="block"><p>Lists all FFmpeg sessions in the session history.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all FFmpeg sessions in the session history</dd>
</dl>
</li>
</ul>
<a id="parseArguments(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseArguments</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String[]&nbsp;parseArguments&#8203;(java.lang.String&nbsp;command)</pre>
<div class="block"><p>Parses the given command into arguments. Uses space character to split the arguments.
Supports single and double quote characters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - string command</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>array of arguments</dd>
</dl>
</li>
</ul>
<a id="argumentsToString(java.lang.String[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>argumentsToString</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;argumentsToString&#8203;(java.lang.String[]&nbsp;arguments)</pre>
<div class="block"><p>Concatenates arguments into a string adding a space character between two arguments.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - arguments</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>concatenated string containing all arguments</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<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="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink