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

806 lines
28 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Session (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="Session (FFmpegKit)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="Interface Session" class="title">Interface Session</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AbstractSession.html" title="class in com.arthenica.ffmpegkit">AbstractSession</a></code>, <code><a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a></code>, <code><a href="FFprobeSession.html" title="class in com.arthenica.ffmpegkit">FFprobeSession</a></code>, <code><a href="MediaInformationSession.html" title="class in com.arthenica.ffmpegkit">MediaInformationSession</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Session</span></pre>
<div class="block"><p>Common interface for all <code>FFmpegKit</code> sessions.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="#addLog(com.arthenica.ffmpegkit.Log)">addLog</a></span>&#8203;(<a href="Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&nbsp;log)</code></th>
<td class="colLast">
<div class="block">Adds a new log entry for this session.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>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 running the session.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllLogs()">getAllLogs</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns all log entries generated for this session.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllLogs(int)">getAllLogs</a></span>&#8203;(int&nbsp;waitTimeout)</code></th>
<td class="colLast">
<div class="block">Returns all log entries generated for this session.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllLogsAsString()">getAllLogsAsString</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns all log entries generated for this session as a concatenated string.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllLogsAsString(int)">getAllLogsAsString</a></span>&#8203;(int&nbsp;waitTimeout)</code></th>
<td class="colLast">
<div class="block">Returns all log entries generated for this session as a concatenated string.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArguments()">getArguments</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns command arguments as an array.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCommand()">getCommand</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns command arguments as a concatenated string.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.Date</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCreateTime()">getCreateTime</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns session create time.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDuration()">getDuration</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the time taken to execute this session.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.util.Date</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEndTime()">getEndTime</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns session end time.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFailStackTrace()">getFailStackTrace</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the stack trace of the exception received while executing this session.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFuture()">getFuture</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the future created for this session, if it is executed asynchronously.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogCallback()">getLogCallback</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the session specific log callback.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogRedirectionStrategy()">getLogRedirectionStrategy</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns session specific log redirection strategy.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogs()">getLogs</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns all log entries delivered for this session.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogsAsString()">getLogsAsString</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns all log entries delivered for this session as a concatenated string.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutput()">getOutput</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the log output generated while running the session.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="ReturnCode.html" title="class in com.arthenica.ffmpegkit">ReturnCode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReturnCode()">getReturnCode</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the return code for this session.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionId()">getSessionId</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the session identifier.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.util.Date</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStartTime()">getStartTime</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns session start time.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="SessionState.html" title="enum in com.arthenica.ffmpegkit">SessionState</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getState()">getState</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the state of the session.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<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="i23" class="rowColor">
<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="i24" class="altColor">
<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="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#thereAreAsynchronousMessagesInTransmit()">thereAreAsynchronousMessagesInTransmit</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether there are still asynchronous messages being transmitted for this
session or not.</div>
</td>
</tr>
</table>
</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="getLogCallback()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogCallback</h4>
<pre class="methodSignature"><a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;getLogCallback()</pre>
<div class="block">Returns the session specific log callback.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session specific log callback</dd>
</dl>
</li>
</ul>
<a id="getSessionId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionId</h4>
<pre class="methodSignature">long&nbsp;getSessionId()</pre>
<div class="block">Returns the session identifier.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session identifier</dd>
</dl>
</li>
</ul>
<a id="getCreateTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreateTime</h4>
<pre class="methodSignature">java.util.Date&nbsp;getCreateTime()</pre>
<div class="block">Returns session create time.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session create time</dd>
</dl>
</li>
</ul>
<a id="getStartTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartTime</h4>
<pre class="methodSignature">java.util.Date&nbsp;getStartTime()</pre>
<div class="block">Returns session start time.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session start time</dd>
</dl>
</li>
</ul>
<a id="getEndTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndTime</h4>
<pre class="methodSignature">java.util.Date&nbsp;getEndTime()</pre>
<div class="block">Returns session end time.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session end time</dd>
</dl>
</li>
</ul>
<a id="getDuration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDuration</h4>
<pre class="methodSignature">long&nbsp;getDuration()</pre>
<div class="block">Returns the time taken to execute this session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>time taken to execute this session in milliseconds or zero (0) if the session is
not over yet</dd>
</dl>
</li>
</ul>
<a id="getArguments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArguments</h4>
<pre class="methodSignature">java.lang.String[]&nbsp;getArguments()</pre>
<div class="block">Returns command arguments as an array.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>command arguments as an array</dd>
</dl>
</li>
</ul>
<a id="getCommand()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCommand</h4>
<pre class="methodSignature">java.lang.String&nbsp;getCommand()</pre>
<div class="block">Returns command arguments as a concatenated string.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>command arguments as a concatenated string</dd>
</dl>
</li>
</ul>
<a id="getAllLogs(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllLogs</h4>
<pre class="methodSignature">java.util.List&lt;<a href="Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&gt;&nbsp;getAllLogs&#8203;(int&nbsp;waitTimeout)</pre>
<div class="block">Returns all log 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 log entries generated for this session</dd>
</dl>
</li>
</ul>
<a id="getAllLogs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllLogs</h4>
<pre class="methodSignature">java.util.List&lt;<a href="Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&gt;&nbsp;getAllLogs()</pre>
<div class="block">Returns all log entries generated for this session. If there are asynchronous
messages that are not delivered yet, this method waits for them.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of log entries generated for this session</dd>
</dl>
</li>
</ul>
<a id="getLogs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogs</h4>
<pre class="methodSignature">java.util.List&lt;<a href="Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&gt;&nbsp;getLogs()</pre>
<div class="block">Returns all log entries delivered for this session. Note that if there are asynchronous log
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 log entries received for this session</dd>
</dl>
</li>
</ul>
<a id="getAllLogsAsString(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllLogsAsString</h4>
<pre class="methodSignature">java.lang.String&nbsp;getAllLogsAsString&#8203;(int&nbsp;waitTimeout)</pre>
<div class="block">Returns all log entries generated for this session as a concatenated string. 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>all log entries generated for this session as a concatenated string</dd>
</dl>
</li>
</ul>
<a id="getAllLogsAsString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllLogsAsString</h4>
<pre class="methodSignature">java.lang.String&nbsp;getAllLogsAsString()</pre>
<div class="block">Returns all log entries generated for this session as a concatenated string. If there are
asynchronous messages that are not delivered yet, this method waits for them.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all log entries generated for this session as a concatenated string</dd>
</dl>
</li>
</ul>
<a id="getLogsAsString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogsAsString</h4>
<pre class="methodSignature">java.lang.String&nbsp;getLogsAsString()</pre>
<div class="block">Returns all log entries delivered for this session as a concatenated string. Note that if
there are asynchronous log 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 log entries received for this session</dd>
</dl>
</li>
</ul>
<a id="getOutput()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutput</h4>
<pre class="methodSignature">java.lang.String&nbsp;getOutput()</pre>
<div class="block">Returns the log output generated while running the session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>log output generated</dd>
</dl>
</li>
</ul>
<a id="getState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getState</h4>
<pre class="methodSignature"><a href="SessionState.html" title="enum in com.arthenica.ffmpegkit">SessionState</a>&nbsp;getState()</pre>
<div class="block">Returns the state of the session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>state of the session</dd>
</dl>
</li>
</ul>
<a id="getReturnCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReturnCode</h4>
<pre class="methodSignature"><a href="ReturnCode.html" title="class in com.arthenica.ffmpegkit">ReturnCode</a>&nbsp;getReturnCode()</pre>
<div class="block">Returns the return code for this session. Note that return code is only set for sessions
that end with COMPLETED state. If a session is not started, still running or failed then
this method returns null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the return code for this session if the session is COMPLETED, null if session is
not started, still running or failed</dd>
</dl>
</li>
</ul>
<a id="getFailStackTrace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFailStackTrace</h4>
<pre class="methodSignature">java.lang.String&nbsp;getFailStackTrace()</pre>
<div class="block">Returns the stack trace of the exception received while executing this session.
<p>
The stack trace is only set for sessions that end with FAILED state. For sessions that has
COMPLETED state this method returns null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>stack trace of the exception received while executing this session, null if session
is not started, still running or completed</dd>
</dl>
</li>
</ul>
<a id="getLogRedirectionStrategy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogRedirectionStrategy</h4>
<pre class="methodSignature"><a href="LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a>&nbsp;getLogRedirectionStrategy()</pre>
<div class="block">Returns session specific log redirection strategy.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session specific log redirection strategy</dd>
</dl>
</li>
</ul>
<a id="thereAreAsynchronousMessagesInTransmit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>thereAreAsynchronousMessagesInTransmit</h4>
<pre class="methodSignature">boolean&nbsp;thereAreAsynchronousMessagesInTransmit()</pre>
<div class="block">Returns whether there are still asynchronous messages being transmitted for this
session or not.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if there are still asynchronous messages being transmitted, false
otherwise</dd>
</dl>
</li>
</ul>
<a id="addLog(com.arthenica.ffmpegkit.Log)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addLog</h4>
<pre class="methodSignature">void&nbsp;addLog&#8203;(<a href="Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&nbsp;log)</pre>
<div class="block">Adds a new log entry for this session.
<p>
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>log</code> - log entry</dd>
</dl>
</li>
</ul>
<a id="getFuture()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFuture</h4>
<pre class="methodSignature">java.util.concurrent.Future&lt;?&gt;&nbsp;getFuture()</pre>
<div class="block">Returns the future created for this session, if it is executed asynchronously.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>future that runs this session asynchronously</dd>
</dl>
</li>
</ul>
<a id="isFFmpeg()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFFmpeg</h4>
<pre class="methodSignature">boolean&nbsp;isFFmpeg()</pre>
<div class="block">Returns whether it is an <code>FFmpeg</code> session or not.</div>
<dl>
<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">boolean&nbsp;isFFprobe()</pre>
<div class="block">Returns whether it is an <code>FFprobe</code> session or not.</div>
<dl>
<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">boolean&nbsp;isMediaInformation()</pre>
<div class="block">Returns whether it is a <code>MediaInformation</code> session or not.</div>
<dl>
<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="cancel()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cancel</h4>
<pre class="methodSignature">void&nbsp;cancel()</pre>
<div class="block">Cancels running the session.</div>
</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