antonlyap/ffmpeg-kit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity
bc1893e11e
ffmpeg-kit/docs/linux/html/d2/d25/namespaceffmpegkit.html
Sue N. Cooper bc1893e11e freeze v6.0
2023-08-22 23:45:47 +03:00

477 lines
38 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FFmpegKit Linux API: ffmpegkit Namespace Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../ffmpeg-kit-icon-v9-small.png"/></td>
<td id="projectalign">
<div id="projectname">FFmpegKit Linux API<span id="projectnumber">&#160;6.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">ffmpegkit Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html">AbstractSession</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/df7/classffmpegkit_1_1_arch_detect.html">ArchDetect</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d9f/classffmpegkit_1_1_chapter.html">Chapter</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d71/classffmpegkit_1_1_f_fmpeg_kit.html">FFmpegKit</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d2a/classffmpegkit_1_1_f_fmpeg_kit_config.html">FFmpegKitConfig</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dee/classffmpegkit_1_1_f_fmpeg_session.html">FFmpegSession</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html">FFprobeKit</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">FFprobeSession</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d1c/classffmpegkit_1_1_log.html">Log</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d06/classffmpegkit_1_1_media_information.html">MediaInformation</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d53/classffmpegkit_1_1_media_information_json_parser.html">MediaInformationJsonParser</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">MediaInformationSession</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/dee/classffmpegkit_1_1_packages.html">Packages</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/dcf/classffmpegkit_1_1_return_code.html">ReturnCode</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html">Session</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/de7/classffmpegkit_1_1_statistics.html">Statistics</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d9e/classffmpegkit_1_1_stream_information.html">StreamInformation</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:afc007c369cdeebeca5cbf663ab966443"><td class="memItemLeft" align="right" valign="top">typedef std::function&lt; void(const std::shared_ptr&lt; <a class="el" href="../../d2/dee/classffmpegkit_1_1_f_fmpeg_session.html">ffmpegkit::FFmpegSession</a> &gt; session)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#afc007c369cdeebeca5cbf663ab966443">FFmpegSessionCompleteCallback</a></td></tr>
<tr class="separator:afc007c369cdeebeca5cbf663ab966443"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3f451cbb99c4dc36e2e2141a33cdf38"><td class="memItemLeft" align="right" valign="top">typedef std::function&lt; void(const std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt; session)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#af3f451cbb99c4dc36e2e2141a33cdf38">FFprobeSessionCompleteCallback</a></td></tr>
<tr class="separator:af3f451cbb99c4dc36e2e2141a33cdf38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a961de60de61ed79c2c7dfee08c9fa939"><td class="memItemLeft" align="right" valign="top">typedef std::function&lt; void(const std::shared_ptr&lt; <a class="el" href="../../db/d1c/classffmpegkit_1_1_log.html">ffmpegkit::Log</a> &gt; log)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a961de60de61ed79c2c7dfee08c9fa939">LogCallback</a></td></tr>
<tr class="separator:a961de60de61ed79c2c7dfee08c9fa939"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a909392d52220d37ab6e39bd7f4d6abb1"><td class="memItemLeft" align="right" valign="top">typedef std::function&lt; void(const std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt; session)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a909392d52220d37ab6e39bd7f4d6abb1">MediaInformationSessionCompleteCallback</a></td></tr>
<tr class="separator:a909392d52220d37ab6e39bd7f4d6abb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a250a65ad52e13fa88362845eb4b848ef"><td class="memItemLeft" align="right" valign="top">typedef std::function&lt; void(const std::shared_ptr&lt; <a class="el" href="../../d0/de7/classffmpegkit_1_1_statistics.html">ffmpegkit::Statistics</a> &gt; statistics)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a250a65ad52e13fa88362845eb4b848ef">StatisticsCallback</a></td></tr>
<tr class="separator:a250a65ad52e13fa88362845eb4b848ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a3726dad678d38ecd08f9af2f142156a4"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4">Level</a> { <br />
&#160;&#160;<a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4a4baea55bfac0c0ac87e3d022c7dfe06e">LevelAVLogStdErr</a> = -16
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4a601376fad6823274f99a97262f689c2f">LevelAVLogQuiet</a> = -8
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4a6be4cb38f1ff513c977d2d5e37deae42">LevelAVLogPanic</a> = 0
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4aeef1c634636b2a03270ba6bab8d2ecf1">LevelAVLogFatal</a> = 8
, <br />
&#160;&#160;<a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4a34bc76c36c5f97ec84ad0e5e1cd35251">LevelAVLogError</a> = 16
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4aaa2ab1eddacb480d687f17f0116d7e46">LevelAVLogWarning</a> = 24
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4acfd515b605fe5e71a66f2a47072c4d84">LevelAVLogInfo</a> = 32
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4ab251e1df59c8c9910f62effc9bbc8631">LevelAVLogVerbose</a> = 40
, <br />
&#160;&#160;<a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4a377b674192dd6d0212f3782280342ad3">LevelAVLogDebug</a> = 48
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4acb7d008328737b034c1ac65843c01413">LevelAVLogTrace</a> = 56
<br />
}</td></tr>
<tr class="separator:a3726dad678d38ecd08f9af2f142156a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11bee89be98423d1dc425a2849001ebe"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a11bee89be98423d1dc425a2849001ebe">LogRedirectionStrategy</a> { <br />
&#160;&#160;<a class="el" href="../../d2/d25/namespaceffmpegkit.html#a11bee89be98423d1dc425a2849001ebea4ac7c7054007119d71549846c2544288">LogRedirectionStrategyAlwaysPrintLogs</a> = 0
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a11bee89be98423d1dc425a2849001ebea662a08ddb8f44ec2a54b2259108d11b1">LogRedirectionStrategyPrintLogsWhenNoCallbacksDefined</a> = 1
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a11bee89be98423d1dc425a2849001ebeacf82deb57f2cfc6bfac3ab4c9a8e534c">LogRedirectionStrategyPrintLogsWhenGlobalCallbackNotDefined</a> = 2
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a11bee89be98423d1dc425a2849001ebea3b1e8dc7839b7abe69fe333e37f71936">LogRedirectionStrategyPrintLogsWhenSessionCallbackNotDefined</a> = 3
, <br />
&#160;&#160;<a class="el" href="../../d2/d25/namespaceffmpegkit.html#a11bee89be98423d1dc425a2849001ebea51a85a2abdd53daab89f93edb3779635">LogRedirectionStrategyNeverPrintLogs</a> = 4
<br />
}</td></tr>
<tr class="separator:a11bee89be98423d1dc425a2849001ebe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d76b34ad27245e8ba161c8f30ab5c8f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a6d76b34ad27245e8ba161c8f30ab5c8f">SessionState</a> { <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a6d76b34ad27245e8ba161c8f30ab5c8faa2b60da11090d170819db698df90f4a2">SessionStateCreated</a> = 0
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a6d76b34ad27245e8ba161c8f30ab5c8fa384cde9cd29cfe4e94fb4b8f5d3719c1">SessionStateRunning</a> = 1
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a6d76b34ad27245e8ba161c8f30ab5c8fa4e355211ff575fe9e53b5cac1989473e">SessionStateFailed</a> = 2
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a6d76b34ad27245e8ba161c8f30ab5c8fae395077a2a757c691699536f02cc264f">SessionStateCompleted</a> = 3
}</td></tr>
<tr class="separator:a6d76b34ad27245e8ba161c8f30ab5c8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac57fab4209bd25d62c86a99bb459bda2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#ac57fab4209bd25d62c86a99bb459bda2">Signal</a> { <br />
&#160;&#160;<a class="el" href="../../d2/d25/namespaceffmpegkit.html#ac57fab4209bd25d62c86a99bb459bda2a5b4b088da6cf903093a8d7789cee04f9">SignalInt</a> = 2
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#ac57fab4209bd25d62c86a99bb459bda2a45dced6df666a601d492885399b63a82">SignalQuit</a> = 3
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#ac57fab4209bd25d62c86a99bb459bda2ae1349a4dbeee5769723ceb0b6ce0efee">SignalPipe</a> = 13
, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#ac57fab4209bd25d62c86a99bb459bda2a7a9761ba37058f9235355143ef34deaa">SignalTerm</a> = 15
, <br />
&#160;&#160;<a class="el" href="../../d2/d25/namespaceffmpegkit.html#ac57fab4209bd25d62c86a99bb459bda2a253eff2aef02dedda7967818ea2f0639">SignalXcpu</a> = 24
<br />
}</td></tr>
<tr class="separator:ac57fab4209bd25d62c86a99bb459bda2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0481d866378fb1a9636ec138b727112c"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a0481d866378fb1a9636ec138b727112c">operator&lt;&lt;</a> (std::ostream &amp;out, const std::shared_ptr&lt; <a class="el" href="../../d4/dcf/classffmpegkit_1_1_return_code.html">ffmpegkit::ReturnCode</a> &gt; &amp;o)</td></tr>
<tr class="separator:a0481d866378fb1a9636ec138b727112c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="afc007c369cdeebeca5cbf663ab966443" name="afc007c369cdeebeca5cbf663ab966443"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc007c369cdeebeca5cbf663ab966443">&#9670;&#160;</a></span>FFmpegSessionCompleteCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::function&lt;void(const std::shared_ptr&lt;<a class="el" href="../../d2/dee/classffmpegkit_1_1_f_fmpeg_session.html">ffmpegkit::FFmpegSession</a>&gt; session)&gt; <a class="el" href="../../d2/d25/namespaceffmpegkit.html#afc007c369cdeebeca5cbf663ab966443">ffmpegkit::FFmpegSessionCompleteCallback</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function that is invoked when an asynchronous <code>FFmpeg</code> session has ended. </p>
<p><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html">Session</a> has either SessionStateCompleted or SessionStateFailed state when the callback is invoked. </p>
<p>If it has SessionStateCompleted state, <code><a class="el" href="../../d4/dcf/classffmpegkit_1_1_return_code.html">ReturnCode</a></code> should be checked to see the execution result. </p>
<p>If <code>getState</code> returns SessionStateFailed then <code>getFailStackTrace</code> should be used to get the failure reason. </p><pre>
switch (session-&gt;getState()) {
case SessionStateCompleted:
auto returnCode = session-&gt;getReturnCode();
break;
case SessionStateFailed:
auto failStackTrace = session-&gt;getFailStackTrace();
break;
}
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>session of the completed execution </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d6/d47/_f_fmpeg_session_complete_callback_8h_source.html#l00052">52</a> of file <a class="el" href="../../d6/d47/_f_fmpeg_session_complete_callback_8h_source.html">FFmpegSessionCompleteCallback.h</a>.</p>
</div>
</div>
<a id="af3f451cbb99c4dc36e2e2141a33cdf38" name="af3f451cbb99c4dc36e2e2141a33cdf38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3f451cbb99c4dc36e2e2141a33cdf38">&#9670;&#160;</a></span>FFprobeSessionCompleteCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::function&lt;void(const std::shared_ptr&lt;<a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a>&gt; session)&gt; <a class="el" href="../../d2/d25/namespaceffmpegkit.html#af3f451cbb99c4dc36e2e2141a33cdf38">ffmpegkit::FFprobeSessionCompleteCallback</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function that is invoked when an asynchronous <code>FFprobe</code> session has ended. </p>
<p><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html">Session</a> has either SessionStateCompleted or SessionStateFailed state when the callback is invoked. </p>
<p>If it has SessionStateCompleted state, <code><a class="el" href="../../d4/dcf/classffmpegkit_1_1_return_code.html">ReturnCode</a></code> should be checked to see the execution result. </p>
<p>If <code>getState</code> returns SessionStateFailed then <code>getFailStackTrace</code> should be used to get the failure reason. </p><pre>
switch (session-&gt;getState()) {
case SessionStateCompleted:
auto returnCode = session-&gt;getReturnCode();
break;
case SessionStateFailed:
auto failStackTrace = session-&gt;getFailStackTrace();
break;
}
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>session of the completed execution </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d5/d14/_f_fprobe_session_complete_callback_8h_source.html#l00052">52</a> of file <a class="el" href="../../d5/d14/_f_fprobe_session_complete_callback_8h_source.html">FFprobeSessionCompleteCallback.h</a>.</p>
</div>
</div>
<a id="a961de60de61ed79c2c7dfee08c9fa939" name="a961de60de61ed79c2c7dfee08c9fa939"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a961de60de61ed79c2c7dfee08c9fa939">&#9670;&#160;</a></span>LogCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::function&lt;void(const std::shared_ptr&lt;<a class="el" href="../../db/d1c/classffmpegkit_1_1_log.html">ffmpegkit::Log</a>&gt; log)&gt; <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a961de60de61ed79c2c7dfee08c9fa939">ffmpegkit::LogCallback</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback that receives logs generated for <code><a class="el" href="../../db/d71/classffmpegkit_1_1_f_fmpeg_kit.html">FFmpegKit</a></code> sessions.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">log</td><td>log entry </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d4/daf/_log_callback_8h_source.html#l00035">35</a> of file <a class="el" href="../../d4/daf/_log_callback_8h_source.html">LogCallback.h</a>.</p>
</div>
</div>
<a id="a909392d52220d37ab6e39bd7f4d6abb1" name="a909392d52220d37ab6e39bd7f4d6abb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a909392d52220d37ab6e39bd7f4d6abb1">&#9670;&#160;</a></span>MediaInformationSessionCompleteCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::function&lt;void(const std::shared_ptr&lt;<a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a>&gt; session)&gt; <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a909392d52220d37ab6e39bd7f4d6abb1">ffmpegkit::MediaInformationSessionCompleteCallback</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function that is invoked when an asynchronous <code><a class="el" href="../../df/d06/classffmpegkit_1_1_media_information.html">MediaInformation</a></code> session has ended. </p>
<p><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html">Session</a> has either SessionStateCompleted or SessionStateFailed state when the callback is invoked. </p>
<p>If it has SessionStateCompleted state, <code><a class="el" href="../../d4/dcf/classffmpegkit_1_1_return_code.html">ReturnCode</a></code> should be checked to see the execution result. </p>
<p>If <code>getState</code> returns SessionStateFailed then <code>getFailStackTrace</code> should be used to get the failure reason. </p><pre>
switch (session-&gt;getState()) {
case SessionStateCompleted:
auto returnCode = session-&gt;getReturnCode();
break;
case SessionStateFailed:
auto failStackTrace = session-&gt;getFailStackTrace();
break;
}
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>session of the completed execution </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../df/d57/_media_information_session_complete_callback_8h_source.html#l00053">53</a> of file <a class="el" href="../../df/d57/_media_information_session_complete_callback_8h_source.html">MediaInformationSessionCompleteCallback.h</a>.</p>
</div>
</div>
<a id="a250a65ad52e13fa88362845eb4b848ef" name="a250a65ad52e13fa88362845eb4b848ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a250a65ad52e13fa88362845eb4b848ef">&#9670;&#160;</a></span>StatisticsCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::function&lt;void(const std::shared_ptr&lt;<a class="el" href="../../d0/de7/classffmpegkit_1_1_statistics.html">ffmpegkit::Statistics</a>&gt; statistics)&gt; <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a250a65ad52e13fa88362845eb4b848ef">ffmpegkit::StatisticsCallback</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback that receives statistics generated for <code><a class="el" href="../../db/d71/classffmpegkit_1_1_f_fmpeg_kit.html">FFmpegKit</a></code> sessions.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">statistics</td><td>statistics entry </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d6/df1/_statistics_callback_8h_source.html#l00035">35</a> of file <a class="el" href="../../d6/df1/_statistics_callback_8h_source.html">StatisticsCallback.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a3726dad678d38ecd08f9af2f142156a4" name="a3726dad678d38ecd08f9af2f142156a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3726dad678d38ecd08f9af2f142156a4">&#9670;&#160;</a></span>Level</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a3726dad678d38ecd08f9af2f142156a4">ffmpegkit::Level</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration type for log levels. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3726dad678d38ecd08f9af2f142156a4a4baea55bfac0c0ac87e3d022c7dfe06e" name="a3726dad678d38ecd08f9af2f142156a4a4baea55bfac0c0ac87e3d022c7dfe06e"></a>LevelAVLogStdErr&#160;</td><td class="fielddoc"><p>This log level is defined by <a class="el" href="../../db/d71/classffmpegkit_1_1_f_fmpeg_kit.html">FFmpegKit</a>. It is used to specify logs printed to stderr by FFmpeg. Logs that has this level are not filtered and always redirected. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3726dad678d38ecd08f9af2f142156a4a601376fad6823274f99a97262f689c2f" name="a3726dad678d38ecd08f9af2f142156a4a601376fad6823274f99a97262f689c2f"></a>LevelAVLogQuiet&#160;</td><td class="fielddoc"><p>Print no output. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3726dad678d38ecd08f9af2f142156a4a6be4cb38f1ff513c977d2d5e37deae42" name="a3726dad678d38ecd08f9af2f142156a4a6be4cb38f1ff513c977d2d5e37deae42"></a>LevelAVLogPanic&#160;</td><td class="fielddoc"><p>Something went really wrong and we will crash now. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3726dad678d38ecd08f9af2f142156a4aeef1c634636b2a03270ba6bab8d2ecf1" name="a3726dad678d38ecd08f9af2f142156a4aeef1c634636b2a03270ba6bab8d2ecf1"></a>LevelAVLogFatal&#160;</td><td class="fielddoc"><p>Something went wrong and recovery is not possible. For example, no header was found for a format which depends on headers or an illegal combination of parameters is used. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3726dad678d38ecd08f9af2f142156a4a34bc76c36c5f97ec84ad0e5e1cd35251" name="a3726dad678d38ecd08f9af2f142156a4a34bc76c36c5f97ec84ad0e5e1cd35251"></a>LevelAVLogError&#160;</td><td class="fielddoc"><p>Something went wrong and cannot losslessly be recovered. However, not all future data is affected. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3726dad678d38ecd08f9af2f142156a4aaa2ab1eddacb480d687f17f0116d7e46" name="a3726dad678d38ecd08f9af2f142156a4aaa2ab1eddacb480d687f17f0116d7e46"></a>LevelAVLogWarning&#160;</td><td class="fielddoc"><p>Something somehow does not look correct. This may or may not lead to problems. An example would be the use of '-vstrict -2'. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3726dad678d38ecd08f9af2f142156a4acfd515b605fe5e71a66f2a47072c4d84" name="a3726dad678d38ecd08f9af2f142156a4acfd515b605fe5e71a66f2a47072c4d84"></a>LevelAVLogInfo&#160;</td><td class="fielddoc"><p>Standard information. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3726dad678d38ecd08f9af2f142156a4ab251e1df59c8c9910f62effc9bbc8631" name="a3726dad678d38ecd08f9af2f142156a4ab251e1df59c8c9910f62effc9bbc8631"></a>LevelAVLogVerbose&#160;</td><td class="fielddoc"><p>Detailed information. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3726dad678d38ecd08f9af2f142156a4a377b674192dd6d0212f3782280342ad3" name="a3726dad678d38ecd08f9af2f142156a4a377b674192dd6d0212f3782280342ad3"></a>LevelAVLogDebug&#160;</td><td class="fielddoc"><p>Stuff which is only useful for libav* developers. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3726dad678d38ecd08f9af2f142156a4acb7d008328737b034c1ac65843c01413" name="a3726dad678d38ecd08f9af2f142156a4acb7d008328737b034c1ac65843c01413"></a>LevelAVLogTrace&#160;</td><td class="fielddoc"><p>Extremely verbose debugging, useful for libav* development. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="../../d2/d4b/_level_8h_source.html#l00028">28</a> of file <a class="el" href="../../d2/d4b/_level_8h_source.html">Level.h</a>.</p>
</div>
</div>
<a id="a11bee89be98423d1dc425a2849001ebe" name="a11bee89be98423d1dc425a2849001ebe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11bee89be98423d1dc425a2849001ebe">&#9670;&#160;</a></span>LogRedirectionStrategy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a11bee89be98423d1dc425a2849001ebe">ffmpegkit::LogRedirectionStrategy</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a11bee89be98423d1dc425a2849001ebea4ac7c7054007119d71549846c2544288" name="a11bee89be98423d1dc425a2849001ebea4ac7c7054007119d71549846c2544288"></a>LogRedirectionStrategyAlwaysPrintLogs&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a11bee89be98423d1dc425a2849001ebea662a08ddb8f44ec2a54b2259108d11b1" name="a11bee89be98423d1dc425a2849001ebea662a08ddb8f44ec2a54b2259108d11b1"></a>LogRedirectionStrategyPrintLogsWhenNoCallbacksDefined&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a11bee89be98423d1dc425a2849001ebeacf82deb57f2cfc6bfac3ab4c9a8e534c" name="a11bee89be98423d1dc425a2849001ebeacf82deb57f2cfc6bfac3ab4c9a8e534c"></a>LogRedirectionStrategyPrintLogsWhenGlobalCallbackNotDefined&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a11bee89be98423d1dc425a2849001ebea3b1e8dc7839b7abe69fe333e37f71936" name="a11bee89be98423d1dc425a2849001ebea3b1e8dc7839b7abe69fe333e37f71936"></a>LogRedirectionStrategyPrintLogsWhenSessionCallbackNotDefined&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a11bee89be98423d1dc425a2849001ebea51a85a2abdd53daab89f93edb3779635" name="a11bee89be98423d1dc425a2849001ebea51a85a2abdd53daab89f93edb3779635"></a>LogRedirectionStrategyNeverPrintLogs&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="../../d6/d42/_log_redirection_strategy_8h_source.html#l00025">25</a> of file <a class="el" href="../../d6/d42/_log_redirection_strategy_8h_source.html">LogRedirectionStrategy.h</a>.</p>
</div>
</div>
<a id="a6d76b34ad27245e8ba161c8f30ab5c8f" name="a6d76b34ad27245e8ba161c8f30ab5c8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d76b34ad27245e8ba161c8f30ab5c8f">&#9670;&#160;</a></span>SessionState</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a6d76b34ad27245e8ba161c8f30ab5c8f">ffmpegkit::SessionState</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a6d76b34ad27245e8ba161c8f30ab5c8faa2b60da11090d170819db698df90f4a2" name="a6d76b34ad27245e8ba161c8f30ab5c8faa2b60da11090d170819db698df90f4a2"></a>SessionStateCreated&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a6d76b34ad27245e8ba161c8f30ab5c8fa384cde9cd29cfe4e94fb4b8f5d3719c1" name="a6d76b34ad27245e8ba161c8f30ab5c8fa384cde9cd29cfe4e94fb4b8f5d3719c1"></a>SessionStateRunning&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a6d76b34ad27245e8ba161c8f30ab5c8fa4e355211ff575fe9e53b5cac1989473e" name="a6d76b34ad27245e8ba161c8f30ab5c8fa4e355211ff575fe9e53b5cac1989473e"></a>SessionStateFailed&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a6d76b34ad27245e8ba161c8f30ab5c8fae395077a2a757c691699536f02cc264f" name="a6d76b34ad27245e8ba161c8f30ab5c8fae395077a2a757c691699536f02cc264f"></a>SessionStateCompleted&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="../../df/d13/_session_state_8h_source.html#l00025">25</a> of file <a class="el" href="../../df/d13/_session_state_8h_source.html">SessionState.h</a>.</p>
</div>
</div>
<a id="ac57fab4209bd25d62c86a99bb459bda2" name="ac57fab4209bd25d62c86a99bb459bda2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac57fab4209bd25d62c86a99bb459bda2">&#9670;&#160;</a></span>Signal</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="../../d2/d25/namespaceffmpegkit.html#ac57fab4209bd25d62c86a99bb459bda2">ffmpegkit::Signal</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac57fab4209bd25d62c86a99bb459bda2a5b4b088da6cf903093a8d7789cee04f9" name="ac57fab4209bd25d62c86a99bb459bda2a5b4b088da6cf903093a8d7789cee04f9"></a>SignalInt&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac57fab4209bd25d62c86a99bb459bda2a45dced6df666a601d492885399b63a82" name="ac57fab4209bd25d62c86a99bb459bda2a45dced6df666a601d492885399b63a82"></a>SignalQuit&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac57fab4209bd25d62c86a99bb459bda2ae1349a4dbeee5769723ceb0b6ce0efee" name="ac57fab4209bd25d62c86a99bb459bda2ae1349a4dbeee5769723ceb0b6ce0efee"></a>SignalPipe&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac57fab4209bd25d62c86a99bb459bda2a7a9761ba37058f9235355143ef34deaa" name="ac57fab4209bd25d62c86a99bb459bda2a7a9761ba37058f9235355143ef34deaa"></a>SignalTerm&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ac57fab4209bd25d62c86a99bb459bda2a253eff2aef02dedda7967818ea2f0639" name="ac57fab4209bd25d62c86a99bb459bda2a253eff2aef02dedda7967818ea2f0639"></a>SignalXcpu&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="../../d5/dce/_signal_8h_source.html#l00025">25</a> of file <a class="el" href="../../d5/dce/_signal_8h_source.html">Signal.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a0481d866378fb1a9636ec138b727112c" name="a0481d866378fb1a9636ec138b727112c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0481d866378fb1a9636ec138b727112c">&#9670;&#160;</a></span>operator&lt;&lt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; ffmpegkit::operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::shared_ptr&lt; <a class="el" href="../../d4/dcf/classffmpegkit_1_1_return_code.html">ffmpegkit::ReturnCode</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>o</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d9/d21/_return_code_8cpp_source.html#l00051">51</a> of file <a class="el" href="../../d9/d21/_return_code_8cpp_source.html">ReturnCode.cpp</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 22 2023 01:27:12 for FFmpegKit Linux API by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink