antonlyap/ffmpeg-kit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
acd1d25b3d
ffmpeg-kit/docs/android/javadoc/com/arthenica/ffmpegkit/FFmpegKitConfig.html
Taner Sener 2cf5f9ff0e update documentation
2021-03-03 18:59:41 +00:00

1258 lines
55 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>FFmpegKitConfig (FFmpegKit)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FFmpegKitConfig (FFmpegKit)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":9,"i26":9,"i27":9,"i28":9,"i29":9,"i30":9,"i31":9,"i32":9,"i33":9,"i34":9,"i35":9,"i36":9,"i37":9,"i38":9,"i39":9,"i40":9,"i41":9,"i42":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</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="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" id="allclasses_navbar_top">
<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" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a 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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.arthenica.ffmpegkit</a></div>
<h2 title="Class FFmpegKitConfig" class="title">Class FFmpegKitConfig</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.arthenica.ffmpegkit.FFmpegKitConfig</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">FFmpegKitConfig</span>
extends java.lang.Object</pre>
<div class="block"><p>Configuration class of <code>FFmpegKit</code> library.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asyncFFmpegExecute(com.arthenica.ffmpegkit.FFmpegSession)">asyncFFmpegExecute</a></span>&#8203;(<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;ffmpegSession)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes the FFmpeg session provided.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asyncFFmpegExecute(com.arthenica.ffmpegkit.FFmpegSession,java.util.concurrent.ExecutorService)">asyncFFmpegExecute</a></span>&#8203;(<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;ffmpegSession,
java.util.concurrent.ExecutorService&nbsp;executorService)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes the FFmpeg session provided.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asyncFFprobeExecute(com.arthenica.ffmpegkit.FFprobeSession)">asyncFFprobeExecute</a></span>&#8203;(<a href="FFprobeSession.html" title="class in com.arthenica.ffmpegkit">FFprobeSession</a>&nbsp;ffprobeSession)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes the FFprobe session provided.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asyncFFprobeExecute(com.arthenica.ffmpegkit.FFprobeSession,java.util.concurrent.ExecutorService)">asyncFFprobeExecute</a></span>&#8203;(<a href="FFprobeSession.html" title="class in com.arthenica.ffmpegkit">FFprobeSession</a>&nbsp;ffprobeSession,
java.util.concurrent.ExecutorService&nbsp;executorService)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes the FFprobe session provided.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asyncGetMediaInformationExecute(com.arthenica.ffmpegkit.MediaInformationSession,int)">asyncGetMediaInformationExecute</a></span>&#8203;(<a href="MediaInformationSession.html" title="class in com.arthenica.ffmpegkit">MediaInformationSession</a>&nbsp;mediaInformationSession,
int&nbsp;waitTimeout)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes the media information session provided.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asyncGetMediaInformationExecute(com.arthenica.ffmpegkit.MediaInformationSession,java.util.concurrent.ExecutorService,int)">asyncGetMediaInformationExecute</a></span>&#8203;(<a href="MediaInformationSession.html" title="class in com.arthenica.ffmpegkit">MediaInformationSession</a>&nbsp;mediaInformationSession,
java.util.concurrent.ExecutorService&nbsp;executorService,
int&nbsp;waitTimeout)</code></th>
<td class="colLast">
<div class="block">Asynchronously executes the media information session provided.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeFFmpegPipe(java.lang.String)">closeFFmpegPipe</a></span>&#8203;(java.lang.String&nbsp;ffmpegPipePath)</code></th>
<td class="colLast">
<div class="block">Closes a previously created <code>FFmpeg</code> pipe.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disableRedirection()">disableRedirection</a></span>()</code></th>
<td class="colLast">
<div class="block">Disables log and statistics redirection.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enableExecuteCallback(com.arthenica.ffmpegkit.ExecuteCallback)">enableExecuteCallback</a></span>&#8203;(<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback)</code></th>
<td class="colLast">
<div class="block">Sets a global callback function to receive execution results.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enableLogCallback(com.arthenica.ffmpegkit.LogCallback)">enableLogCallback</a></span>&#8203;(<a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback)</code></th>
<td class="colLast">
<div class="block">Sets a global callback function to redirect FFmpeg/FFprobe logs.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enableRedirection()">enableRedirection</a></span>()</code></th>
<td class="colLast">
<div class="block">Enables log and statistics redirection.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enableStatisticsCallback(com.arthenica.ffmpegkit.StatisticsCallback)">enableStatisticsCallback</a></span>&#8203;(<a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a>&nbsp;statisticsCallback)</code></th>
<td class="colLast">
<div class="block">Sets a global callback function to redirect FFmpeg statistics.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ffmpegExecute(com.arthenica.ffmpegkit.FFmpegSession)">ffmpegExecute</a></span>&#8203;(<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;ffmpegSession)</code></th>
<td class="colLast">
<div class="block">Synchronously executes the FFmpeg session provided.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ffprobeExecute(com.arthenica.ffmpegkit.FFprobeSession)">ffprobeExecute</a></span>&#8203;(<a href="FFprobeSession.html" title="class in com.arthenica.ffmpegkit">FFprobeSession</a>&nbsp;ffprobeSession)</code></th>
<td class="colLast">
<div class="block">Synchronously executes the FFprobe session provided.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAsyncConcurrencyLimit()">getAsyncConcurrencyLimit</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the maximum number of async sessions that will be executed in parallel.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBuildDate()">getBuildDate</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns FFmpegKit library build date.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFFmpegVersion()">getFFmpegVersion</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the version of FFmpeg bundled within <code>FFmpegKit</code> library.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static <a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLastCompletedSession()">getLastCompletedSession</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the last session completed from the session history.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static <a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLastSession()">getLastSession</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the last session created from the session history.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>static <a href="Level.html" title="enum in com.arthenica.ffmpegkit">Level</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogLevel()">getLogLevel</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the current log level.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>static <a href="LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogRedirectionStrategy()">getLogRedirectionStrategy</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the active log redirection strategy.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMediaInformationExecute(com.arthenica.ffmpegkit.MediaInformationSession,int)">getMediaInformationExecute</a></span>&#8203;(<a href="MediaInformationSession.html" title="class in com.arthenica.ffmpegkit">MediaInformationSession</a>&nbsp;mediaInformationSession,
int&nbsp;waitTimeout)</code></th>
<td class="colLast">
<div class="block">Synchronously executes the media information session provided.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSafParameterForRead(android.content.Context,android.net.Uri)">getSafParameterForRead</a></span>&#8203;(android.content.Context&nbsp;context,
android.net.Uri&nbsp;uri)</code></th>
<td class="colLast">
<div class="block">Converts the given Structured Access Framework Uri (<code>"content:…"</code>) into an
input url that can be used in FFmpeg and FFprobe commands.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSafParameterForWrite(android.content.Context,android.net.Uri)">getSafParameterForWrite</a></span>&#8203;(android.content.Context&nbsp;context,
android.net.Uri&nbsp;uri)</code></th>
<td class="colLast">
<div class="block">Converts the given Structured Access Framework Uri (<code>"content:…"</code>) into an
output url that can be used in FFmpeg and FFprobe commands.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>static <a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSession(long)">getSession</a></span>&#8203;(long&nbsp;sessionId)</code></th>
<td class="colLast">
<div class="block">Returns the session specified with <code>sessionId</code> from the session history.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionHistorySize()">getSessionHistorySize</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the session history size.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>static java.util.List&lt;<a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessions()">getSessions</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns all sessions in the session history.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>static java.util.List&lt;<a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionsByState(com.arthenica.ffmpegkit.SessionState)">getSessionsByState</a></span>&#8203;(<a href="SessionState.html" title="enum in com.arthenica.ffmpegkit">SessionState</a>&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Returns sessions that have the given state.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>static java.util.List&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSupportedCameraIds(android.content.Context)">getSupportedCameraIds</a></span>&#8203;(android.content.Context&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Returns the list of camera ids supported.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersion()">getVersion</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns FFmpegKit library version.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ignoreSignal(com.arthenica.ffmpegkit.Signal)">ignoreSignal</a></span>&#8203;(<a href="Signal.html" title="enum in com.arthenica.ffmpegkit">Signal</a>&nbsp;signal)</code></th>
<td class="colLast">
<div class="block">Registers a new ignored signal.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLTSBuild()">isLTSBuild</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether FFmpegKit release is a Long Term Release or not.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#messagesInTransmit(long)">messagesInTransmit</a></span>&#8203;(long&nbsp;sessionId)</code></th>
<td class="colLast">
<div class="block">Returns the number of native messages that are not transmitted to the Java callbacks for
this session natively.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#printToLogcat(int,java.lang.String)">printToLogcat</a></span>&#8203;(int&nbsp;logPriority,
java.lang.String&nbsp;string)</code></th>
<td class="colLast">
<div class="block">Prints the given string to Logcat using the given priority.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerNewFFmpegPipe(android.content.Context)">registerNewFFmpegPipe</a></span>&#8203;(android.content.Context&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Creates a new named pipe to use in <code>FFmpeg</code> operations.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAsyncConcurrencyLimit(int)">setAsyncConcurrencyLimit</a></span>&#8203;(int&nbsp;asyncConcurrencyLimit)</code></th>
<td class="colLast">
<div class="block">Sets the maximum number of async sessions that will be executed in parallel.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEnvironmentVariable(java.lang.String,java.lang.String)">setEnvironmentVariable</a></span>&#8203;(java.lang.String&nbsp;variableName,
java.lang.String&nbsp;variableValue)</code></th>
<td class="colLast">
<div class="block">Sets an environment variable.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFontconfigConfigurationPath(java.lang.String)">setFontconfigConfigurationPath</a></span>&#8203;(java.lang.String&nbsp;path)</code></th>
<td class="colLast">
<div class="block">Sets and overrides <code>fontconfig</code> configuration directory.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFontDirectory(android.content.Context,java.lang.String,java.util.Map)">setFontDirectory</a></span>&#8203;(android.content.Context&nbsp;context,
java.lang.String&nbsp;fontDirectoryPath,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;fontNameMapping)</code></th>
<td class="colLast">
<div class="block">Registers the fonts inside the given path, so they become available to use in FFmpeg
filters.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFontDirectoryList(android.content.Context,java.util.List,java.util.Map)">setFontDirectoryList</a></span>&#8203;(android.content.Context&nbsp;context,
java.util.List&lt;java.lang.String&gt;&nbsp;fontDirectoryList,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;fontNameMapping)</code></th>
<td class="colLast">
<div class="block">Registers the fonts inside the given list of font directories, so they become available
to use in FFmpeg filters.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogLevel(com.arthenica.ffmpegkit.Level)">setLogLevel</a></span>&#8203;(<a href="Level.html" title="enum in com.arthenica.ffmpegkit">Level</a>&nbsp;level)</code></th>
<td class="colLast">
<div class="block">Sets the log level.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogRedirectionStrategy(com.arthenica.ffmpegkit.LogRedirectionStrategy)">setLogRedirectionStrategy</a></span>&#8203;(<a href="LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a>&nbsp;logRedirectionStrategy)</code></th>
<td class="colLast">
<div class="block">Sets the log redirection strategy</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSessionHistorySize(int)">setSessionHistorySize</a></span>&#8203;(int&nbsp;sessionHistorySize)</code></th>
<td class="colLast">
<div class="block">Sets the session history size.</div>
</td>
</tr>
</table>
<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">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="enableRedirection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableRedirection</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;enableRedirection()</pre>
<div class="block"><p>Enables log and statistics redirection.
<p>When redirection is enabled FFmpeg/FFprobe logs are redirected to Logcat and sessions
collect log and statistics entries for the executions. It is possible to define global or
session specific log/statistics callbacks as well.
<p>Note that redirection is enabled by default. If you do not want to use its functionality
please use <a href="#disableRedirection()"><code>disableRedirection()</code></a> to disable it.</div>
</li>
</ul>
<a id="disableRedirection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableRedirection</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;disableRedirection()</pre>
<div class="block"><p>Disables log and statistics redirection.
<p>When redirection is disabled logs are printed to stderr, all logs and statistics
callbacks are disabled and <code>FFprobe</code>'s <code>getMediaInformation</code> methods
do not work.</div>
</li>
</ul>
<a id="setFontconfigConfigurationPath(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFontconfigConfigurationPath</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;setFontconfigConfigurationPath&#8203;(java.lang.String&nbsp;path)</pre>
<div class="block"><p>Sets and overrides <code>fontconfig</code> configuration directory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - directory that contains fontconfig configuration (fonts.conf)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>zero on success, non-zero on error</dd>
</dl>
</li>
</ul>
<a id="setFontDirectory(android.content.Context,java.lang.String,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFontDirectory</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;setFontDirectory&#8203;(android.content.Context&nbsp;context,
java.lang.String&nbsp;fontDirectoryPath,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;fontNameMapping)</pre>
<div class="block"><p>Registers the fonts inside the given path, so they become available to use in FFmpeg
filters.
<p>Note that you need to build <code>FFmpegKit</code> with <code>fontconfig</code>
enabled or use a prebuilt package with <code>fontconfig</code> inside to be able to use
fonts in <code>FFmpeg</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - application context to access application data</dd>
<dd><code>fontDirectoryPath</code> - directory that contains fonts (.ttf and .otf files)</dd>
<dd><code>fontNameMapping</code> - custom font name mappings, useful to access your fonts with more
friendly names</dd>
</dl>
</li>
</ul>
<a id="setFontDirectoryList(android.content.Context,java.util.List,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFontDirectoryList</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;setFontDirectoryList&#8203;(android.content.Context&nbsp;context,
java.util.List&lt;java.lang.String&gt;&nbsp;fontDirectoryList,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;fontNameMapping)</pre>
<div class="block"><p>Registers the fonts inside the given list of font directories, so they become available
to use in FFmpeg filters.
<p>Note that you need to build <code>FFmpegKit</code> with <code>fontconfig</code>
enabled or use a prebuilt package with <code>fontconfig</code> inside to be able to use
fonts in <code>FFmpeg</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - application context to access application data</dd>
<dd><code>fontDirectoryList</code> - list of directories that contain fonts (.ttf and .otf files)</dd>
<dd><code>fontNameMapping</code> - custom font name mappings, useful to access your fonts with more
friendly names</dd>
</dl>
</li>
</ul>
<a id="registerNewFFmpegPipe(android.content.Context)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerNewFFmpegPipe</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;registerNewFFmpegPipe&#8203;(android.content.Context&nbsp;context)</pre>
<div class="block"><p>Creates a new named pipe to use in <code>FFmpeg</code> operations.
<p>Please note that creator is responsible of closing created pipes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - application context</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the full path of the named pipe</dd>
</dl>
</li>
</ul>
<a id="closeFFmpegPipe(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeFFmpegPipe</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;closeFFmpegPipe&#8203;(java.lang.String&nbsp;ffmpegPipePath)</pre>
<div class="block"><p>Closes a previously created <code>FFmpeg</code> pipe.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ffmpegPipePath</code> - full path of the FFmpeg pipe</dd>
</dl>
</li>
</ul>
<a id="getSupportedCameraIds(android.content.Context)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSupportedCameraIds</h4>
<pre class="methodSignature">public static&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getSupportedCameraIds&#8203;(android.content.Context&nbsp;context)</pre>
<div class="block">Returns the list of camera ids supported. These devices can be used in <code>FFmpeg</code>
commands.
<p>Note that this method requires API Level &ge; 24. On older API levels it returns an empty
list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - application context</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of camera ids supported or an empty list if no supported cameras are found</dd>
</dl>
</li>
</ul>
<a id="getFFmpegVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFFmpegVersion</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;getFFmpegVersion()</pre>
<div class="block"><p>Returns the version of FFmpeg bundled within <code>FFmpegKit</code> library.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the version of FFmpeg</dd>
</dl>
</li>
</ul>
<a id="getVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;getVersion()</pre>
<div class="block"><p>Returns FFmpegKit library version.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpegKit version</dd>
</dl>
</li>
</ul>
<a id="isLTSBuild()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLTSBuild</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isLTSBuild()</pre>
<div class="block"><p>Returns whether FFmpegKit release is a Long Term Release or not.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true/yes or false/no</dd>
</dl>
</li>
</ul>
<a id="getBuildDate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuildDate</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;getBuildDate()</pre>
<div class="block"><p>Returns FFmpegKit library build date.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>FFmpegKit library build date</dd>
</dl>
</li>
</ul>
<a id="printToLogcat(int,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printToLogcat</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;printToLogcat&#8203;(int&nbsp;logPriority,
java.lang.String&nbsp;string)</pre>
<div class="block"><p>Prints the given string to Logcat using the given priority. If string provided is bigger
than the Logcat buffer, the string is printed in multiple lines.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>logPriority</code> - one of <code>Log.VERBOSE</code>,
<code>Log.DEBUG</code>,
<code>Log.INFO</code>,
<code>Log.WARN</code>,
<code>Log.ERROR</code>,
<code>Log.ASSERT</code></dd>
<dd><code>string</code> - string to be printed</dd>
</dl>
</li>
</ul>
<a id="setEnvironmentVariable(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnvironmentVariable</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;setEnvironmentVariable&#8203;(java.lang.String&nbsp;variableName,
java.lang.String&nbsp;variableValue)</pre>
<div class="block"><p>Sets an environment variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>variableName</code> - environment variable name</dd>
<dd><code>variableValue</code> - environment variable value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>zero on success, non-zero on error</dd>
</dl>
</li>
</ul>
<a id="ignoreSignal(com.arthenica.ffmpegkit.Signal)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ignoreSignal</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;ignoreSignal&#8203;(<a href="Signal.html" title="enum in com.arthenica.ffmpegkit">Signal</a>&nbsp;signal)</pre>
<div class="block"><p>Registers a new ignored signal. Ignored signals are not handled by <code>FFmpegKit</code>
library.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>signal</code> - signal to be ignored</dd>
</dl>
</li>
</ul>
<a id="ffmpegExecute(com.arthenica.ffmpegkit.FFmpegSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ffmpegExecute</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;ffmpegExecute&#8203;(<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;ffmpegSession)</pre>
<div class="block"><p>Synchronously executes the FFmpeg session provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ffmpegSession</code> - FFmpeg session which includes command options/arguments</dd>
</dl>
</li>
</ul>
<a id="ffprobeExecute(com.arthenica.ffmpegkit.FFprobeSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ffprobeExecute</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;ffprobeExecute&#8203;(<a href="FFprobeSession.html" title="class in com.arthenica.ffmpegkit">FFprobeSession</a>&nbsp;ffprobeSession)</pre>
<div class="block"><p>Synchronously executes the FFprobe session provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ffprobeSession</code> - FFprobe session which includes command options/arguments</dd>
</dl>
</li>
</ul>
<a id="getMediaInformationExecute(com.arthenica.ffmpegkit.MediaInformationSession,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMediaInformationExecute</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;getMediaInformationExecute&#8203;(<a href="MediaInformationSession.html" title="class in com.arthenica.ffmpegkit">MediaInformationSession</a>&nbsp;mediaInformationSession,
int&nbsp;waitTimeout)</pre>
<div class="block"><p>Synchronously executes the media information session provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaInformationSession</code> - media information session which includes command options/arguments</dd>
<dd><code>waitTimeout</code> - max time to wait until media information is transmitted</dd>
</dl>
</li>
</ul>
<a id="asyncFFmpegExecute(com.arthenica.ffmpegkit.FFmpegSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncFFmpegExecute</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;asyncFFmpegExecute&#8203;(<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;ffmpegSession)</pre>
<div class="block"><p>Asynchronously executes the FFmpeg session provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ffmpegSession</code> - FFmpeg session which includes command options/arguments</dd>
</dl>
</li>
</ul>
<a id="asyncFFmpegExecute(com.arthenica.ffmpegkit.FFmpegSession,java.util.concurrent.ExecutorService)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncFFmpegExecute</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;asyncFFmpegExecute&#8203;(<a href="FFmpegSession.html" title="class in com.arthenica.ffmpegkit">FFmpegSession</a>&nbsp;ffmpegSession,
java.util.concurrent.ExecutorService&nbsp;executorService)</pre>
<div class="block"><p>Asynchronously executes the FFmpeg session provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ffmpegSession</code> - FFmpeg session which includes command options/arguments</dd>
<dd><code>executorService</code> - executor service that will be used to run this asynchronous operation</dd>
</dl>
</li>
</ul>
<a id="asyncFFprobeExecute(com.arthenica.ffmpegkit.FFprobeSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncFFprobeExecute</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;asyncFFprobeExecute&#8203;(<a href="FFprobeSession.html" title="class in com.arthenica.ffmpegkit">FFprobeSession</a>&nbsp;ffprobeSession)</pre>
<div class="block"><p>Asynchronously executes the FFprobe session provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ffprobeSession</code> - FFprobe session which includes command options/arguments</dd>
</dl>
</li>
</ul>
<a id="asyncFFprobeExecute(com.arthenica.ffmpegkit.FFprobeSession,java.util.concurrent.ExecutorService)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncFFprobeExecute</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;asyncFFprobeExecute&#8203;(<a href="FFprobeSession.html" title="class in com.arthenica.ffmpegkit">FFprobeSession</a>&nbsp;ffprobeSession,
java.util.concurrent.ExecutorService&nbsp;executorService)</pre>
<div class="block"><p>Asynchronously executes the FFprobe session provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ffprobeSession</code> - FFprobe session which includes command options/arguments</dd>
<dd><code>executorService</code> - executor service that will be used to run this asynchronous operation</dd>
</dl>
</li>
</ul>
<a id="asyncGetMediaInformationExecute(com.arthenica.ffmpegkit.MediaInformationSession,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncGetMediaInformationExecute</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;asyncGetMediaInformationExecute&#8203;(<a href="MediaInformationSession.html" title="class in com.arthenica.ffmpegkit">MediaInformationSession</a>&nbsp;mediaInformationSession,
int&nbsp;waitTimeout)</pre>
<div class="block"><p>Asynchronously executes the media information session provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaInformationSession</code> - media information session which includes command options/arguments</dd>
<dd><code>waitTimeout</code> - max time to wait until media information is transmitted</dd>
</dl>
</li>
</ul>
<a id="asyncGetMediaInformationExecute(com.arthenica.ffmpegkit.MediaInformationSession,java.util.concurrent.ExecutorService,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncGetMediaInformationExecute</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;asyncGetMediaInformationExecute&#8203;(<a href="MediaInformationSession.html" title="class in com.arthenica.ffmpegkit">MediaInformationSession</a>&nbsp;mediaInformationSession,
java.util.concurrent.ExecutorService&nbsp;executorService,
int&nbsp;waitTimeout)</pre>
<div class="block"><p>Asynchronously executes the media information session provided.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaInformationSession</code> - media information session which includes command options/arguments</dd>
<dd><code>executorService</code> - executor service that will be used to run this asynchronous operation</dd>
<dd><code>waitTimeout</code> - max time to wait until media information is transmitted</dd>
</dl>
</li>
</ul>
<a id="getAsyncConcurrencyLimit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAsyncConcurrencyLimit</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;getAsyncConcurrencyLimit()</pre>
<div class="block">Returns the maximum number of async sessions that will be executed in parallel.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>maximum number of async sessions that will be executed in parallel</dd>
</dl>
</li>
</ul>
<a id="setAsyncConcurrencyLimit(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAsyncConcurrencyLimit</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;setAsyncConcurrencyLimit&#8203;(int&nbsp;asyncConcurrencyLimit)</pre>
<div class="block">Sets the maximum number of async sessions that will be executed in parallel. If more
sessions are submitted those will be queued.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>asyncConcurrencyLimit</code> - new async concurrency limit</dd>
</dl>
</li>
</ul>
<a id="enableLogCallback(com.arthenica.ffmpegkit.LogCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableLogCallback</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;enableLogCallback&#8203;(<a href="LogCallback.html" title="interface in com.arthenica.ffmpegkit">LogCallback</a>&nbsp;logCallback)</pre>
<div class="block"><p>Sets a global callback function to redirect FFmpeg/FFprobe logs.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>logCallback</code> - log callback function or null to disable a previously defined
callback</dd>
</dl>
</li>
</ul>
<a id="enableStatisticsCallback(com.arthenica.ffmpegkit.StatisticsCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableStatisticsCallback</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;enableStatisticsCallback&#8203;(<a href="StatisticsCallback.html" title="interface in com.arthenica.ffmpegkit">StatisticsCallback</a>&nbsp;statisticsCallback)</pre>
<div class="block"><p>Sets a global callback function to redirect FFmpeg statistics.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>statisticsCallback</code> - statistics callback function or null to disable a previously
defined callback</dd>
</dl>
</li>
</ul>
<a id="enableExecuteCallback(com.arthenica.ffmpegkit.ExecuteCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableExecuteCallback</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;enableExecuteCallback&#8203;(<a href="ExecuteCallback.html" title="interface in com.arthenica.ffmpegkit">ExecuteCallback</a>&nbsp;executeCallback)</pre>
<div class="block"><p>Sets a global callback function to receive execution results.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>executeCallback</code> - execute callback function or null to disable a previously
defined callback</dd>
</dl>
</li>
</ul>
<a id="getLogLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogLevel</h4>
<pre class="methodSignature">public static&nbsp;<a href="Level.html" title="enum in com.arthenica.ffmpegkit">Level</a>&nbsp;getLogLevel()</pre>
<div class="block">Returns the current log level.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>current log level</dd>
</dl>
</li>
</ul>
<a id="setLogLevel(com.arthenica.ffmpegkit.Level)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLogLevel</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;setLogLevel&#8203;(<a href="Level.html" title="enum in com.arthenica.ffmpegkit">Level</a>&nbsp;level)</pre>
<div class="block">Sets the log level.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>level</code> - new log level</dd>
</dl>
</li>
</ul>
<a id="getSafParameterForRead(android.content.Context,android.net.Uri)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSafParameterForRead</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;getSafParameterForRead&#8203;(android.content.Context&nbsp;context,
android.net.Uri&nbsp;uri)</pre>
<div class="block"><p>Converts the given Structured Access Framework Uri (<code>"content:…"</code>) into an
input url that can be used in FFmpeg and FFprobe commands.
<p>Requires API Level &ge; 19. On older API levels it returns an empty url.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - application context</dd>
<dd><code>uri</code> - saf uri</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>input url that can be passed to FFmpegKit or FFprobeKit</dd>
</dl>
</li>
</ul>
<a id="getSafParameterForWrite(android.content.Context,android.net.Uri)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSafParameterForWrite</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;getSafParameterForWrite&#8203;(android.content.Context&nbsp;context,
android.net.Uri&nbsp;uri)</pre>
<div class="block"><p>Converts the given Structured Access Framework Uri (<code>"content:…"</code>) into an
output url that can be used in FFmpeg and FFprobe commands.
<p>Requires API Level &ge; 19. On older API levels it returns an empty url.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - application context</dd>
<dd><code>uri</code> - saf uri</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>output url that can be passed to FFmpegKit or FFprobeKit</dd>
</dl>
</li>
</ul>
<a id="getSessionHistorySize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionHistorySize</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;getSessionHistorySize()</pre>
<div class="block">Returns the session history size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session history size</dd>
</dl>
</li>
</ul>
<a id="setSessionHistorySize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSessionHistorySize</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;setSessionHistorySize&#8203;(int&nbsp;sessionHistorySize)</pre>
<div class="block">Sets the session history size.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sessionHistorySize</code> - session history size, should be smaller than 1000</dd>
</dl>
</li>
</ul>
<a id="getSession(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre class="methodSignature">public static&nbsp;<a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a>&nbsp;getSession&#8203;(long&nbsp;sessionId)</pre>
<div class="block">Returns the session specified with <code>sessionId</code> from the session history.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sessionId</code> - session identifier</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>session specified with sessionId or null if it is not found in the history</dd>
</dl>
</li>
</ul>
<a id="getLastSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastSession</h4>
<pre class="methodSignature">public static&nbsp;<a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a>&nbsp;getLastSession()</pre>
<div class="block">Returns the last session created from the session history.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the last session created or null if session history is empty</dd>
</dl>
</li>
</ul>
<a id="getLastCompletedSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastCompletedSession</h4>
<pre class="methodSignature">public static&nbsp;<a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a>&nbsp;getLastCompletedSession()</pre>
<div class="block">Returns the last session completed from the session history.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the last session completed. If there are no completed sessions in the history this
method will return null</dd>
</dl>
</li>
</ul>
<a id="getSessions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessions</h4>
<pre class="methodSignature">public static&nbsp;java.util.List&lt;<a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a>&gt;&nbsp;getSessions()</pre>
<div class="block"><p>Returns all sessions in the session history.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all sessions in the session history</dd>
</dl>
</li>
</ul>
<a id="getSessionsByState(com.arthenica.ffmpegkit.SessionState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionsByState</h4>
<pre class="methodSignature">public static&nbsp;java.util.List&lt;<a href="Session.html" title="interface in com.arthenica.ffmpegkit">Session</a>&gt;&nbsp;getSessionsByState&#8203;(<a href="SessionState.html" title="enum in com.arthenica.ffmpegkit">SessionState</a>&nbsp;state)</pre>
<div class="block"><p>Returns sessions that have the given state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - session state</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>sessions that have the given state from the session history</dd>
</dl>
</li>
</ul>
<a id="getLogRedirectionStrategy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogRedirectionStrategy</h4>
<pre class="methodSignature">public static&nbsp;<a href="LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a>&nbsp;getLogRedirectionStrategy()</pre>
<div class="block">Returns the active log redirection strategy.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>log redirection strategy</dd>
</dl>
</li>
</ul>
<a id="setLogRedirectionStrategy(com.arthenica.ffmpegkit.LogRedirectionStrategy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLogRedirectionStrategy</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;setLogRedirectionStrategy&#8203;(<a href="LogRedirectionStrategy.html" title="enum in com.arthenica.ffmpegkit">LogRedirectionStrategy</a>&nbsp;logRedirectionStrategy)</pre>
<div class="block"><p>Sets the log redirection strategy</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>logRedirectionStrategy</code> - log redirection strategy</dd>
</dl>
</li>
</ul>
<a id="messagesInTransmit(long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>messagesInTransmit</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;messagesInTransmit&#8203;(long&nbsp;sessionId)</pre>
<div class="block"><p>Returns the number of native messages that are not transmitted to the Java callbacks for
this session natively.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sessionId</code> - id of the session</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of native messages that are not transmitted to the Java callbacks for
this session natively</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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="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" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink