antonlyap/ffmpeg-kit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
53bbdcfa16
ffmpeg-kit/docs/android/javadoc/com/arthenica/ffmpegkit/FFmpegSession.html
Taner Sener e04c7498c2 update api documentation
2022-09-17 18:38:44 +01:00

652 lines
32 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>FFmpegSession (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="FFmpegSession (FFmpegKit)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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><a href="#field.summary">Field</a>&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 FFmpegSession" class="title">Class FFmpegSession</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="AbstractSession.html" title="class in com.arthenica.ffmpegkit">com.arthenica.ffmpegkit.AbstractSession</a></li>
<li>
<ul class="inheritance">
<li>com.arthenica.ffmpegkit.FFmpegSession</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">FFmpegSession</span>
extends <a href="AbstractSession.html" title="class in com.arthenica.ffmpegkit">AbstractSession</a>
implements <a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></pre>
<div class="block"><p>An FFmpeg session.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.com.arthenica.ffmpegkit.AbstractSession">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.arthenica.ffmpegkit.<a href="AbstractSession.html" title="class in com.arthenica.ffmpegkit">AbstractSession</a></h3>
<code><a href="AbstractSession.html#arguments">arguments</a>, <a href="AbstractSession.html#createTime">createTime</a>, <a href="AbstractSession.html#DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT">DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT</a>, <a href="AbstractSession.html#endTime">endTime</a>, <a href="AbstractSession.html#failStackTrace">failStackTrace</a>, <a href="AbstractSession.html#future">future</a>, <a href="AbstractSession.html#logCallback">logCallback</a>, <a href="AbstractSession.html#logRedirectionStrategy">logRedirectionStrategy</a>, <a href="AbstractSession.html#logs">logs</a>, <a href="AbstractSession.html#logsLock">logsLock</a>, <a href="AbstractSession.html#returnCode">returnCode</a>, <a href="AbstractSession.html#sessionId">sessionId</a>, <a href="AbstractSession.html#sessionIdGenerator">sessionIdGenerator</a>, <a href="AbstractSession.html#startTime">startTime</a>, <a href="AbstractSession.html#state">state</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addStatistics(com.arthenica.ffmpegkit.Statistics)">addStatistics</a></span>&#8203;(<a href="Statistics.html" title="class in com.arthenica.ffmpegkit">Statistics</a>&nbsp;statistics)</code></th>
<td class="colLast">
<div class="block">Adds a new statistics entry for this session.</div>
</td>
</tr>
<tr id="i1" 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="#create(java.lang.String%5B%5D)">create</a></span>&#8203;(java.lang.String[]&nbsp;arguments)</code></th>
<td class="colLast">
<div class="block">Builds a new FFmpeg session.</div>
</td>
</tr>
<tr id="i2" 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="#create(java.lang.String%5B%5D,com.arthenica.ffmpegkit.FFmpegSessionCompleteCallback)">create</a></span>&#8203;(java.lang.String[]&nbsp;arguments,
<a href="FFmpegSessionCompleteCallback.html" title="interface in com.arthenica.ffmpegkit">FFmpegSessionCompleteCallback</a>&nbsp;completeCallback)</code></th>
<td class="colLast">
<div class="block">Builds a new FFmpeg session.</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="#create(java.lang.String%5B%5D,com.arthenica.ffmpegkit.FFmpegSessionCompleteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback)">create</a></span>&#8203;(java.lang.String[]&nbsp;arguments,
<a href="FFmpegSessionCompleteCallback.html" title="interface in com.arthenica.ffmpegkit">FFmpegSessionCompleteCallback</a>&nbsp;completeCallback,
<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">Builds a new FFmpeg session.</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="#create(java.lang.String%5B%5D,com.arthenica.ffmpegkit.FFmpegSessionCompleteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback,com.arthenica.ffmpegkit.LogRedirectionStrategy)">create</a></span>&#8203;(java.lang.String[]&nbsp;arguments,
<a href="FFmpegSessionCompleteCallback.html" title="interface in com.arthenica.ffmpegkit">FFmpegSessionCompleteCallback</a>&nbsp;completeCallback,
<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,
<a href="LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a>&nbsp;logRedirectionStrategy)</code></th>
<td class="colLast">
<div class="block">Builds a new FFmpeg session.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="Statistics.html" title="class in com.arthenica.ffmpegkit">Statistics</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllStatistics()">getAllStatistics</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns all statistics entries generated for this session.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="Statistics.html" title="class in com.arthenica.ffmpegkit">Statistics</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllStatistics(int)">getAllStatistics</a></span>&#8203;(int&nbsp;waitTimeout)</code></th>
<td class="colLast">
<div class="block">Returns all statistics entries generated for this session.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="FFmpegSessionCompleteCallback.html" title="interface in com.arthenica.ffmpegkit">FFmpegSessionCompleteCallback</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompleteCallback()">getCompleteCallback</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the session specific complete callback.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="Statistics.html" title="class in com.arthenica.ffmpegkit">Statistics</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLastReceivedStatistics()">getLastReceivedStatistics</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the last received statistics entry.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="Statistics.html" title="class in com.arthenica.ffmpegkit">Statistics</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatistics()">getStatistics</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns all statistics entries delivered for this session.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatisticsCallback()">getStatisticsCallback</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the session specific statistics callback.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFFmpeg()">isFFmpeg</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether it is an <code>FFmpeg</code> session or not.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFFprobe()">isFFprobe</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether it is an <code>FFprobe</code> session or not.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMediaInformation()">isMediaInformation</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether it is a <code>MediaInformation</code> session or not.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.arthenica.ffmpegkit.AbstractSession">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.arthenica.ffmpegkit.<a href="AbstractSession.html" title="class in com.arthenica.ffmpegkit">AbstractSession</a></h3>
<code><a href="AbstractSession.html#addLog(com.arthenica.ffmpegkit.Log)">addLog</a>, <a href="AbstractSession.html#cancel()">cancel</a>, <a href="AbstractSession.html#getAllLogs()">getAllLogs</a>, <a href="AbstractSession.html#getAllLogs(int)">getAllLogs</a>, <a href="AbstractSession.html#getAllLogsAsString()">getAllLogsAsString</a>, <a href="AbstractSession.html#getAllLogsAsString(int)">getAllLogsAsString</a>, <a href="AbstractSession.html#getArguments()">getArguments</a>, <a href="AbstractSession.html#getCommand()">getCommand</a>, <a href="AbstractSession.html#getCreateTime()">getCreateTime</a>, <a href="AbstractSession.html#getDuration()">getDuration</a>, <a href="AbstractSession.html#getEndTime()">getEndTime</a>, <a href="AbstractSession.html#getFailStackTrace()">getFailStackTrace</a>, <a href="AbstractSession.html#getFuture()">getFuture</a>, <a href="AbstractSession.html#getLogCallback()">getLogCallback</a>, <a href="AbstractSession.html#getLogRedirectionStrategy()">getLogRedirectionStrategy</a>, <a href="AbstractSession.html#getLogs()">getLogs</a>, <a href="AbstractSession.html#getLogsAsString()">getLogsAsString</a>, <a href="AbstractSession.html#getOutput()">getOutput</a>, <a href="AbstractSession.html#getReturnCode()">getReturnCode</a>, <a href="AbstractSession.html#getSessionId()">getSessionId</a>, <a href="AbstractSession.html#getStartTime()">getStartTime</a>, <a href="AbstractSession.html#getState()">getState</a>, <a href="AbstractSession.html#thereAreAsynchronousMessagesInTransmit()">thereAreAsynchronousMessagesInTransmit</a>, <a href="AbstractSession.html#waitForAsynchronousMessagesInTransmit(int)">waitForAsynchronousMessagesInTransmit</a></code></li>
</ul>
<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, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.arthenica.ffmpegkit.Session">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.arthenica.ffmpegkit.<a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></h3>
<code><a href="Session.html#addLog(com.arthenica.ffmpegkit.Log)">addLog</a>, <a href="Session.html#cancel()">cancel</a>, <a href="Session.html#getAllLogs()">getAllLogs</a>, <a href="Session.html#getAllLogs(int)">getAllLogs</a>, <a href="Session.html#getAllLogsAsString()">getAllLogsAsString</a>, <a href="Session.html#getAllLogsAsString(int)">getAllLogsAsString</a>, <a href="Session.html#getArguments()">getArguments</a>, <a href="Session.html#getCommand()">getCommand</a>, <a href="Session.html#getCreateTime()">getCreateTime</a>, <a href="Session.html#getDuration()">getDuration</a>, <a href="Session.html#getEndTime()">getEndTime</a>, <a href="Session.html#getFailStackTrace()">getFailStackTrace</a>, <a href="Session.html#getFuture()">getFuture</a>, <a href="Session.html#getLogCallback()">getLogCallback</a>, <a href="Session.html#getLogRedirectionStrategy()">getLogRedirectionStrategy</a>, <a href="Session.html#getLogs()">getLogs</a>, <a href="Session.html#getLogsAsString()">getLogsAsString</a>, <a href="Session.html#getOutput()">getOutput</a>, <a href="Session.html#getReturnCode()">getReturnCode</a>, <a href="Session.html#getSessionId()">getSessionId</a>, <a href="Session.html#getStartTime()">getStartTime</a>, <a href="Session.html#getState()">getState</a>, <a href="Session.html#thereAreAsynchronousMessagesInTransmit()">thereAreAsynchronousMessagesInTransmit</a></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="create(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;create&#8203;(java.lang.String[]&nbsp;arguments)</pre>
<div class="block">Builds a new FFmpeg session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - command arguments</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>created session</dd>
</dl>
</li>
</ul>
<a id="create(java.lang.String[],com.arthenica.ffmpegkit.FFmpegSessionCompleteCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;create&#8203;(java.lang.String[]&nbsp;arguments,
<a href="FFmpegSessionCompleteCallback.html" title="interface in com.arthenica.ffmpegkit">FFmpegSessionCompleteCallback</a>&nbsp;completeCallback)</pre>
<div class="block">Builds a new FFmpeg session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - command arguments</dd>
<dd><code>completeCallback</code> - session specific complete callback</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>created session</dd>
</dl>
</li>
</ul>
<a id="create(java.lang.String[],com.arthenica.ffmpegkit.FFmpegSessionCompleteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;create&#8203;(java.lang.String[]&nbsp;arguments,
<a href="FFmpegSessionCompleteCallback.html" title="interface in com.arthenica.ffmpegkit">FFmpegSessionCompleteCallback</a>&nbsp;completeCallback,
<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">Builds a new FFmpeg session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - command arguments</dd>
<dd><code>completeCallback</code> - session specific complete callback</dd>
<dd><code>logCallback</code> - session specific log callback</dd>
<dd><code>statisticsCallback</code> - session specific statistics callback</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>created session</dd>
</dl>
</li>
</ul>
<a id="create(java.lang.String[],com.arthenica.ffmpegkit.FFmpegSessionCompleteCallback,com.arthenica.ffmpegkit.LogCallback,com.arthenica.ffmpegkit.StatisticsCallback,com.arthenica.ffmpegkit.LogRedirectionStrategy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;create&#8203;(java.lang.String[]&nbsp;arguments,
<a href="FFmpegSessionCompleteCallback.html" title="interface in com.arthenica.ffmpegkit">FFmpegSessionCompleteCallback</a>&nbsp;completeCallback,
<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,
<a href="LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a>&nbsp;logRedirectionStrategy)</pre>
<div class="block">Builds a new FFmpeg session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - command arguments</dd>
<dd><code>completeCallback</code> - session specific complete callback</dd>
<dd><code>logCallback</code> - session specific log callback</dd>
<dd><code>statisticsCallback</code> - session specific statistics callback</dd>
<dd><code>logRedirectionStrategy</code> - session specific log redirection strategy</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>created session</dd>
</dl>
</li>
</ul>
<a id="getStatisticsCallback()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatisticsCallback</h4>
<pre class="methodSignature">public&nbsp;<a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a>&nbsp;getStatisticsCallback()</pre>
<div class="block">Returns the session specific statistics callback.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session specific statistics callback</dd>
</dl>
</li>
</ul>
<a id="getCompleteCallback()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompleteCallback</h4>
<pre class="methodSignature">public&nbsp;<a href="FFmpegSessionCompleteCallback.html" title="interface in com.arthenica.ffmpegkit">FFmpegSessionCompleteCallback</a>&nbsp;getCompleteCallback()</pre>
<div class="block">Returns the session specific complete callback.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session specific complete callback</dd>
</dl>
</li>
</ul>
<a id="getAllStatistics(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllStatistics</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="Statistics.html" title="class in com.arthenica.ffmpegkit">Statistics</a>&gt;&nbsp;getAllStatistics&#8203;(int&nbsp;waitTimeout)</pre>
<div class="block">Returns all statistics entries generated for this session. If there are asynchronous
messages that are not delivered yet, this method waits for them until the given timeout.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>waitTimeout</code> - wait timeout for asynchronous messages in milliseconds</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of statistics entries generated for this session</dd>
</dl>
</li>
</ul>
<a id="getAllStatistics()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllStatistics</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="Statistics.html" title="class in com.arthenica.ffmpegkit">Statistics</a>&gt;&nbsp;getAllStatistics()</pre>
<div class="block">Returns all statistics entries generated for this session. If there are asynchronous
messages that are not delivered yet, this method waits for them until
<a href="AbstractSession.html#DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT"><code>AbstractSession.DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT</code></a> expires.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of statistics entries generated for this session</dd>
</dl>
</li>
</ul>
<a id="getStatistics()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatistics</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="Statistics.html" title="class in com.arthenica.ffmpegkit">Statistics</a>&gt;&nbsp;getStatistics()</pre>
<div class="block">Returns all statistics entries delivered for this session. Note that if there are
asynchronous messages that are not delivered yet, this method will not wait for
them and will return immediately.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of statistics entries received for this session</dd>
</dl>
</li>
</ul>
<a id="getLastReceivedStatistics()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastReceivedStatistics</h4>
<pre class="methodSignature">public&nbsp;<a href="Statistics.html" title="class in com.arthenica.ffmpegkit">Statistics</a>&nbsp;getLastReceivedStatistics()</pre>
<div class="block">Returns the last received statistics entry.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the last received statistics entry or null if there are not any statistics entries
received</dd>
</dl>
</li>
</ul>
<a id="addStatistics(com.arthenica.ffmpegkit.Statistics)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addStatistics</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addStatistics&#8203;(<a href="Statistics.html" title="class in com.arthenica.ffmpegkit">Statistics</a>&nbsp;statistics)</pre>
<div class="block">Adds a new statistics entry for this session. It is invoked internally by
<code>FFmpegKit</code> library methods. Must not be used by user applications.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statistics</code> - statistics entry</dd>
</dl>
</li>
</ul>
<a id="isFFmpeg()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFFmpeg</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isFFmpeg()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Session.html#isFFmpeg()">Session</a></code></span></div>
<div class="block">Returns whether it is an <code>FFmpeg</code> session or not.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Session.html#isFFmpeg()">isFFmpeg</a></code>&nbsp;in interface&nbsp;<code><a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if it is an <code>FFmpeg</code> session, false otherwise</dd>
</dl>
</li>
</ul>
<a id="isFFprobe()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFFprobe</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isFFprobe()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Session.html#isFFprobe()">Session</a></code></span></div>
<div class="block">Returns whether it is an <code>FFprobe</code> session or not.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Session.html#isFFprobe()">isFFprobe</a></code>&nbsp;in interface&nbsp;<code><a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if it is an <code>FFprobe</code> session, false otherwise</dd>
</dl>
</li>
</ul>
<a id="isMediaInformation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMediaInformation</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isMediaInformation()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Session.html#isMediaInformation()">Session</a></code></span></div>
<div class="block">Returns whether it is a <code>MediaInformation</code> session or not.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Session.html#isMediaInformation()">isMediaInformation</a></code>&nbsp;in interface&nbsp;<code><a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if it is a <code>MediaInformation</code> session, false otherwise</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></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><a href="#field.summary">Field</a>&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