ffmpeg-kit/docs/apple/html/d0/d5a/_session_8h_source.html
2023-08-22 23:45:47 +03:00

183 lines
17 KiB
HTML

<!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: Session.h Source File</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="headertitle"><div class="title">Session.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../d0/d5a/_session_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"><a class="line" href="../../d2/d81/protocol_session-p.html#a908e20b8dd5aad50c251c928976eef90"> 1</a></span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright (c) 2021 Taner Sener</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * This file is part of FFmpegKit.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> *</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * FFmpegKit is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * it under the terms of the GNU Lesser General License as published by</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * (at your option) any later version.</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * FFmpegKit is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * GNU Lesser General License for more details.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> *</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * You should have received a copy of the GNU Lesser General License</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * along with FFmpegKit. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef FFMPEG_KIT_SESSION_H</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define FFMPEG_KIT_SESSION_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#import &lt;Foundation/Foundation.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#import &quot;<a class="code" href="../../da/df4/_log_8h.html">Log.h</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#import &quot;<a class="code" href="../../d4/daf/_log_callback_8h.html">LogCallback.h</a>&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#import &quot;<a class="code" href="../../d6/d42/_log_redirection_strategy_8h.html">LogRedirectionStrategy.h</a>&quot;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#import &quot;<a class="code" href="../../d0/d19/_return_code_8h.html">ReturnCode.h</a>&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#import &quot;<a class="code" href="../../df/d13/_session_state_8h.html">SessionState.h</a>&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="../../d2/d81/protocol_session-p.html"> 33</a></span><span class="keyword">@protocol </span>Session</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">@required</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>- (<a class="code hl_typedef" href="../../d4/daf/_log_callback_8h.html#a85ffce44df85447234279b01b028ddd0">LogCallback</a>)getLogCallback;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>- (long)getSessionId;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>- (NSDate*)getCreateTime;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>- (NSDate*)getStartTime;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span>- (NSDate*)getEndTime;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>- (long)getDuration;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span>- (NSArray*)getArguments;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span>- (NSString*)getCommand;</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>- (NSArray*)getAllLogsWithTimeout:(<span class="keywordtype">int</span>)waitTimeout;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span>- (NSArray*)getAllLogs;</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span>- (NSArray*)getLogs;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span>- (NSString*)getAllLogsAsStringWithTimeout:(<span class="keywordtype">int</span>)waitTimeout;</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span>- (NSString*)getAllLogsAsString;</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span>- (NSString*)getLogsAsString;</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span>- (NSString*)getOutput;</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span>- (SessionState)getState;</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> </div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span>- (<a class="code hl_class" href="../../db/d76/interface_return_code.html">ReturnCode</a>*)getReturnCode;</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> </div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span>- (NSString*)getFailStackTrace;</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span>- (LogRedirectionStrategy)getLogRedirectionStrategy;</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> </div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span>- (BOOL)thereAreAsynchronousMessagesInTransmit;</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span> </div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span>- (void)addLog:(<a class="code hl_class" href="../../d2/d1c/interface_log.html">Log</a>*)log;</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> </div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span>- (void)startRunning;</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> </div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span>- (void)complete:(<a class="code hl_class" href="../../db/d76/interface_return_code.html">ReturnCode</a>*)returnCode;</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> </div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span>- (void)fail:(NSException*)exception;</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> </div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span>- (BOOL)isFFmpeg;</div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> </div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span>- (BOOL)isFFprobe;</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> </div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span>- (BOOL)isMediaInformation;</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span> </div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"> 251</span>- (void)cancel;</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span> </div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span><span class="keyword">@end</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span> </div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span><span class="preprocessor">#endif </span><span class="comment">// FFMPEG_KIT_SESSION_H</span></div>
<div class="ttc" id="a_log_8h_html"><div class="ttname"><a href="../../da/df4/_log_8h.html">Log.h</a></div></div>
<div class="ttc" id="a_log_callback_8h_html"><div class="ttname"><a href="../../d4/daf/_log_callback_8h.html">LogCallback.h</a></div></div>
<div class="ttc" id="a_log_callback_8h_html_a85ffce44df85447234279b01b028ddd0"><div class="ttname"><a href="../../d4/daf/_log_callback_8h.html#a85ffce44df85447234279b01b028ddd0">LogCallback</a></div><div class="ttdeci">void(^ LogCallback)(Log *log)</div><div class="ttdef"><b>Definition</b> <a href="../../d4/daf/_log_callback_8h_source.html#l00031">LogCallback.h:31</a></div></div>
<div class="ttc" id="a_log_redirection_strategy_8h_html"><div class="ttname"><a href="../../d6/d42/_log_redirection_strategy_8h.html">LogRedirectionStrategy.h</a></div></div>
<div class="ttc" id="a_return_code_8h_html"><div class="ttname"><a href="../../d0/d19/_return_code_8h.html">ReturnCode.h</a></div></div>
<div class="ttc" id="a_session_state_8h_html"><div class="ttname"><a href="../../df/d13/_session_state_8h.html">SessionState.h</a></div></div>
<div class="ttc" id="ainterface_log_html"><div class="ttname"><a href="../../d2/d1c/interface_log.html">Log</a></div><div class="ttdef"><b>Definition</b> <a href="../../da/df4/_log_8h_source.html#l00028">Log.h:29</a></div></div>
<div class="ttc" id="ainterface_return_code_html"><div class="ttname"><a href="../../db/d76/interface_return_code.html">ReturnCode</a></div><div class="ttdef"><b>Definition</b> <a href="../../d0/d19/_return_code_8h_source.html#l00030">ReturnCode.h:31</a></div></div>
</div><!-- fragment --></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>