ffmpeg-kit/docs/android/javadoc/com/arthenica/ffmpegkit/Session.html

871 lines
54 KiB
HTML
Raw Normal View History

2022-09-17 20:29:42 +03:00
<!DOCTYPE HTML>
2021-03-02 01:25:17 +02:00
<!-- NewPage -->
2023-08-22 23:00:49 +03:00
<html lang="en"><head>
<title>Session </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">
2022-09-17 20:29:42 +03:00
var pathtoroot = "../../../";
2023-08-22 23:00:49 +03:00
</script>
2021-03-02 01:25:17 +02:00
<noscript>
2023-08-22 23:00:49 +03:00
<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</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&nbsp;Classes</a></li>
</ul>
2022-09-17 20:29:42 +03:00
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
2023-08-22 23:00:49 +03:00
<input type="text" id="search" value="search" class="ui-autocomplete-input" autocomplete="off" placeholder="Search">
<input type="reset" id="reset" value="reset">
2022-09-17 20:29:42 +03:00
</li>
2021-03-02 01:25:17 +02:00
</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>
2022-09-17 20:29:42 +03:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2021-03-02 01:25:17 +02:00
</div>
2022-09-17 20:29:42 +03:00
<a id="skip.navbar.top">
2021-03-02 01:25:17 +02:00
<!-- -->
2023-08-22 23:00:49 +03:00
</a></div><!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
2022-09-17 20:29:42 +03:00
</header>
2023-08-22 23:00:49 +03:00
2022-09-17 20:29:42 +03:00
<main role="main">
2023-08-22 23:00:49 +03:00
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html"></a></div>
<h2 title="Interface Session" class="title">Interface Session</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">
<hr>
<pre class="wrap-overflow">
public interface <span class="typeNameLabel"><a href=Session.html>Session</a></span>
</pre>
<div class="block"><p>Common interface for all <code>FFmpegKit</code> sessions.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== 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>abstract <a href=LogCallback.html>LogCallback</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getLogCallback()>getLogCallback</a>() </code>
</th>
<td class="colLast">Returns the session specific log callback.</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract long</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getSessionId()>getSessionId</a>() </code>
</th>
<td class="colLast">Returns the session identifier.</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getCreateTime()>getCreateTime</a>() </code>
</th>
<td class="colLast">Returns session create time.</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getStartTime()>getStartTime</a>() </code>
</th>
<td class="colLast">Returns session start time.</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getEndTime()>getEndTime</a>() </code>
</th>
<td class="colLast">Returns session end time.</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract long</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getDuration()>getDuration</a>() </code>
</th>
<td class="colLast">Returns the time taken to execute this session.</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract <a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt;</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getArguments()>getArguments</a>() </code>
</th>
<td class="colLast">Returns command arguments as an array.</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getCommand()>getCommand</a>() </code>
</th>
<td class="colLast">Returns command arguments as a concatenated string.</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a>&lt;<a href=Log.html>Log</a>&gt;</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getAllLogs(int)>getAllLogs</a>(int waitTimeout) </code>
</th>
<td class="colLast">Returns all log entries generated for this session.</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a>&lt;<a href=Log.html>Log</a>&gt;</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getAllLogs()>getAllLogs</a>() </code>
</th>
<td class="colLast">Returns all log entries generated for this session.</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a>&lt;<a href=Log.html>Log</a>&gt;</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getLogs()>getLogs</a>() </code>
</th>
<td class="colLast">Returns all log entries delivered for this session.</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.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="i12" class="altColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.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="i13" class="rowColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.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="i14" class="altColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getOutput()>getOutput</a>() </code>
</th>
<td class="colLast">Returns the log output generated while running the session.</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>abstract <a href=SessionState.html>SessionState</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getState()>getState</a>() </code>
</th>
<td class="colLast">Returns the state of the session.</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>abstract <a href=ReturnCode.html>ReturnCode</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getReturnCode()>getReturnCode</a>() </code>
</th>
<td class="colLast">Returns the return code for this session.</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.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="i18" class="altColor">
<td class="colFirst"><code>abstract <a href=LogRedirectionStrategy.html>LogRedirectionStrategy</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#getLogRedirectionStrategy()>getLogRedirectionStrategy</a>() </code>
</th>
<td class="colLast">Returns session specific log redirection strategy.</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>abstract boolean</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.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="i20" class="altColor">
<td class="colFirst"><code>abstract void</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.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="i21" class="rowColor">
<td class="colFirst"><code>abstract <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/Future.html>Future</a>&lt;out <a href=https://developer.android.com/reference/kotlin/java/lang/Object.html>Object</a>&gt;</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.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="i22" class="altColor">
<td class="colFirst"><code>abstract boolean</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#isFFmpeg()>isFFmpeg</a>() </code>
</th>
<td class="colLast">Returns whether it is an <code>FFmpeg</code> session or not.</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>abstract boolean</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#isFFprobe()>isFFprobe</a>() </code>
</th>
<td class="colLast">Returns whether it is an <code>FFprobe</code> session or not.</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>abstract boolean</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.html#isMediaInformation()>isMediaInformation</a>() </code>
</th>
<td class="colLast">Returns whether it is a <code>MediaInformation</code> session or not.</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>abstract void</code>
</td>
<th class="colSecond" scope="row"><code><a href=Session.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.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>
</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="getLogCallback()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getLogCallback</h4>
<pre class="methodSignature"> abstract <a href=LogCallback.html>LogCallback</a> <a href=Session.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="getSessionId()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getSessionId</h4>
<pre class="methodSignature"> abstract long <a href=Session.html#getSessionId()>getSessionId</a>()</pre>
<div class="block"><p>Returns the session identifier.</p></div>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="getCreateTime()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getCreateTime</h4>
<pre class="methodSignature"> abstract <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a> <a href=Session.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"> abstract <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a> <a href=Session.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"> abstract <a href=https://developer.android.com/reference/kotlin/java/util/Date.html>Date</a> <a href=Session.html#getEndTime()>getEndTime</a>()</pre>
<div class="block"><p>Returns session end time.</p></div>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="getDuration()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getDuration</h4>
<pre class="methodSignature"> abstract long <a href=Session.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="getArguments()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getArguments</h4>
<pre class="methodSignature"> abstract <a href=https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html>Array</a>&lt;<a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a>&gt; <a href=Session.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="getCommand()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getCommand</h4>
<pre class="methodSignature"> abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=Session.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"> abstract <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a>&lt;<a href=Log.html>Log</a>&gt; <a href=Session.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"> abstract <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a>&lt;<a href=Log.html>Log</a>&gt; <a href=Session.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.</p></div>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="getLogs()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getLogs</h4>
<pre class="methodSignature"> abstract <a href=https://developer.android.com/reference/kotlin/java/util/List.html>List</a>&lt;<a href=Log.html>Log</a>&gt; <a href=Session.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="getAllLogsAsString(int)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getAllLogsAsString</h4>
<pre class="methodSignature"> abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=Session.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"> abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=Session.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.</p></div>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="getLogsAsString()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getLogsAsString</h4>
<pre class="methodSignature"> abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=Session.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"> abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=Session.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="getState()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getState</h4>
<pre class="methodSignature"> abstract <a href=SessionState.html>SessionState</a> <a href=Session.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"> abstract <a href=ReturnCode.html>ReturnCode</a> <a href=Session.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"> abstract <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=Session.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"> abstract <a href=LogRedirectionStrategy.html>LogRedirectionStrategy</a> <a href=Session.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="thereAreAsynchronousMessagesInTransmit()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>thereAreAsynchronousMessagesInTransmit</h4>
<pre class="methodSignature"> abstract boolean <a href=Session.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"> abstract void <a href=Session.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="getFuture()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getFuture</h4>
<pre class="methodSignature"> abstract <a href=https://developer.android.com/reference/kotlin/java/util/concurrent/Future.html>Future</a>&lt;out <a href=https://developer.android.com/reference/kotlin/java/lang/Object.html>Object</a>&gt; <a href=Session.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="isFFmpeg()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>isFFmpeg</h4>
<pre class="methodSignature"> abstract boolean <a href=Session.html#isFFmpeg()>isFFmpeg</a>()</pre>
<div class="block"><p>Returns whether it is an <code>FFmpeg</code> session or not.</p></div>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="isFFprobe()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>isFFprobe</h4>
<pre class="methodSignature"> abstract boolean <a href=Session.html#isFFprobe()>isFFprobe</a>()</pre>
<div class="block"><p>Returns whether it is an <code>FFprobe</code> session or not.</p></div>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="isMediaInformation()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>isMediaInformation</h4>
<pre class="methodSignature"> abstract boolean <a href=Session.html#isMediaInformation()>isMediaInformation</a>()</pre>
<div class="block"><p>Returns whether it is a <code>MediaInformation</code> session or not.</p></div>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="cancel()">
<!-- -->
</a>
<ul class=
"blockListLast"
>
<li class="blockList">
<h4>cancel</h4>
<pre class="methodSignature"> abstract void <a href=Session.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>
2022-09-17 20:29:42 +03:00
</main>
<footer role="contentinfo">
2023-08-22 23:00:49 +03:00
<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</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&nbsp;Classes</a></li>
2021-03-02 01:25:17 +02:00
</ul>
<div>
<script type="text/javascript"><!--
2023-08-22 23:00:49 +03:00
allClassesLink = document.getElementById("allclasses_navbar_top");
2021-03-02 01:25:17 +02:00
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
2022-09-17 20:29:42 +03:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2021-03-02 01:25:17 +02:00
</div>
2023-08-22 23:00:49 +03:00
<a id="skip.navbar.top">
2021-03-02 01:25:17 +02:00
<!-- -->
2023-08-22 23:00:49 +03:00
</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>
2021-03-02 01:25:17 +02:00
</body>
</html>