This commit is contained in:
2025-08-28 15:13:40 +09:00
parent 6e64d739ac
commit 6404f4176e
3149 changed files with 738551 additions and 335 deletions
@@ -0,0 +1,701 @@
<!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::FFprobeKit Class 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="../../d2/d25/namespaceffmpegkit.html">ffmpegkit</a></li><li class="navelem"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html">FFprobeKit</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle"><div class="title">ffmpegkit::FFprobeKit Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d4/dad/_f_fprobe_kit_8h_source.html">FFprobeKit.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad496ab99f90ad92fe614cb99b9637880"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#ad496ab99f90ad92fe614cb99b9637880">executeWithArguments</a> (const std::list&lt; std::string &gt; &amp;arguments)</td></tr>
<tr class="separator:ad496ab99f90ad92fe614cb99b9637880"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5685bf39272418fb70232abde76cdab7"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#a5685bf39272418fb70232abde76cdab7">executeWithArgumentsAsync</a> (const std::list&lt; std::string &gt; &amp;arguments, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#af3f451cbb99c4dc36e2e2141a33cdf38">FFprobeSessionCompleteCallback</a> completeCallback)</td></tr>
<tr class="separator:a5685bf39272418fb70232abde76cdab7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63f21b9dcd5d721ce0f07982a91c411b"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#a63f21b9dcd5d721ce0f07982a91c411b">executeWithArgumentsAsync</a> (const std::list&lt; std::string &gt; &amp;arguments, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#af3f451cbb99c4dc36e2e2141a33cdf38">FFprobeSessionCompleteCallback</a> completeCallback, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a961de60de61ed79c2c7dfee08c9fa939">ffmpegkit::LogCallback</a> <a class="el" href="../../d8/d45/_f_fmpeg_kit_config_8cpp.html#a7e70dcb2518bb21bffb91bdd7133d329">logCallback</a>)</td></tr>
<tr class="separator:a63f21b9dcd5d721ce0f07982a91c411b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbc72f1fbafb91a5e8f8d5ddfd4cba7e"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#afbc72f1fbafb91a5e8f8d5ddfd4cba7e">execute</a> (const std::string command)</td></tr>
<tr class="separator:afbc72f1fbafb91a5e8f8d5ddfd4cba7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac71efc2144fdcd99b3daf5abf886e317"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#ac71efc2144fdcd99b3daf5abf886e317">executeAsync</a> (const std::string command, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#af3f451cbb99c4dc36e2e2141a33cdf38">FFprobeSessionCompleteCallback</a> completeCallback)</td></tr>
<tr class="separator:ac71efc2144fdcd99b3daf5abf886e317"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed95fef44b783eda6141c64d389a7bce"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#aed95fef44b783eda6141c64d389a7bce">executeAsync</a> (const std::string command, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#af3f451cbb99c4dc36e2e2141a33cdf38">FFprobeSessionCompleteCallback</a> completeCallback, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a961de60de61ed79c2c7dfee08c9fa939">ffmpegkit::LogCallback</a> <a class="el" href="../../d8/d45/_f_fmpeg_kit_config_8cpp.html#a7e70dcb2518bb21bffb91bdd7133d329">logCallback</a>)</td></tr>
<tr class="separator:aed95fef44b783eda6141c64d389a7bce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4209a1e1730019b6e59f6fbd08d5604c"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#a4209a1e1730019b6e59f6fbd08d5604c">getMediaInformation</a> (const std::string path)</td></tr>
<tr class="separator:a4209a1e1730019b6e59f6fbd08d5604c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71cd562f26f7552685745dd233994483"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#a71cd562f26f7552685745dd233994483">getMediaInformation</a> (const std::string path, const <a class="el" href="../../d2/d36/fftools__ffmpeg__filter_8c.html#a61569f2965b7a369eb10b6d75d410d11">int</a> waitTimeout)</td></tr>
<tr class="separator:a71cd562f26f7552685745dd233994483"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe71f0fd406cca0049f79e92948a281b"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#afe71f0fd406cca0049f79e92948a281b">getMediaInformationAsync</a> (const std::string path, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a909392d52220d37ab6e39bd7f4d6abb1">MediaInformationSessionCompleteCallback</a> completeCallback)</td></tr>
<tr class="separator:afe71f0fd406cca0049f79e92948a281b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5297c7a1732d87a8da9232bbf62cddf4"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#a5297c7a1732d87a8da9232bbf62cddf4">getMediaInformationAsync</a> (const std::string path, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a909392d52220d37ab6e39bd7f4d6abb1">MediaInformationSessionCompleteCallback</a> completeCallback, <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a961de60de61ed79c2c7dfee08c9fa939">ffmpegkit::LogCallback</a> <a class="el" href="../../d8/d45/_f_fmpeg_kit_config_8cpp.html#a7e70dcb2518bb21bffb91bdd7133d329">logCallback</a>, const <a class="el" href="../../d2/d36/fftools__ffmpeg__filter_8c.html#a61569f2965b7a369eb10b6d75d410d11">int</a> waitTimeout)</td></tr>
<tr class="separator:a5297c7a1732d87a8da9232bbf62cddf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6854d0a8008dc27f59d02f4b43e753ec"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#a6854d0a8008dc27f59d02f4b43e753ec">getMediaInformationFromCommand</a> (const std::string command)</td></tr>
<tr class="separator:a6854d0a8008dc27f59d02f4b43e753ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec0c1a0ef90a48f8e51630dfd77da6ce"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; std::list&lt; std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#aec0c1a0ef90a48f8e51630dfd77da6ce">listFFprobeSessions</a> ()</td></tr>
<tr class="separator:aec0c1a0ef90a48f8e51630dfd77da6ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3407c34719eee4dbfe76340c856ce691"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr&lt; std::list&lt; std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#a3407c34719eee4dbfe76340c856ce691">listMediaInformationSessions</a> ()</td></tr>
<tr class="separator:a3407c34719eee4dbfe76340c856ce691"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Main class to run <code>FFprobe</code> commands. Supports executing commands both synchronously and asynchronously. </p><pre>
auto session = <a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#afbc72f1fbafb91a5e8f8d5ddfd4cba7e">FFprobeKit::execute</a>("-hide_banner -v error -show_entries format=size -of default=noprint_wrappers=1 file1.mp4");
auto asyncSession = <a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#ac71efc2144fdcd99b3daf5abf886e317">FFprobeKit::executeAsync</a>("-hide_banner -v error -show_entries format=size -of default=noprint_wrappers=1 file1.mp4", [](auto session){ ... });
</pre> <p>Provides overloaded <code>execute</code> methods to define session specific callbacks. </p><pre>
auto session = <a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#ac71efc2144fdcd99b3daf5abf886e317">FFprobeKit::executeAsync</a>("-hide_banner -v error -show_entries format=size -of default=noprint_wrappers=1 file1.mp4", [](auto session){ ... }, [](auto log){ ... }];
</pre> <p>It can extract media information for a file or a url, using getMediaInformation method. </p><pre>
auto session = <a class="el" href="../../df/d3f/classffmpegkit_1_1_f_fprobe_kit.html#a4209a1e1730019b6e59f6fbd08d5604c">FFprobeKit::getMediaInformation</a>("file1.mp4");
</pre>
<p class="definition">Definition at line <a class="el" href="../../d4/dad/_f_fprobe_kit_8h_source.html#l00048">48</a> of file <a class="el" href="../../d4/dad/_f_fprobe_kit_8h_source.html">FFprobeKit.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="afbc72f1fbafb91a5e8f8d5ddfd4cba7e" name="afbc72f1fbafb91a5e8f8d5ddfd4cba7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbc72f1fbafb91a5e8f8d5ddfd4cba7e">&#9670;&#160;</a></span>execute()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt; ffmpegkit::FFprobeKit::execute </td>
<td>(</td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>command</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Synchronously executes FFprobe command provided. Space character is used to split command into arguments. You can use single or double quote characters to specify arguments inside your command.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">command</td><td>FFprobe command </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFprobe session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00050">50</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="ac71efc2144fdcd99b3daf5abf886e317" name="ac71efc2144fdcd99b3daf5abf886e317"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac71efc2144fdcd99b3daf5abf886e317">&#9670;&#160;</a></span>executeAsync() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt; ffmpegkit::FFprobeKit::executeAsync </td>
<td>(</td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#af3f451cbb99c4dc36e2e2141a33cdf38">FFprobeSessionCompleteCallback</a>&#160;</td>
<td class="paramname"><em>completeCallback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFprobe execution for the given command. Space character is used to split the command into arguments. You can use single or double quote characters to specify arguments inside your command.</p>
<p>Note that this method returns immediately and does not wait the execution to complete. You must use an FFprobeSessionCompleteCallback if you want to be notified about the result.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">command</td><td>FFprobe command </td></tr>
<tr><td class="paramname">completeCallback</td><td>callback that will be called when the execution has completed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFprobe session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00056">56</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="aed95fef44b783eda6141c64d389a7bce" name="aed95fef44b783eda6141c64d389a7bce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed95fef44b783eda6141c64d389a7bce">&#9670;&#160;</a></span>executeAsync() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt; ffmpegkit::FFprobeKit::executeAsync </td>
<td>(</td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#af3f451cbb99c4dc36e2e2141a33cdf38">FFprobeSessionCompleteCallback</a>&#160;</td>
<td class="paramname"><em>completeCallback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a961de60de61ed79c2c7dfee08c9fa939">ffmpegkit::LogCallback</a>&#160;</td>
<td class="paramname"><em>logCallback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFprobe execution for the given command. Space character is used to split the command into arguments. You can use single or double quote characters to specify arguments inside your command.</p>
<p>Note that this method returns immediately and does not wait the execution to complete. You must use an FFprobeSessionCompleteCallback if you want to be notified about the result.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">command</td><td>FFprobe command </td></tr>
<tr><td class="paramname">completeCallback</td><td>callback that will be notified when execution has completed </td></tr>
<tr><td class="paramname">logCallback</td><td>callback that will receive logs </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFprobe session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00062">62</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="ad496ab99f90ad92fe614cb99b9637880" name="ad496ab99f90ad92fe614cb99b9637880"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad496ab99f90ad92fe614cb99b9637880">&#9670;&#160;</a></span>executeWithArguments()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt; ffmpegkit::FFprobeKit::executeWithArguments </td>
<td>(</td>
<td class="paramtype">const std::list&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>arguments</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Synchronously executes FFprobe with arguments provided.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arguments</td><td>FFprobe command options/arguments as string array </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFprobe session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00032">32</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="a5685bf39272418fb70232abde76cdab7" name="a5685bf39272418fb70232abde76cdab7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5685bf39272418fb70232abde76cdab7">&#9670;&#160;</a></span>executeWithArgumentsAsync() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt; ffmpegkit::FFprobeKit::executeWithArgumentsAsync </td>
<td>(</td>
<td class="paramtype">const std::list&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>arguments</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#af3f451cbb99c4dc36e2e2141a33cdf38">FFprobeSessionCompleteCallback</a>&#160;</td>
<td class="paramname"><em>completeCallback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFprobe execution with arguments provided.</p>
<p>Note that this method returns immediately and does not wait the execution to complete. You must use an FFprobeSessionCompleteCallback if you want to be notified about the result.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arguments</td><td>FFprobe command options/arguments as string array </td></tr>
<tr><td class="paramname">completeCallback</td><td>callback that will be called when the execution has completed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFprobe session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00038">38</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="a63f21b9dcd5d721ce0f07982a91c411b" name="a63f21b9dcd5d721ce0f07982a91c411b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63f21b9dcd5d721ce0f07982a91c411b">&#9670;&#160;</a></span>executeWithArgumentsAsync() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt; ffmpegkit::FFprobeKit::executeWithArgumentsAsync </td>
<td>(</td>
<td class="paramtype">const std::list&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>arguments</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#af3f451cbb99c4dc36e2e2141a33cdf38">FFprobeSessionCompleteCallback</a>&#160;</td>
<td class="paramname"><em>completeCallback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a961de60de61ed79c2c7dfee08c9fa939">ffmpegkit::LogCallback</a>&#160;</td>
<td class="paramname"><em>logCallback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFprobe execution with arguments provided.</p>
<p>Note that this method returns immediately and does not wait the execution to complete. You must use an FFprobeSessionCompleteCallback if you want to be notified about the result.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arguments</td><td>FFprobe command options/arguments as string array </td></tr>
<tr><td class="paramname">completeCallback</td><td>callback that will be notified when execution has completed </td></tr>
<tr><td class="paramname">logCallback</td><td>callback that will receive logs </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFprobe session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00044">44</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="a4209a1e1730019b6e59f6fbd08d5604c" name="a4209a1e1730019b6e59f6fbd08d5604c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4209a1e1730019b6e59f6fbd08d5604c">&#9670;&#160;</a></span>getMediaInformation() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt; ffmpegkit::FFprobeKit::getMediaInformation </td>
<td>(</td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts media information for the file specified with path.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>path or uri of a media file </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>media information session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00068">68</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="a71cd562f26f7552685745dd233994483" name="a71cd562f26f7552685745dd233994483"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71cd562f26f7552685745dd233994483">&#9670;&#160;</a></span>getMediaInformation() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt; ffmpegkit::FFprobeKit::getMediaInformation </td>
<td>(</td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="../../d2/d36/fftools__ffmpeg__filter_8c.html#a61569f2965b7a369eb10b6d75d410d11">int</a>&#160;</td>
<td class="paramname"><em>waitTimeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts media information for the file specified with path.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>path or uri of a media file </td></tr>
<tr><td class="paramname">waitTimeout</td><td>max time to wait until media information is transmitted </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>media information session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00075">75</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="afe71f0fd406cca0049f79e92948a281b" name="afe71f0fd406cca0049f79e92948a281b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe71f0fd406cca0049f79e92948a281b">&#9670;&#160;</a></span>getMediaInformationAsync() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt; ffmpegkit::FFprobeKit::getMediaInformationAsync </td>
<td>(</td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a909392d52220d37ab6e39bd7f4d6abb1">MediaInformationSessionCompleteCallback</a>&#160;</td>
<td class="paramname"><em>completeCallback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFprobe execution to extract the media information for the specified file.</p>
<p>Note that this method returns immediately and does not wait the execution to complete. You must use an MediaInformationSessionCompleteCallback if you want to be notified about the result.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>path or uri of a media file </td></tr>
<tr><td class="paramname">completeCallback</td><td>callback that will be called when the execution has completed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>media information session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00082">82</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="a5297c7a1732d87a8da9232bbf62cddf4" name="a5297c7a1732d87a8da9232bbf62cddf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5297c7a1732d87a8da9232bbf62cddf4">&#9670;&#160;</a></span>getMediaInformationAsync() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt; ffmpegkit::FFprobeKit::getMediaInformationAsync </td>
<td>(</td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a909392d52220d37ab6e39bd7f4d6abb1">MediaInformationSessionCompleteCallback</a>&#160;</td>
<td class="paramname"><em>completeCallback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d2/d25/namespaceffmpegkit.html#a961de60de61ed79c2c7dfee08c9fa939">ffmpegkit::LogCallback</a>&#160;</td>
<td class="paramname"><em>logCallback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="../../d2/d36/fftools__ffmpeg__filter_8c.html#a61569f2965b7a369eb10b6d75d410d11">int</a>&#160;</td>
<td class="paramname"><em>waitTimeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFprobe execution to extract the media information for the specified file.</p>
<p>Note that this method returns immediately and does not wait the execution to complete. You must use an MediaInformationSessionCompleteCallback if you want to be notified about the result.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>path or uri of a media file </td></tr>
<tr><td class="paramname">completeCallback</td><td>callback that will be notified when execution has completed </td></tr>
<tr><td class="paramname">logCallback</td><td>callback that will receive logs </td></tr>
<tr><td class="paramname">waitTimeout</td><td>max time to wait until media information is transmitted </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>media information session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00089">89</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="a6854d0a8008dc27f59d02f4b43e753ec" name="a6854d0a8008dc27f59d02f4b43e753ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6854d0a8008dc27f59d02f4b43e753ec">&#9670;&#160;</a></span>getMediaInformationFromCommand()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt; ffmpegkit::FFprobeKit::getMediaInformationFromCommand </td>
<td>(</td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>command</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts media information using the command provided asynchronously.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">command</td><td>FFprobe command that prints media information for a file in JSON format </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>media information session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00096">96</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="aec0c1a0ef90a48f8e51630dfd77da6ce" name="aec0c1a0ef90a48f8e51630dfd77da6ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec0c1a0ef90a48f8e51630dfd77da6ce">&#9670;&#160;</a></span>listFFprobeSessions()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; std::list&lt; std::shared_ptr&lt; <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html">ffmpegkit::FFprobeSession</a> &gt; &gt; &gt; ffmpegkit::FFprobeKit::listFFprobeSessions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Lists all FFprobe sessions in the session history.</p>
<dl class="section return"><dt>Returns</dt><dd>all FFprobe sessions in the session history </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00102">102</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<a id="a3407c34719eee4dbfe76340c856ce691" name="a3407c34719eee4dbfe76340c856ce691"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3407c34719eee4dbfe76340c856ce691">&#9670;&#160;</a></span>listMediaInformationSessions()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; std::list&lt; std::shared_ptr&lt; <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html">ffmpegkit::MediaInformationSession</a> &gt; &gt; &gt; ffmpegkit::FFprobeKit::listMediaInformationSessions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Lists all <a class="el" href="../../df/d06/classffmpegkit_1_1_media_information.html">MediaInformation</a> sessions in the session history.</p>
<dl class="section return"><dt>Returns</dt><dd>all <a class="el" href="../../df/d06/classffmpegkit_1_1_media_information.html">MediaInformation</a> sessions in the session history </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html#l00106">106</a> of file <a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="../../d4/dad/_f_fprobe_kit_8h_source.html">FFprobeKit.h</a></li>
<li><a class="el" href="../../d0/dc3/_f_fprobe_kit_8cpp_source.html">FFprobeKit.cpp</a></li>
</ul>
</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>