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

692 lines
39 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 iOS / macOS / tvOS API: FFmpegKit 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 iOS / macOS / tvOS 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="#pub-static-methods">Class Methods</a> </div>
<div class="headertitle"><div class="title">FFmpegKit Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#import &lt;<a class="el" href="../../df/d99/_f_fmpeg_kit_8h_source.html">FFmpegKit.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>
Class Methods</h2></td></tr>
<tr class="memitem:a960b810073d35b64b7c4b4162e249d1c"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#a960b810073d35b64b7c4b4162e249d1c">executeWithArguments:</a></td></tr>
<tr class="separator:a960b810073d35b64b7c4b4162e249d1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b93c54f57d501b4934ae9daee8a84b3"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#a2b93c54f57d501b4934ae9daee8a84b3">executeWithArgumentsAsync:withCompleteCallback:</a></td></tr>
<tr class="separator:a2b93c54f57d501b4934ae9daee8a84b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae15a87059942a4da7d5235a9b2933066"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#ae15a87059942a4da7d5235a9b2933066">executeWithArgumentsAsync:withCompleteCallback:withLogCallback:withStatisticsCallback:</a></td></tr>
<tr class="separator:ae15a87059942a4da7d5235a9b2933066"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26cb4129cf935f108abcd8d590178fbe"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#a26cb4129cf935f108abcd8d590178fbe">executeWithArgumentsAsync:withCompleteCallback:onDispatchQueue:</a></td></tr>
<tr class="separator:a26cb4129cf935f108abcd8d590178fbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3c5a0d4c73c67e31cefe3b57871a875"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#ae3c5a0d4c73c67e31cefe3b57871a875">executeWithArgumentsAsync:withCompleteCallback:withLogCallback:withStatisticsCallback:onDispatchQueue:</a></td></tr>
<tr class="separator:ae3c5a0d4c73c67e31cefe3b57871a875"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff5b335e759f5c98b3d0bfb4941252b5"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#aff5b335e759f5c98b3d0bfb4941252b5">execute:</a></td></tr>
<tr class="separator:aff5b335e759f5c98b3d0bfb4941252b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addef8d23334170c68af592c4e8fc97f6"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#addef8d23334170c68af592c4e8fc97f6">executeAsync:withCompleteCallback:</a></td></tr>
<tr class="separator:addef8d23334170c68af592c4e8fc97f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59c48f0b7013b056d57ddbc78a10c555"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#a59c48f0b7013b056d57ddbc78a10c555">executeAsync:withCompleteCallback:withLogCallback:withStatisticsCallback:</a></td></tr>
<tr class="separator:a59c48f0b7013b056d57ddbc78a10c555"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdf593b6649510b591962bcbe223736e"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#acdf593b6649510b591962bcbe223736e">executeAsync:withCompleteCallback:onDispatchQueue:</a></td></tr>
<tr class="separator:acdf593b6649510b591962bcbe223736e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fd460ea8abb1d11959b95f2cd8777c3"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#a0fd460ea8abb1d11959b95f2cd8777c3">executeAsync:withCompleteCallback:withLogCallback:withStatisticsCallback:onDispatchQueue:</a></td></tr>
<tr class="separator:a0fd460ea8abb1d11959b95f2cd8777c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaeae0cce994de58012f638e5e4fc6041"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#aaeae0cce994de58012f638e5e4fc6041">cancel</a></td></tr>
<tr class="separator:aaeae0cce994de58012f638e5e4fc6041"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dd3f87609bb5679b4b33a87cb88c386"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#a7dd3f87609bb5679b4b33a87cb88c386">cancel:</a></td></tr>
<tr class="separator:a7dd3f87609bb5679b4b33a87cb88c386"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05dae65b8caddff5ca13f9fd1d956424"><td class="memItemLeft" align="right" valign="top">(NSArray *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#a05dae65b8caddff5ca13f9fd1d956424">listSessions</a></td></tr>
<tr class="separator:a05dae65b8caddff5ca13f9fd1d956424"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a173faa92dd9452160cbff53243f17ba2"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html#a173faa92dd9452160cbff53243f17ba2">initialize</a><code> [implementation]</code></td></tr>
<tr class="separator:a173faa92dd9452160cbff53243f17ba2"><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>FFmpeg</code> commands. Supports executing commands both synchronously and asynchronously. </p><pre>
<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *session = [<a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html">FFmpegKit</a> execute:"-i file1.mp4 -c:v libxvid file1.avi"];
FFmpegSession *asyncSession = [FFmpegKit executeAsync:@"-i file1.mp4 -c:v libxvid file1.avi" withCompleteCallback:completeCallback];
&lt;/pre&gt;
&lt;p&gt;Provides overloaded &lt;code&gt;execute&lt;/code&gt; methods to define session specific callbacks.
&lt;pre&gt;
FFmpegSession *asyncSession = [FFmpegKit executeAsync:@"-i file1.mp4 -c:v libxvid file1.avi" withCompleteCallback:completeCallback withLogCallback:logCallback withStatisticsCallback:statisticsCallback];
</pre>
<p class="definition">Definition at line <a class="el" href="../../df/d99/_f_fmpeg_kit_8h_source.html#l00043">43</a> of file <a class="el" href="../../df/d99/_f_fmpeg_kit_8h_source.html">FFmpegKit.h</a>.</p>
</div><h2 class="groupheader">Method Documentation</h2>
<a id="aaeae0cce994de58012f638e5e4fc6041" name="aaeae0cce994de58012f638e5e4fc6041"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaeae0cce994de58012f638e5e4fc6041">&#9670;&#160;</a></span>cancel</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (void) cancel </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cancels all running sessions.</p>
<p>This method does not wait for termination to complete and returns immediately. </p>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="a7dd3f87609bb5679b4b33a87cb88c386" name="a7dd3f87609bb5679b4b33a87cb88c386"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dd3f87609bb5679b4b33a87cb88c386">&#9670;&#160;</a></span>cancel:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (void) cancel: </td>
<td></td>
<td class="paramtype">(long)&#160;</td>
<td class="paramname"><em>sessionId</em></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cancels the session specified with <code>sessionId</code>.</p>
<p>This method does not wait for termination to complete and returns immediately.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sessionId</td><td>id of the session that will be cancelled </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="aff5b335e759f5c98b3d0bfb4941252b5" name="aff5b335e759f5c98b3d0bfb4941252b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff5b335e759f5c98b3d0bfb4941252b5">&#9670;&#160;</a></span>execute:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *) execute: </td>
<td></td>
<td class="paramtype">(NSString*)&#160;</td>
<td class="paramname"><em>command</em></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Synchronously executes FFmpeg 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>FFmpeg command </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFmpeg session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="addef8d23334170c68af592c4e8fc97f6" name="addef8d23334170c68af592c4e8fc97f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addef8d23334170c68af592c4e8fc97f6">&#9670;&#160;</a></span>executeAsync:withCompleteCallback:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *) executeAsync: </td>
<td></td>
<td class="paramtype">(NSString*)&#160;</td>
<td class="paramname"><em>command</em></td>
</tr>
<tr>
<td class="paramkey">withCompleteCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/d47/_f_fmpeg_session_complete_callback_8h.html#a5a25bb218128f30a29ad33b8e8c37edb">FFmpegSessionCompleteCallback</a>)&#160;</td>
<td class="paramname"><em>completeCallback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFmpeg 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 FFmpegSessionCompleteCallback 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>FFmpeg 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>FFmpeg session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="acdf593b6649510b591962bcbe223736e" name="acdf593b6649510b591962bcbe223736e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdf593b6649510b591962bcbe223736e">&#9670;&#160;</a></span>executeAsync:withCompleteCallback:onDispatchQueue:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *) executeAsync: </td>
<td></td>
<td class="paramtype">(NSString*)&#160;</td>
<td class="paramname"><em>command</em></td>
</tr>
<tr>
<td class="paramkey">withCompleteCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/d47/_f_fmpeg_session_complete_callback_8h.html#a5a25bb218128f30a29ad33b8e8c37edb">FFmpegSessionCompleteCallback</a>)&#160;</td>
<td class="paramname"><em>completeCallback</em></td>
</tr>
<tr>
<td class="paramkey">onDispatchQueue:</td>
<td></td>
<td class="paramtype">(dispatch_queue_t)&#160;</td>
<td class="paramname"><em>queue</em>&#160;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFmpeg 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 FFmpegSessionCompleteCallback 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>FFmpeg command </td></tr>
<tr><td class="paramname">completeCallback</td><td>callback that will be called when the execution has completed </td></tr>
<tr><td class="paramname">queue</td><td>dispatch queue that will be used to run this asynchronous operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFmpeg session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="a59c48f0b7013b056d57ddbc78a10c555" name="a59c48f0b7013b056d57ddbc78a10c555"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59c48f0b7013b056d57ddbc78a10c555">&#9670;&#160;</a></span>executeAsync:withCompleteCallback:withLogCallback:withStatisticsCallback:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *) executeAsync: </td>
<td></td>
<td class="paramtype">(NSString*)&#160;</td>
<td class="paramname"><em>command</em></td>
</tr>
<tr>
<td class="paramkey">withCompleteCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/d47/_f_fmpeg_session_complete_callback_8h.html#a5a25bb218128f30a29ad33b8e8c37edb">FFmpegSessionCompleteCallback</a>)&#160;</td>
<td class="paramname"><em>completeCallback</em></td>
</tr>
<tr>
<td class="paramkey">withLogCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d4/daf/_log_callback_8h.html#a85ffce44df85447234279b01b028ddd0">LogCallback</a>)&#160;</td>
<td class="paramname"><em>logCallback</em></td>
</tr>
<tr>
<td class="paramkey">withStatisticsCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/df1/_statistics_callback_8h.html#a833a7ed89310292c64bce2f7e2f6879f">StatisticsCallback</a>)&#160;</td>
<td class="paramname"><em>statisticsCallback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFmpeg 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 FFmpegSessionCompleteCallback 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>FFmpeg command </td></tr>
<tr><td class="paramname">completeCallback</td><td>callback that will be called when the execution has completed </td></tr>
<tr><td class="paramname">logCallback</td><td>callback that will receive logs </td></tr>
<tr><td class="paramname">statisticsCallback</td><td>callback that will receive statistics </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFmpeg session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="a0fd460ea8abb1d11959b95f2cd8777c3" name="a0fd460ea8abb1d11959b95f2cd8777c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0fd460ea8abb1d11959b95f2cd8777c3">&#9670;&#160;</a></span>executeAsync:withCompleteCallback:withLogCallback:withStatisticsCallback:onDispatchQueue:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *) executeAsync: </td>
<td></td>
<td class="paramtype">(NSString*)&#160;</td>
<td class="paramname"><em>command</em></td>
</tr>
<tr>
<td class="paramkey">withCompleteCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/d47/_f_fmpeg_session_complete_callback_8h.html#a5a25bb218128f30a29ad33b8e8c37edb">FFmpegSessionCompleteCallback</a>)&#160;</td>
<td class="paramname"><em>completeCallback</em></td>
</tr>
<tr>
<td class="paramkey">withLogCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d4/daf/_log_callback_8h.html#a85ffce44df85447234279b01b028ddd0">LogCallback</a>)&#160;</td>
<td class="paramname"><em>logCallback</em></td>
</tr>
<tr>
<td class="paramkey">withStatisticsCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/df1/_statistics_callback_8h.html#a833a7ed89310292c64bce2f7e2f6879f">StatisticsCallback</a>)&#160;</td>
<td class="paramname"><em>statisticsCallback</em></td>
</tr>
<tr>
<td class="paramkey">onDispatchQueue:</td>
<td></td>
<td class="paramtype">(dispatch_queue_t)&#160;</td>
<td class="paramname"><em>queue</em>&#160;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFmpeg 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 FFmpegSessionCompleteCallback 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>FFmpeg command </td></tr>
<tr><td class="paramname">completeCallback</td><td>callback that will be called when the execution has completed </td></tr>
<tr><td class="paramname">logCallback</td><td>callback that will receive logs </td></tr>
<tr><td class="paramname">statisticsCallback</td><td>callback that will receive statistics </td></tr>
<tr><td class="paramname">queue</td><td>dispatch queue that will be used to run this asynchronous operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFmpeg session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="a960b810073d35b64b7c4b4162e249d1c" name="a960b810073d35b64b7c4b4162e249d1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a960b810073d35b64b7c4b4162e249d1c">&#9670;&#160;</a></span>executeWithArguments:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *) executeWithArguments: </td>
<td></td>
<td class="paramtype">(NSArray*)&#160;</td>
<td class="paramname"><em>arguments</em></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Synchronously executes FFmpeg with arguments provided.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arguments</td><td>FFmpeg command options/arguments as string array </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFmpeg session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="a2b93c54f57d501b4934ae9daee8a84b3" name="a2b93c54f57d501b4934ae9daee8a84b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b93c54f57d501b4934ae9daee8a84b3">&#9670;&#160;</a></span>executeWithArgumentsAsync:withCompleteCallback:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *) executeWithArgumentsAsync: </td>
<td></td>
<td class="paramtype">(NSArray*)&#160;</td>
<td class="paramname"><em>arguments</em></td>
</tr>
<tr>
<td class="paramkey">withCompleteCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/d47/_f_fmpeg_session_complete_callback_8h.html#a5a25bb218128f30a29ad33b8e8c37edb">FFmpegSessionCompleteCallback</a>)&#160;</td>
<td class="paramname"><em>completeCallback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFmpeg execution with arguments provided.</p>
<p>Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback 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>FFmpeg 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>FFmpeg session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="a26cb4129cf935f108abcd8d590178fbe" name="a26cb4129cf935f108abcd8d590178fbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26cb4129cf935f108abcd8d590178fbe">&#9670;&#160;</a></span>executeWithArgumentsAsync:withCompleteCallback:onDispatchQueue:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *) executeWithArgumentsAsync: </td>
<td></td>
<td class="paramtype">(NSArray*)&#160;</td>
<td class="paramname"><em>arguments</em></td>
</tr>
<tr>
<td class="paramkey">withCompleteCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/d47/_f_fmpeg_session_complete_callback_8h.html#a5a25bb218128f30a29ad33b8e8c37edb">FFmpegSessionCompleteCallback</a>)&#160;</td>
<td class="paramname"><em>completeCallback</em></td>
</tr>
<tr>
<td class="paramkey">onDispatchQueue:</td>
<td></td>
<td class="paramtype">(dispatch_queue_t)&#160;</td>
<td class="paramname"><em>queue</em>&#160;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFmpeg execution with arguments provided.</p>
<p>Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback 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>FFmpeg 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>
<tr><td class="paramname">queue</td><td>dispatch queue that will be used to run this asynchronous operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFmpeg session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="ae15a87059942a4da7d5235a9b2933066" name="ae15a87059942a4da7d5235a9b2933066"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae15a87059942a4da7d5235a9b2933066">&#9670;&#160;</a></span>executeWithArgumentsAsync:withCompleteCallback:withLogCallback:withStatisticsCallback:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *) executeWithArgumentsAsync: </td>
<td></td>
<td class="paramtype">(NSArray*)&#160;</td>
<td class="paramname"><em>arguments</em></td>
</tr>
<tr>
<td class="paramkey">withCompleteCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/d47/_f_fmpeg_session_complete_callback_8h.html#a5a25bb218128f30a29ad33b8e8c37edb">FFmpegSessionCompleteCallback</a>)&#160;</td>
<td class="paramname"><em>completeCallback</em></td>
</tr>
<tr>
<td class="paramkey">withLogCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d4/daf/_log_callback_8h.html#a85ffce44df85447234279b01b028ddd0">LogCallback</a>)&#160;</td>
<td class="paramname"><em>logCallback</em></td>
</tr>
<tr>
<td class="paramkey">withStatisticsCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/df1/_statistics_callback_8h.html#a833a7ed89310292c64bce2f7e2f6879f">StatisticsCallback</a>)&#160;</td>
<td class="paramname"><em>statisticsCallback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFmpeg execution with arguments provided.</p>
<p>Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback 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>FFmpeg 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>
<tr><td class="paramname">logCallback</td><td>callback that will receive logs </td></tr>
<tr><td class="paramname">statisticsCallback</td><td>callback that will receive statistics </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFmpeg session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="ae3c5a0d4c73c67e31cefe3b57871a875" name="ae3c5a0d4c73c67e31cefe3b57871a875"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3c5a0d4c73c67e31cefe3b57871a875">&#9670;&#160;</a></span>executeWithArgumentsAsync:withCompleteCallback:withLogCallback:withStatisticsCallback:onDispatchQueue:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (<a class="el" href="../../da/daf/interface_f_fmpeg_session.html">FFmpegSession</a> *) executeWithArgumentsAsync: </td>
<td></td>
<td class="paramtype">(NSArray*)&#160;</td>
<td class="paramname"><em>arguments</em></td>
</tr>
<tr>
<td class="paramkey">withCompleteCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/d47/_f_fmpeg_session_complete_callback_8h.html#a5a25bb218128f30a29ad33b8e8c37edb">FFmpegSessionCompleteCallback</a>)&#160;</td>
<td class="paramname"><em>completeCallback</em></td>
</tr>
<tr>
<td class="paramkey">withLogCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d4/daf/_log_callback_8h.html#a85ffce44df85447234279b01b028ddd0">LogCallback</a>)&#160;</td>
<td class="paramname"><em>logCallback</em></td>
</tr>
<tr>
<td class="paramkey">withStatisticsCallback:</td>
<td></td>
<td class="paramtype">(<a class="el" href="../../d6/df1/_statistics_callback_8h.html#a833a7ed89310292c64bce2f7e2f6879f">StatisticsCallback</a>)&#160;</td>
<td class="paramname"><em>statisticsCallback</em></td>
</tr>
<tr>
<td class="paramkey">onDispatchQueue:</td>
<td></td>
<td class="paramtype">(dispatch_queue_t)&#160;</td>
<td class="paramname"><em>queue</em>&#160;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts an asynchronous FFmpeg execution with arguments provided.</p>
<p>Note that this method returns immediately and does not wait the execution to complete. You must use an FFmpegSessionCompleteCallback 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>FFmpeg 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>
<tr><td class="paramname">logCallback</td><td>callback that will receive logs </td></tr>
<tr><td class="paramname">statisticsCallback</td><td>callback that will receive statistics </td></tr>
<tr><td class="paramname">queue</td><td>dispatch queue that will be used to run this asynchronous operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FFmpeg session created for this execution </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="a173faa92dd9452160cbff53243f17ba2" name="a173faa92dd9452160cbff53243f17ba2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a173faa92dd9452160cbff53243f17ba2">&#9670;&#160;</a></span>initialize</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">+ (void) initialize </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">implementation</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<a id="a05dae65b8caddff5ca13f9fd1d956424" name="a05dae65b8caddff5ca13f9fd1d956424"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05dae65b8caddff5ca13f9fd1d956424">&#9670;&#160;</a></span>listSessions</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">+ (NSArray *) listSessions </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lists all FFmpeg sessions in the session history.</p>
<dl class="section return"><dt>Returns</dt><dd>all FFmpeg sessions in the session history </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html#l00001">1</a> of file <a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="../../df/d99/_f_fmpeg_kit_8h_source.html">FFmpegKit.h</a></li>
<li><a class="el" href="../../d4/d53/_f_fmpeg_kit_8m_source.html">FFmpegKit.m</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 22 2023 01:27:06 for FFmpegKit iOS / macOS / tvOS 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