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

1165 lines
56 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>AbstractSession (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="AbstractSession (FFmpegKit)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/AbiDetect.html" title="class in com.arthenica.ffmpegkit"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/arthenica/ffmpegkit/AsyncFFmpegExecuteTask.html" title="class 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/AbstractSession.html" target="_top">Frames</a></li>
<li><a href="AbstractSession.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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="Class AbstractSession" class="title">Class AbstractSession</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.arthenica.ffmpegkit.AbstractSession</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><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></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractSession</span>
extends java.lang.Object
implements <a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></pre>
<div class="block">Abstract session implementation which includes common features shared by <code>FFmpeg</code>
and <code>FFprobe</code> sessions.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#arguments">arguments</a></span></code>
<div class="block">Command arguments as an array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Date</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#createTime">createTime</a></span></code>
<div class="block">Date and time the session was created.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT">DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT</a></span></code>
<div class="block">Defines how long default "getAll" methods wait, in milliseconds.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Date</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#endTime">endTime</a></span></code>
<div class="block">Date and time the session has ended.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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/AbstractSession.html#executeCallback">executeCallback</a></span></code>
<div class="block">Session specific execute callback function.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#failStackTrace">failStackTrace</a></span></code>
<div class="block">Stack trace of the error received while trying to execute this session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.concurrent.Future&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#future">future</a></span></code>
<div class="block">Future created for sessions executed asynchronously.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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/AbstractSession.html#logCallback">logCallback</a></span></code>
<div class="block">Session specific log callback function.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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/AbstractSession.html#logRedirectionStrategy">logRedirectionStrategy</a></span></code>
<div class="block">Session specific log redirection strategy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected 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/AbstractSession.html#logs">logs</a></span></code>
<div class="block">Log entries received for this session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#logsLock">logsLock</a></span></code>
<div class="block">Log entry lock.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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/AbstractSession.html#returnCode">returnCode</a></span></code>
<div class="block">Return code for the completed sessions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#sessionId">sessionId</a></span></code>
<div class="block">Session identifier.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static java.util.concurrent.atomic.AtomicLong</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#sessionIdGenerator">sessionIdGenerator</a></span></code>
<div class="block">Generates unique ids for sessions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Date</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#startTime">startTime</a></span></code>
<div class="block">Date and time the session was started.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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/AbstractSession.html#state">state</a></span></code>
<div class="block">State of the session.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#AbstractSession-java.lang.String:A-com.arthenica.ffmpegkit.ExecuteCallback-com.arthenica.ffmpegkit.LogCallback-com.arthenica.ffmpegkit.LogRedirectionStrategy-">AbstractSession</a></span>(java.lang.String[]&nbsp;arguments,
<a href="../../../com/arthenica/ffmpegkit/ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
<a href="../../../com/arthenica/ffmpegkit/LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback,
<a href="../../../com/arthenica/ffmpegkit/LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a>&nbsp;logRedirectionStrategy)</code>
<div class="block">Creates a new abstract session.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="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="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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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/AbstractSession.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>
<tr id="i24" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#waitForAsynchronousMessagesInTransmit-int-">waitForAsynchronousMessagesInTransmit</a></span>(int&nbsp;timeout)</code>
<div class="block">Waits for all asynchronous messages to be transmitted until the given timeout.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.arthenica.ffmpegkit.Session">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.arthenica.ffmpegkit.<a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></h3>
<code><a href="../../../com/arthenica/ffmpegkit/Session.html#isFFmpeg--">isFFmpeg</a>, <a href="../../../com/arthenica/ffmpegkit/Session.html#isFFprobe--">isFFprobe</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="sessionIdGenerator">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sessionIdGenerator</h4>
<pre>protected static final&nbsp;java.util.concurrent.atomic.AtomicLong sessionIdGenerator</pre>
<div class="block">Generates unique ids for sessions.</div>
</li>
</ul>
<a name="DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT</h4>
<pre>public static final&nbsp;int DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT</pre>
<div class="block">Defines how long default "getAll" methods wait, in milliseconds.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.arthenica.ffmpegkit.AbstractSession.DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="sessionId">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sessionId</h4>
<pre>protected final&nbsp;long sessionId</pre>
<div class="block">Session identifier.</div>
</li>
</ul>
<a name="executeCallback">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeCallback</h4>
<pre>protected final&nbsp;<a href="../../../com/arthenica/ffmpegkit/ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a> executeCallback</pre>
<div class="block">Session specific execute callback function.</div>
</li>
</ul>
<a name="logCallback">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logCallback</h4>
<pre>protected final&nbsp;<a href="../../../com/arthenica/ffmpegkit/LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a> logCallback</pre>
<div class="block">Session specific log callback function.</div>
</li>
</ul>
<a name="createTime">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTime</h4>
<pre>protected final&nbsp;java.util.Date createTime</pre>
<div class="block">Date and time the session was created.</div>
</li>
</ul>
<a name="startTime">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startTime</h4>
<pre>protected&nbsp;java.util.Date startTime</pre>
<div class="block">Date and time the session was started.</div>
</li>
</ul>
<a name="endTime">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endTime</h4>
<pre>protected&nbsp;java.util.Date endTime</pre>
<div class="block">Date and time the session has ended.</div>
</li>
</ul>
<a name="arguments">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>arguments</h4>
<pre>protected final&nbsp;java.lang.String[] arguments</pre>
<div class="block">Command arguments as an array.</div>
</li>
</ul>
<a name="logs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logs</h4>
<pre>protected final&nbsp;java.util.List&lt;<a href="../../../com/arthenica/ffmpegkit/Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&gt; logs</pre>
<div class="block">Log entries received for this session.</div>
</li>
</ul>
<a name="logsLock">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logsLock</h4>
<pre>protected final&nbsp;java.lang.Object logsLock</pre>
<div class="block">Log entry lock.</div>
</li>
</ul>
<a name="future">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>future</h4>
<pre>protected&nbsp;java.util.concurrent.Future&lt;?&gt; future</pre>
<div class="block">Future created for sessions executed asynchronously.</div>
</li>
</ul>
<a name="state">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>state</h4>
<pre>protected&nbsp;<a href="../../../com/arthenica/ffmpegkit/SessionState.html" title="enum in com.arthenica.ffmpegkit">SessionState</a> state</pre>
<div class="block">State of the session.</div>
</li>
</ul>
<a name="returnCode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>returnCode</h4>
<pre>protected&nbsp;<a href="../../../com/arthenica/ffmpegkit/ReturnCode.html" title="class in com.arthenica.ffmpegkit">ReturnCode</a> returnCode</pre>
<div class="block">Return code for the completed sessions.</div>
</li>
</ul>
<a name="failStackTrace">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>failStackTrace</h4>
<pre>protected&nbsp;java.lang.String failStackTrace</pre>
<div class="block">Stack trace of the error received while trying to execute this session.</div>
</li>
</ul>
<a name="logRedirectionStrategy">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>logRedirectionStrategy</h4>
<pre>protected final&nbsp;<a href="../../../com/arthenica/ffmpegkit/LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a> logRedirectionStrategy</pre>
<div class="block">Session specific log redirection strategy.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractSession-java.lang.String:A-com.arthenica.ffmpegkit.ExecuteCallback-com.arthenica.ffmpegkit.LogCallback-com.arthenica.ffmpegkit.LogRedirectionStrategy-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractSession</h4>
<pre>public&nbsp;AbstractSession(java.lang.String[]&nbsp;arguments,
<a href="../../../com/arthenica/ffmpegkit/ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback,
<a href="../../../com/arthenica/ffmpegkit/LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback,
<a href="../../../com/arthenica/ffmpegkit/LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a>&nbsp;logRedirectionStrategy)</pre>
<div class="block">Creates a new abstract session.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - command arguments</dd>
<dd><code>executeCallback</code> - session specific execute callback function</dd>
<dd><code>logCallback</code> - session specific log callback function</dd>
<dd><code>logRedirectionStrategy</code> - session specific log redirection strategy</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ 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>public&nbsp;<a href="../../../com/arthenica/ffmpegkit/ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;getExecuteCallback()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getExecuteCallback--">Session</a></code></span></div>
<div class="block">Returns the session specific execute callback function.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getExecuteCallback--">getExecuteCallback</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;<a href="../../../com/arthenica/ffmpegkit/LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;getLogCallback()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogCallback--">Session</a></code></span></div>
<div class="block">Returns the session specific log callback function.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogCallback--">getLogCallback</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;long&nbsp;getSessionId()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getSessionId--">Session</a></code></span></div>
<div class="block">Returns the session identifier.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getSessionId--">getSessionId</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;java.util.Date&nbsp;getCreateTime()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getCreateTime--">Session</a></code></span></div>
<div class="block">Returns session create time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getCreateTime--">getCreateTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;java.util.Date&nbsp;getStartTime()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getStartTime--">Session</a></code></span></div>
<div class="block">Returns session start time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getStartTime--">getStartTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;java.util.Date&nbsp;getEndTime()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getEndTime--">Session</a></code></span></div>
<div class="block">Returns session end time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getEndTime--">getEndTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;long&nbsp;getDuration()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getDuration--">Session</a></code></span></div>
<div class="block">Returns the time taken to execute this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getDuration--">getDuration</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;java.lang.String[]&nbsp;getArguments()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getArguments--">Session</a></code></span></div>
<div class="block">Returns command arguments as an array.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getArguments--">getArguments</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;java.lang.String&nbsp;getCommand()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getCommand--">Session</a></code></span></div>
<div class="block">Returns command arguments as a concatenated string.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getCommand--">getCommand</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getAllLogs-int-">Session</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getAllLogs-int-">getAllLogs</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;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 until
<a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT"><code>DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT</code></a> expires.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getAllLogs--">getAllLogs</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogs--">Session</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogs--">getLogs</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;java.lang.String&nbsp;getAllLogsAsString(int&nbsp;waitTimeout)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getAllLogsAsString-int-">Session</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getAllLogsAsString-int-">getAllLogsAsString</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;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 until
<a href="../../../com/arthenica/ffmpegkit/AbstractSession.html#DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT"><code>DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT</code></a> expires.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getAllLogsAsString--">getAllLogsAsString</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></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="getLogsAsString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogsAsString</h4>
<pre>public&nbsp;java.lang.String&nbsp;getLogsAsString()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogsAsString--">Session</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogsAsString--">getLogsAsString</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;java.lang.String&nbsp;getOutput()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getOutput--">Session</a></code></span></div>
<div class="block">Returns the log output generated while running the session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getOutput--">getOutput</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;<a href="../../../com/arthenica/ffmpegkit/SessionState.html" title="enum in com.arthenica.ffmpegkit">SessionState</a>&nbsp;getState()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getState--">Session</a></code></span></div>
<div class="block">Returns the state of the session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getState--">getState</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;<a href="../../../com/arthenica/ffmpegkit/ReturnCode.html" title="class in com.arthenica.ffmpegkit">ReturnCode</a>&nbsp;getReturnCode()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getReturnCode--">Session</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getReturnCode--">getReturnCode</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;java.lang.String&nbsp;getFailStackTrace()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getFailStackTrace--">Session</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getFailStackTrace--">getFailStackTrace</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;<a href="../../../com/arthenica/ffmpegkit/LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a>&nbsp;getLogRedirectionStrategy()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogRedirectionStrategy--">Session</a></code></span></div>
<div class="block">Returns session specific log redirection strategy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getLogRedirectionStrategy--">getLogRedirectionStrategy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;boolean&nbsp;thereAreAsynchronousMessagesInTransmit()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#thereAreAsynchronousMessagesInTransmit--">Session</a></code></span></div>
<div class="block">Returns whether there are still asynchronous messages being transmitted for this
session or not.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#thereAreAsynchronousMessagesInTransmit--">thereAreAsynchronousMessagesInTransmit</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;void&nbsp;addLog(<a href="../../../com/arthenica/ffmpegkit/Log.html" title="class in com.arthenica.ffmpegkit">Log</a>&nbsp;log)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#addLog-com.arthenica.ffmpegkit.Log-">Session</a></code></span></div>
<div class="block">Adds a new log entry for this session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#addLog-com.arthenica.ffmpegkit.Log-">addLog</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<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>public&nbsp;java.util.concurrent.Future&lt;?&gt;&nbsp;getFuture()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#getFuture--">Session</a></code></span></div>
<div class="block">Returns the future created for this session, if it is executed asynchronously.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#getFuture--">getFuture</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>future that runs this session asynchronously</dd>
</dl>
</li>
</ul>
<a name="cancel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre>public&nbsp;void&nbsp;cancel()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html#cancel--">Session</a></code></span></div>
<div class="block">Cancels running the session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/arthenica/ffmpegkit/Session.html#cancel--">cancel</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/arthenica/ffmpegkit/Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></dd>
</dl>
</li>
</ul>
<a name="waitForAsynchronousMessagesInTransmit-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>waitForAsynchronousMessagesInTransmit</h4>
<pre>protected&nbsp;void&nbsp;waitForAsynchronousMessagesInTransmit(int&nbsp;timeout)</pre>
<div class="block">Waits for all asynchronous messages to be transmitted until the given timeout.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - wait timeout in milliseconds</dd>
</dl>
</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/AbiDetect.html" title="class in com.arthenica.ffmpegkit"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/arthenica/ffmpegkit/AsyncFFmpegExecuteTask.html" title="class 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/AbstractSession.html" target="_top">Frames</a></li>
<li><a href="AbstractSession.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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