antonlyap/ffmpeg-kit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
39911c0e79
ffmpeg-kit/docs/android/javadoc/com/arthenica/ffmpegkit/Session.html
Taner Sener 5a3224b357 freeze native 4.5 releases
2021-09-19 21:48:24 +01:00

749 lines
28 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Session (FFmpegKit)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.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 methods = {"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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../com/arthenica/ffmpegkit/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">
<li><a href="../../../com/arthenica/ffmpegkit/ReturnCode.html" title="class in com.arthenica.ffmpegkit"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/arthenica/ffmpegkit/SessionState.html" title="enum in com.arthenica.ffmpegkit"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/arthenica/ffmpegkit/Session.html" target="_top">Frames</a></li>
<li><a href="Session.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.arthenica.ffmpegkit</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><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html" title="class in com.arthenica.ffmpegkit">AbstractSession</a>, <a href="../../../com/arthenica/ffmpegkit/FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>, <a href="../../../com/arthenica/ffmpegkit/FFprobeSession.html" title="class in com.arthenica.ffmpegkit">FFprobeSession</a>, <a href="../../../com/arthenica/ffmpegkit/MediaInformationSession.html" title="class in com.arthenica.ffmpegkit">MediaInformationSession</a></dd>
</dl>
<hr>
<br>
<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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#addLog-com.arthenica.ffmpegkit.Log-">addLog</a></span>(<a href="../../../com/arthenica/ffmpegkit/Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&nbsp;log)</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#cancel--">cancel</a></span>()</code>
<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="../../../com/arthenica/ffmpegkit/Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getAllLogs--">getAllLogs</a></span>()</code>
<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="../../../com/arthenica/ffmpegkit/Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getAllLogs-int-">getAllLogs</a></span>(int&nbsp;waitTimeout)</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getAllLogsAsString--">getAllLogsAsString</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getAllLogsAsString-int-">getAllLogsAsString</a></span>(int&nbsp;waitTimeout)</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getArguments--">getArguments</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getCommand--">getCommand</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getCreateTime--">getCreateTime</a></span>()</code>
<div class="block">Returns session create time.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getDuration--">getDuration</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getEndTime--">getEndTime</a></span>()</code>
<div class="block">Returns session end time.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../com/arthenica/ffmpegkit/ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getExecuteCallback--">getExecuteCallback</a></span>()</code>
<div class="block">Returns the session specific execute callback function.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getFailStackTrace--">getFailStackTrace</a></span>()</code>
<div class="block">Returns the stack trace of the exception received while executing this session.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getFuture--">getFuture</a></span>()</code>
<div class="block">Returns the future created for this session, if it is executed asynchronously.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../com/arthenica/ffmpegkit/LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogCallback--">getLogCallback</a></span>()</code>
<div class="block">Returns the session specific log callback function.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../com/arthenica/ffmpegkit/LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogRedirectionStrategy--">getLogRedirectionStrategy</a></span>()</code>
<div class="block">Returns session specific log redirection strategy.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../com/arthenica/ffmpegkit/Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogs--">getLogs</a></span>()</code>
<div class="block">Returns all log entries delivered for this session.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogsAsString--">getLogsAsString</a></span>()</code>
<div class="block">Returns all log entries delivered for this session as a concatenated string.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getOutput--">getOutput</a></span>()</code>
<div class="block">Returns the log output generated while running the session.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../com/arthenica/ffmpegkit/ReturnCode.html" title="class in com.arthenica.ffmpegkit">ReturnCode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getReturnCode--">getReturnCode</a></span>()</code>
<div class="block">Returns the return code for this session.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getSessionId--">getSessionId</a></span>()</code>
<div class="block">Returns the session identifier.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>java.util.Date</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getStartTime--">getStartTime</a></span>()</code>
<div class="block">Returns session start time.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../com/arthenica/ffmpegkit/SessionState.html" title="enum in com.arthenica.ffmpegkit">SessionState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#getState--">getState</a></span>()</code>
<div class="block">Returns the state of the session.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#isFFmpeg--">isFFmpeg</a></span>()</code>
<div class="block">Returns whether it is an <code>FFmpeg</code> session or not.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#isFFprobe--">isFFprobe</a></span>()</code>
<div class="block">Returns whether it is an <code>FFprobe</code> session or not.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/Session.html#thereAreAsynchronousMessagesInTransmit--">thereAreAsynchronousMessagesInTransmit</a></span>()</code>
<div class="block">Returns whether there are still asynchronous messages being transmitted for this
session or not.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getExecuteCallback--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecuteCallback</h4>
<pre><a href="../../../com/arthenica/ffmpegkit/ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;getExecuteCallback()</pre>
<div class="block">Returns the session specific execute callback function.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session specific execute callback function</dd>
</dl>
</li>
</ul>
<a name="getLogCallback--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogCallback</h4>
<pre><a href="../../../com/arthenica/ffmpegkit/LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;getLogCallback()</pre>
<div class="block">Returns the session specific log callback function.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session specific log callback function</dd>
</dl>
</li>
</ul>
<a name="getSessionId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionId</h4>
<pre>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 name="getCreateTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreateTime</h4>
<pre>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 name="getStartTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartTime</h4>
<pre>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 name="getEndTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndTime</h4>
<pre>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 name="getDuration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDuration</h4>
<pre>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 name="getArguments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArguments</h4>
<pre>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 name="getCommand--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCommand</h4>
<pre>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 name="getAllLogs-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllLogs</h4>
<pre>java.util.List&lt;<a href="../../../com/arthenica/ffmpegkit/Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&gt;&nbsp;getAllLogs(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 name="getAllLogs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllLogs</h4>
<pre>java.util.List&lt;<a href="../../../com/arthenica/ffmpegkit/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 name="getLogs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogs</h4>
<pre>java.util.List&lt;<a href="../../../com/arthenica/ffmpegkit/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 name="getAllLogsAsString-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllLogsAsString</h4>
<pre>java.lang.String&nbsp;getAllLogsAsString(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 name="getAllLogsAsString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllLogsAsString</h4>
<pre>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 name="getLogsAsString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogsAsString</h4>
<pre>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 name="getOutput--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutput</h4>
<pre>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 name="getState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getState</h4>
<pre><a href="../../../com/arthenica/ffmpegkit/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 name="getReturnCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReturnCode</h4>
<pre><a href="../../../com/arthenica/ffmpegkit/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 name="getFailStackTrace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFailStackTrace</h4>
<pre>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 name="getLogRedirectionStrategy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogRedirectionStrategy</h4>
<pre><a href="../../../com/arthenica/ffmpegkit/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 name="thereAreAsynchronousMessagesInTransmit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>thereAreAsynchronousMessagesInTransmit</h4>
<pre>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 name="addLog-com.arthenica.ffmpegkit.Log-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addLog</h4>
<pre>void&nbsp;addLog(<a href="../../../com/arthenica/ffmpegkit/Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&nbsp;log)</pre>
<div class="block">Adds a new log entry for this session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>log</code> - log entry</dd>
</dl>
</li>
</ul>
<a name="getFuture--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFuture</h4>
<pre>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 name="isFFmpeg--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFFmpeg</h4>
<pre>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 name="isFFprobe--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFFprobe</h4>
<pre>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 name="cancel--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cancel</h4>
<pre>void&nbsp;cancel()</pre>
<div class="block">Cancels running the session.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../com/arthenica/ffmpegkit/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">
<li><a href="../../../com/arthenica/ffmpegkit/ReturnCode.html" title="class in com.arthenica.ffmpegkit"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/arthenica/ffmpegkit/SessionState.html" title="enum in com.arthenica.ffmpegkit"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/arthenica/ffmpegkit/Session.html" target="_top">Frames</a></li>
<li><a href="Session.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.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>
</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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink