949 lines
62 KiB
HTML
949 lines
62 KiB
HTML
<!DOCTYPE HTML>
|
||
<!-- NewPage -->
|
||
<html lang="en"><head>
|
||
<title>AbstractSession </title>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
<meta name="dc.created" content="2020-03-25">
|
||
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
||
<link rel="stylesheet" type="text/css" href="../../../dokka-javadoc-stylesheet.css" title="Style">
|
||
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
|
||
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
|
||
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
|
||
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
|
||
|
||
<script type="text/javascript" src="../../../search.js"></script>
|
||
<script async type="text/javascript" src="../../../module-search-index.js"></script>
|
||
<script async type="text/javascript" src="../../../package-search-index.js"></script>
|
||
<script async type="text/javascript" src="../../../type-search-index.js"></script>
|
||
<script async type="text/javascript" src="../../../member-search-index.js"></script>
|
||
<script async type="text/javascript" src="../../../tag-search-index.js"></script>
|
||
</head><body>
|
||
<script type="text/javascript">
|
||
var pathtoroot = "../../../";
|
||
</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="../../../index.html">Overview</a></li>
|
||
|
||
<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.html">Deprecated</a></li>
|
||
<li><a href="../../../index-files/index-1.html">Index</a></li>
|
||
<li>Help</li>
|
||
</ul></div>
|
||
<div class="subNav">
|
||
<ul class="navList" id="allclasses_navbar_top" style="display: block;">
|
||
<li><a href="../../../allclasses.html">All Classes</a></li>
|
||
</ul>
|
||
|
||
<ul class="navListSearch">
|
||
<li><label for="search">SEARCH:</label>
|
||
<input type="text" id="search" value="search" class="ui-autocomplete-input" autocomplete="off" placeholder="Search">
|
||
<input type="reset" id="reset" value="reset">
|
||
</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>
|
||
<a id="skip.navbar.top">
|
||
<!-- -->
|
||
</a></div><!-- ========= END OF TOP NAVBAR ========= -->
|
||
</div>
|
||
<div class="navPadding"> </div>
|
||
<script type="text/javascript"><!--
|
||
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
||
//-->
|
||
</script>
|
||
</nav>
|
||
</header>
|
||
|
||
<main role="main">
|
||
<div class="header">
|
||
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html"></a></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>adaptation.Adaptation</li>
|
||
</ul>
|
||
</li>
|
||
</ul> TODO inheritance tree -->
|
||
<div class="description">
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
|
||
<dl>
|
||
<dt>All Implemented Interfaces:</dt>
|
||
<dd>
|
||
|
||
<code>com.arthenica.ffmpegkit.Session</code>
|
||
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
<hr>
|
||
<pre class="wrap-overflow">
|
||
|
||
public abstract class <span class="typeNameLabel"><a href=AbstractSession.html>AbstractSession</a></span>
|
||
implements <a href=Session.html>Session</a>
|
||
</pre>
|
||
<div class="block"><p>Abstract session implementation which includes common features shared by <code>FFmpeg</code>, <code>FFprobe</code> and <code>MediaInformation</code> sessions.</p></div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="summary">
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||
|
||
<!-- =========== FIELD SUMMARY =========== -->
|
||
|
||
<section role="region">
|
||
<ul class="blockList">
|
||
<li class="blockList"><a id="field.summary">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Field Summary</h3>
|
||
<div class="memberSummary">
|
||
<table>
|
||
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
||
<tr>
|
||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
<th class="colSecond" scope="col">Field</th>
|
||
<th class="colLast" scope="col">Description</th>
|
||
</tr>
|
||
|
||
<tr class="altColor">
|
||
<td class="colFirst"><code>public final static int</code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT>DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="rowColor">
|
||
<td class="colFirst"><code>protected final long</code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#sessionId>sessionId</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="altColor">
|
||
<td class="colFirst"><code>protected final <a href=LogCallback.html>LogCallback</a></code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#logCallback>logCallback</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="rowColor">
|
||
<td class="colFirst"><code>protected final <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a></code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#createTime>createTime</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="altColor">
|
||
<td class="colFirst"><code>protected <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a></code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#startTime>startTime</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="rowColor">
|
||
<td class="colFirst"><code>protected <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a></code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#endTime>endTime</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="altColor">
|
||
<td class="colFirst"><code>protected final <a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a><<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>></code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#arguments>arguments</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="rowColor">
|
||
<td class="colFirst"><code>protected final <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a><<a href=Log.html>Log</a>></code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#logs>logs</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="altColor">
|
||
<td class="colFirst"><code>protected <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/Future.html>Future</a><out <a href=https://developer.android.com/reference/kotlin/java/lang/Object.html>Object</a>></code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#future>future</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="rowColor">
|
||
<td class="colFirst"><code>protected <a href=SessionState.html>SessionState</a></code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#state>state</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="altColor">
|
||
<td class="colFirst"><code>protected <a href=ReturnCode.html>ReturnCode</a></code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#returnCode>returnCode</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="rowColor">
|
||
<td class="colFirst"><code>protected <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#failStackTrace>failStackTrace</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
<tr class="altColor">
|
||
<td class="colFirst"><code>protected final <a href=LogRedirectionStrategy.html>LogRedirectionStrategy</a></code></td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#logRedirectionStrategy>logRedirectionStrategy</a></code></th>
|
||
<td class="colLast"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
|
||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
|
||
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
||
|
||
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
||
<section role="region">
|
||
<ul class="blockList">
|
||
<li class="blockList"><a id="method.summary">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Method Summary</h3>
|
||
<div class="memberSummary">
|
||
<div role="tablist" aria-orientation="horizontal">
|
||
<button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button>
|
||
<!-- TODO: Instance and Concrete Methods #1118 -->
|
||
</div>
|
||
<div id="memberSummary_tabpanel" role="tabpanel">
|
||
<table aria-labelledby="t0">
|
||
<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>long</code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getSessionId()>getSessionId</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns the session identifier.</td>
|
||
</tr>
|
||
|
||
<tr id="i1" class="rowColor">
|
||
<td class="colFirst"><code><a href=LogCallback.html>LogCallback</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getLogCallback()>getLogCallback</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns the session specific log callback.</td>
|
||
</tr>
|
||
|
||
<tr id="i2" class="altColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getCreateTime()>getCreateTime</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns session create time.</td>
|
||
</tr>
|
||
|
||
<tr id="i3" class="rowColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getStartTime()>getStartTime</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns session start time.</td>
|
||
</tr>
|
||
|
||
<tr id="i4" class="altColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getEndTime()>getEndTime</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns session end time.</td>
|
||
</tr>
|
||
|
||
<tr id="i5" class="rowColor">
|
||
<td class="colFirst"><code><a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a><<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getArguments()>getArguments</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns command arguments as an array.</td>
|
||
</tr>
|
||
|
||
<tr id="i6" class="altColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a><<a href=Log.html>Log</a>></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getLogs()>getLogs</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns all log entries delivered for this session.</td>
|
||
</tr>
|
||
|
||
<tr id="i7" class="rowColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/util/concurrent/Future.html>Future</a><out <a href=https://developer.android.com/reference/kotlin/java/lang/Object.html>Object</a>></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getFuture()>getFuture</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns the future created for this session, if it is executed asynchronously.</td>
|
||
</tr>
|
||
|
||
<tr id="i8" class="altColor">
|
||
<td class="colFirst"><code>void</code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#setFuture(Future)>setFuture</a>(<a href=https://developer.android.com/reference/kotlin/java/util/concurrent/Future.html>Future</a><out <a href=https://developer.android.com/reference/kotlin/java/lang/Object.html>Object</a>> future) </code>
|
||
</th>
|
||
<td class="colLast">Sets the future created for this session.</td>
|
||
</tr>
|
||
|
||
<tr id="i9" class="rowColor">
|
||
<td class="colFirst"><code><a href=SessionState.html>SessionState</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getState()>getState</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns the state of the session.</td>
|
||
</tr>
|
||
|
||
<tr id="i10" class="altColor">
|
||
<td class="colFirst"><code><a href=ReturnCode.html>ReturnCode</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getReturnCode()>getReturnCode</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns the return code for this session.</td>
|
||
</tr>
|
||
|
||
<tr id="i11" class="rowColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getFailStackTrace()>getFailStackTrace</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns the stack trace of the exception received while executing this session.</td>
|
||
</tr>
|
||
|
||
<tr id="i12" class="altColor">
|
||
<td class="colFirst"><code><a href=LogRedirectionStrategy.html>LogRedirectionStrategy</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getLogRedirectionStrategy()>getLogRedirectionStrategy</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns session specific log redirection strategy.</td>
|
||
</tr>
|
||
|
||
<tr id="i13" class="rowColor">
|
||
<td class="colFirst"><code>long</code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getDuration()>getDuration</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns the time taken to execute this session.</td>
|
||
</tr>
|
||
|
||
<tr id="i14" class="altColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getCommand()>getCommand</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns command arguments as a concatenated string.</td>
|
||
</tr>
|
||
|
||
<tr id="i15" class="rowColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a><<a href=Log.html>Log</a>></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getAllLogs(int)>getAllLogs</a>(int waitTimeout) </code>
|
||
</th>
|
||
<td class="colLast">Returns all log entries generated for this session.</td>
|
||
</tr>
|
||
|
||
<tr id="i16" class="altColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a><<a href=Log.html>Log</a>></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getAllLogs()>getAllLogs</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns all log entries generated for this session.</td>
|
||
</tr>
|
||
|
||
<tr id="i17" class="rowColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getAllLogsAsString(int)>getAllLogsAsString</a>(int waitTimeout) </code>
|
||
</th>
|
||
<td class="colLast">Returns all log entries generated for this session as a concatenated string.</td>
|
||
</tr>
|
||
|
||
<tr id="i18" class="altColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getAllLogsAsString()>getAllLogsAsString</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns all log entries generated for this session as a concatenated string.</td>
|
||
</tr>
|
||
|
||
<tr id="i19" class="rowColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getLogsAsString()>getLogsAsString</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns all log entries delivered for this session as a concatenated string.</td>
|
||
</tr>
|
||
|
||
<tr id="i20" class="altColor">
|
||
<td class="colFirst"><code><a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#getOutput()>getOutput</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns the log output generated while running the session.</td>
|
||
</tr>
|
||
|
||
<tr id="i21" class="rowColor">
|
||
<td class="colFirst"><code>boolean</code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#thereAreAsynchronousMessagesInTransmit()>thereAreAsynchronousMessagesInTransmit</a>() </code>
|
||
</th>
|
||
<td class="colLast">Returns whether there are still asynchronous messages being transmitted for thissession or not.</td>
|
||
</tr>
|
||
|
||
<tr id="i22" class="altColor">
|
||
<td class="colFirst"><code>void</code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#addLog(Log)>addLog</a>(<a href=Log.html>Log</a> log) </code>
|
||
</th>
|
||
<td class="colLast">Adds a new log entry for this session.</td>
|
||
</tr>
|
||
|
||
<tr id="i23" class="rowColor">
|
||
<td class="colFirst"><code>void</code>
|
||
</td>
|
||
<th class="colSecond" scope="row"><code><a href=AbstractSession.html#cancel()>cancel</a>() </code>
|
||
</th>
|
||
<td class="colLast">Cancels running the session.</td>
|
||
</tr>
|
||
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<ul class="blockList">
|
||
|
||
<li class="blockList"><a id="methods.inherited.from.class.com.arthenica.ffmpegkit.Session">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Methods inherited from class com.arthenica.ffmpegkit.Session</h3>
|
||
<code>isFFmpeg, isFFprobe, isMediaInformation</code></li>
|
||
|
||
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Methods inherited from class java.lang.Object</h3>
|
||
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString,
|
||
wait, wait, wait</code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="details">
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
||
<!-- ============ METHOD DETAIL ========== -->
|
||
|
||
<section role="region">
|
||
<ul class="blockList">
|
||
<li class="blockList"><a id="method.detail">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Method Detail</h3>
|
||
|
||
<a id="getSessionId()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getSessionId</h4>
|
||
<pre class="methodSignature"> long <a href=AbstractSession.html#getSessionId()>getSessionId</a>()</pre>
|
||
<div class="block"><p>Returns the session identifier.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getLogCallback()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getLogCallback</h4>
|
||
<pre class="methodSignature"> <a href=LogCallback.html>LogCallback</a> <a href=AbstractSession.html#getLogCallback()>getLogCallback</a>()</pre>
|
||
<div class="block"><p>Returns the session specific log callback.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getCreateTime()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getCreateTime</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a> <a href=AbstractSession.html#getCreateTime()>getCreateTime</a>()</pre>
|
||
<div class="block"><p>Returns session create time.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getStartTime()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getStartTime</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a> <a href=AbstractSession.html#getStartTime()>getStartTime</a>()</pre>
|
||
<div class="block"><p>Returns session start time.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getEndTime()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getEndTime</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a> <a href=AbstractSession.html#getEndTime()>getEndTime</a>()</pre>
|
||
<div class="block"><p>Returns session end time.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getArguments()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getArguments</h4>
|
||
<pre class="methodSignature"> <a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a><<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>> <a href=AbstractSession.html#getArguments()>getArguments</a>()</pre>
|
||
<div class="block"><p>Returns command arguments as an array.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getLogs()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getLogs</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a><<a href=Log.html>Log</a>> <a href=AbstractSession.html#getLogs()>getLogs</a>()</pre>
|
||
<div class="block"><p>Returns all log entries delivered for this session. Note that if there are asynchronous logmessages that are not delivered yet, this method will not wait for them and will returnimmediately.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getFuture()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getFuture</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/Future.html>Future</a><out <a href=https://developer.android.com/reference/kotlin/java/lang/Object.html>Object</a>> <a href=AbstractSession.html#getFuture()>getFuture</a>()</pre>
|
||
<div class="block"><p>Returns the future created for this session, if it is executed asynchronously.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="setFuture(Future)">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>setFuture</h4>
|
||
<pre class="methodSignature"> void <a href=AbstractSession.html#setFuture(Future)>setFuture</a>(<a href=https://developer.android.com/reference/kotlin/java/util/concurrent/Future.html>Future</a><out <a href=https://developer.android.com/reference/kotlin/java/lang/Object.html>Object</a>> future)</pre>
|
||
<div class="block"><p>Sets the future created for this session.</p></div>
|
||
|
||
<dl>
|
||
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
||
|
||
<dd><code>future</code> - future that runs this session asynchronously</dd>
|
||
|
||
|
||
</dl>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getState()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getState</h4>
|
||
<pre class="methodSignature"> <a href=SessionState.html>SessionState</a> <a href=AbstractSession.html#getState()>getState</a>()</pre>
|
||
<div class="block"><p>Returns the state of the session.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getReturnCode()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getReturnCode</h4>
|
||
<pre class="methodSignature"> <a href=ReturnCode.html>ReturnCode</a> <a href=AbstractSession.html#getReturnCode()>getReturnCode</a>()</pre>
|
||
<div class="block"><p>Returns the return code for this session. Note that return code is only set for sessionsthat end with COMPLETED state. If a session is not started, still running or failed thenthis method returns null.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getFailStackTrace()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getFailStackTrace</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=AbstractSession.html#getFailStackTrace()>getFailStackTrace</a>()</pre>
|
||
<div class="block"><p>Returns the stack trace of the exception received while executing this session.</p><p>The stack trace is only set for sessions that end with FAILED state. For sessions that hasCOMPLETED state this method returns null.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getLogRedirectionStrategy()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getLogRedirectionStrategy</h4>
|
||
<pre class="methodSignature"> <a href=LogRedirectionStrategy.html>LogRedirectionStrategy</a> <a href=AbstractSession.html#getLogRedirectionStrategy()>getLogRedirectionStrategy</a>()</pre>
|
||
<div class="block"><p>Returns session specific log redirection strategy.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getDuration()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getDuration</h4>
|
||
<pre class="methodSignature"> long <a href=AbstractSession.html#getDuration()>getDuration</a>()</pre>
|
||
<div class="block"><p>Returns the time taken to execute this session.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getCommand()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getCommand</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=AbstractSession.html#getCommand()>getCommand</a>()</pre>
|
||
<div class="block"><p>Returns command arguments as a concatenated string.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getAllLogs(int)">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getAllLogs</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a><<a href=Log.html>Log</a>> <a href=AbstractSession.html#getAllLogs(int)>getAllLogs</a>(int waitTimeout)</pre>
|
||
<div class="block"><p>Returns all log entries generated for this session. If there are asynchronousmessages that are not delivered yet, this method waits for them until the given timeout.</p></div>
|
||
|
||
<dl>
|
||
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
||
|
||
<dd><code>waitTimeout</code> - wait timeout for asynchronous messages in milliseconds</dd>
|
||
|
||
|
||
</dl>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getAllLogs()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getAllLogs</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a><<a href=Log.html>Log</a>> <a href=AbstractSession.html#getAllLogs()>getAllLogs</a>()</pre>
|
||
<div class="block"><p>Returns all log entries generated for this session. If there are asynchronousmessages that are not delivered yet, this method waits for them until <a href=AbstractSession.html#DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT>DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT</a> expires.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getAllLogsAsString(int)">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getAllLogsAsString</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=AbstractSession.html#getAllLogsAsString(int)>getAllLogsAsString</a>(int waitTimeout)</pre>
|
||
<div class="block"><p>Returns all log entries generated for this session as a concatenated string. If there areasynchronous messages that are not delivered yet, this method waits for them untilthe given timeout.</p></div>
|
||
|
||
<dl>
|
||
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
||
|
||
<dd><code>waitTimeout</code> - wait timeout for asynchronous messages in milliseconds</dd>
|
||
|
||
|
||
</dl>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getAllLogsAsString()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getAllLogsAsString</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=AbstractSession.html#getAllLogsAsString()>getAllLogsAsString</a>()</pre>
|
||
<div class="block"><p>Returns all log entries generated for this session as a concatenated string. If there areasynchronous messages that are not delivered yet, this method waits for them until <a href=AbstractSession.html#DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT>DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT</a> expires.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getLogsAsString()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getLogsAsString</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=AbstractSession.html#getLogsAsString()>getLogsAsString</a>()</pre>
|
||
<div class="block"><p>Returns all log entries delivered for this session as a concatenated string. Note that ifthere are asynchronous log messages that are not delivered yet, this method will not waitfor them and will return immediately.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="getOutput()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>getOutput</h4>
|
||
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=AbstractSession.html#getOutput()>getOutput</a>()</pre>
|
||
<div class="block"><p>Returns the log output generated while running the session.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="thereAreAsynchronousMessagesInTransmit()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>thereAreAsynchronousMessagesInTransmit</h4>
|
||
<pre class="methodSignature"> boolean <a href=AbstractSession.html#thereAreAsynchronousMessagesInTransmit()>thereAreAsynchronousMessagesInTransmit</a>()</pre>
|
||
<div class="block"><p>Returns whether there are still asynchronous messages being transmitted for thissession or not.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="addLog(Log)">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockList"
|
||
>
|
||
<li class="blockList">
|
||
<h4>addLog</h4>
|
||
<pre class="methodSignature"> void <a href=AbstractSession.html#addLog(Log)>addLog</a>(<a href=Log.html>Log</a> log)</pre>
|
||
<div class="block"><p>Adds a new log entry for this session.</p><p>It is invoked internally by <code>FFmpegKit</code> library methods. Must not be used by userapplications.</p></div>
|
||
|
||
<dl>
|
||
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
||
|
||
<dd><code>log</code> - log entry</dd>
|
||
|
||
|
||
</dl>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
<a id="cancel()">
|
||
<!-- -->
|
||
</a>
|
||
<ul class=
|
||
"blockListLast"
|
||
>
|
||
<li class="blockList">
|
||
<h4>cancel</h4>
|
||
<pre class="methodSignature"> void <a href=AbstractSession.html#cancel()>cancel</a>()</pre>
|
||
<div class="block"><p>Cancels running the session.</p></div>
|
||
|
||
<!-- TODO missing return annotation -->
|
||
</li>
|
||
</ul>
|
||
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</main>
|
||
<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="../../../index.html">Overview</a></li>
|
||
|
||
<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.html">Deprecated</a></li>
|
||
<li><a href="../../../index-files/index-1.html">Index</a></li>
|
||
<li>Help</li>
|
||
</ul></div>
|
||
<a id="skip.navbar.bottom">
|
||
<!-- -->
|
||
</a>
|
||
<div class="subNav">
|
||
<ul class="navList" id="allclasses_navbar_top" style="display: block;">
|
||
<li><a href="../../../allclasses.html">All 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>
|
||
<noscript>
|
||
<div>JavaScript is disabled on your browser.</div>
|
||
</noscript>
|
||
</div>
|
||
<a id="skip.navbar.top">
|
||
<!-- -->
|
||
</a></div><!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
</nav>
|
||
</footer><ul class="ui-autocomplete ui-front ui-menu ui-widget ui-widget-content" id="ui-id-1" tabindex="0"
|
||
style="display: none;"></ul>
|
||
<span role="status" aria-live="assertive" aria-relevant="additions" class="ui-helper-hidden-accessible"></span>
|
||
</body>
|
||
</html>
|