ffmpeg-kit/docs/android/javadoc/com/arthenica/ffmpegkit/MediaInformationSession.html
2023-08-22 23:45:47 +03:00

573 lines
34 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en"><head>
<title>MediaInformationSession </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&nbsp;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">&nbsp;</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>&nbsp;<a href="package-summary.html"></a></div>
<h2 title="Class MediaInformationSession" class="title">Class MediaInformationSession</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 class <span class="typeNameLabel"><a href=MediaInformationSession.html>MediaInformationSession</a></span>
extends <a href=AbstractSession.html>AbstractSession</a> implements <a href=Session.html>Session</a>
</pre>
<div class="block"><p>A custom FFprobe session, which produces a <code>MediaInformation</code> object using the FFprobe output.</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">&nbsp;</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>private <a href=MediaInformation.html>MediaInformation</a></code></td>
<th class="colSecond" scope="row"><code><a href=MediaInformationSession.html#mediaInformation>mediaInformation</a></code></th>
<td class="colLast"></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private final <a href=MediaInformationSessionCompleteCallback.html>MediaInformationSessionCompleteCallback</a></code></td>
<th class="colSecond" scope="row"><code><a href=MediaInformationSession.html#completeCallback>completeCallback</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><a href=MediaInformation.html>MediaInformation</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=MediaInformationSession.html#getMediaInformation()>getMediaInformation</a>() </code>
</th>
<td class="colLast">Returns the media information extracted in this session.</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code>
</td>
<th class="colSecond" scope="row"><code><a href=MediaInformationSession.html#setMediaInformation(MediaInformation)>setMediaInformation</a>(<a href=MediaInformation.html>MediaInformation</a> mediaInformation) </code>
</th>
<td class="colLast">Sets the media information extracted in this session.</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href=MediaInformationSessionCompleteCallback.html>MediaInformationSessionCompleteCallback</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=MediaInformationSession.html#getCompleteCallback()>getCompleteCallback</a>() </code>
</th>
<td class="colLast">Returns the session specific complete callback.</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href=MediaInformationSession.html>MediaInformationSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=MediaInformationSession.html#create(Array)>create</a>(<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; arguments) </code>
</th>
<td class="colLast">Creates a new media information session.</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href=MediaInformationSession.html>MediaInformationSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=MediaInformationSession.html#create(Array,MediaInformationSessionCompleteCallback)>create</a>(<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; arguments, <a href=MediaInformationSessionCompleteCallback.html>MediaInformationSessionCompleteCallback</a> completeCallback) </code>
</th>
<td class="colLast">Creates a new media information session.</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href=MediaInformationSession.html>MediaInformationSession</a></code>
</td>
<th class="colSecond" scope="row"><code><a href=MediaInformationSession.html#create(Array,MediaInformationSessionCompleteCallback,LogCallback)>create</a>(<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; arguments, <a href=MediaInformationSessionCompleteCallback.html>MediaInformationSessionCompleteCallback</a> completeCallback, <a href=LogCallback.html>LogCallback</a> logCallback) </code>
</th>
<td class="colLast">Creates a new media information session.</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code>
</td>
<th class="colSecond" scope="row"><code><a href=MediaInformationSession.html#isFFmpeg()>isFFmpeg</a>() </code>
</th>
<td class="colLast">Returns whether it is an <code>FFmpeg</code> session or not.</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code>
</td>
<th class="colSecond" scope="row"><code><a href=MediaInformationSession.html#isFFprobe()>isFFprobe</a>() </code>
</th>
<td class="colLast">Returns whether it is an <code>FFprobe</code> session or not.</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code>
</td>
<th class="colSecond" scope="row"><code><a href=MediaInformationSession.html#isMediaInformation()>isMediaInformation</a>() </code>
</th>
<td class="colLast">Returns whether it is a <code>MediaInformation</code> session or not.</td>
</tr>
<tr id="i9" 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=MediaInformationSession.html#toString()>toString</a>() </code>
</th>
<td class="colLast"></td>
</tr>
</tbody>
</table>
</div>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.arthenica.ffmpegkit.AbstractSession">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.arthenica.ffmpegkit.AbstractSession</h3>
<code>addLog, cancel, getAllLogs, getAllLogs, getAllLogsAsString, getAllLogsAsString, getArguments, getCommand, getCreateTime, getDuration, getEndTime, getFailStackTrace, getFuture, getLogCallback, getLogRedirectionStrategy, getLogs, getLogsAsString, getOutput, getReturnCode, getSessionId, getStartTime, getState, thereAreAsynchronousMessagesInTransmit</code></li>
<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="getMediaInformation()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getMediaInformation</h4>
<pre class="methodSignature"> <a href=MediaInformation.html>MediaInformation</a> <a href=MediaInformationSession.html#getMediaInformation()>getMediaInformation</a>()</pre>
<div class="block"><p>Returns the media information extracted in this session.</p></div>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="setMediaInformation(MediaInformation)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>setMediaInformation</h4>
<pre class="methodSignature"> void <a href=MediaInformationSession.html#setMediaInformation(MediaInformation)>setMediaInformation</a>(<a href=MediaInformation.html>MediaInformation</a> mediaInformation)</pre>
<div class="block"><p>Sets the media information extracted in this session.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaInformation</code> - media information extracted</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="getCompleteCallback()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>getCompleteCallback</h4>
<pre class="methodSignature"> <a href=MediaInformationSessionCompleteCallback.html>MediaInformationSessionCompleteCallback</a> <a href=MediaInformationSession.html#getCompleteCallback()>getCompleteCallback</a>()</pre>
<div class="block"><p>Returns the session specific complete callback.</p></div>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="create(Array)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature"> static <a href=MediaInformationSession.html>MediaInformationSession</a> <a href=MediaInformationSession.html#create(Array)>create</a>(<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; arguments)</pre>
<div class="block"><p>Creates a new media information session.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - command arguments</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="create(Array,MediaInformationSessionCompleteCallback)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature"> static <a href=MediaInformationSession.html>MediaInformationSession</a> <a href=MediaInformationSession.html#create(Array,MediaInformationSessionCompleteCallback)>create</a>(<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; arguments, <a href=MediaInformationSessionCompleteCallback.html>MediaInformationSessionCompleteCallback</a> completeCallback)</pre>
<div class="block"><p>Creates a new media information session.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - command arguments</dd>
<dd><code>completeCallback</code> - session specific complete callback</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="create(Array,MediaInformationSessionCompleteCallback,LogCallback)">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature"> static <a href=MediaInformationSession.html>MediaInformationSession</a> <a href=MediaInformationSession.html#create(Array,MediaInformationSessionCompleteCallback,LogCallback)>create</a>(<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; arguments, <a href=MediaInformationSessionCompleteCallback.html>MediaInformationSessionCompleteCallback</a> completeCallback, <a href=LogCallback.html>LogCallback</a> logCallback)</pre>
<div class="block"><p>Creates a new media information session.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arguments</code> - command arguments</dd>
<dd><code>completeCallback</code> - session specific complete callback</dd>
<dd><code>logCallback</code> - session specific log callback</dd>
</dl>
<!-- TODO missing return annotation -->
</li>
</ul>
<a id="isFFmpeg()">
<!-- -->
</a>
<ul class=
"blockList"
>
<li class="blockList">
<h4>isFFmpeg</h4>
<pre class="methodSignature"> boolean <a href=MediaInformationSession.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"> boolean <a href=MediaInformationSession.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"> boolean <a href=MediaInformationSession.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="toString()">
<!-- -->
</a>
<ul class=
"blockListLast"
>
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature"> <a href=https://developer.android.com/reference/kotlin/java/lang/String.html>String</a> <a href=MediaInformationSession.html#toString()>toString</a>()</pre>
<div class="block"></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&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>
<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>