991 lines
46 KiB
HTML
991 lines
46 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">
|
|
<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.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FFmpegKit iOS / macOS / tvOS API: <Session> Protocol 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 style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="../../ffmpeg-kit-icon-v9-small.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">FFmpegKit iOS / macOS / tvOS API<span id="projectnumber"> 4.5</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "../../search",'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&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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Instance Methods</a> </div>
|
|
<div class="headertitle"><div class="title"><Session> Protocol Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#import <<a class="el" href="../../d0/d5a/_session_8h_source.html">Session.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Instance Methods</h2></td></tr>
|
|
<tr class="memitem:a24779d12b9fea28a2cb8ab7669c93c29"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../de/d57/_execute_callback_8h.html#ae866bcbfaac596a73cc73249540d2e12">ExecuteCallback</a>) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a24779d12b9fea28a2cb8ab7669c93c29">getExecuteCallback</a></td></tr>
|
|
<tr class="separator:a24779d12b9fea28a2cb8ab7669c93c29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab788f0f4fb8b93ccf627faa9bf06652b"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../d4/daf/_log_callback_8h.html#a85ffce44df85447234279b01b028ddd0">LogCallback</a>) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#ab788f0f4fb8b93ccf627faa9bf06652b">getLogCallback</a></td></tr>
|
|
<tr class="separator:ab788f0f4fb8b93ccf627faa9bf06652b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14e2b9c358fba656896b59dfc8d217d7"><td class="memItemLeft" align="right" valign="top">(long) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a14e2b9c358fba656896b59dfc8d217d7">getSessionId</a></td></tr>
|
|
<tr class="separator:a14e2b9c358fba656896b59dfc8d217d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae40ab5e5d3b185af4e32f59d6fc83196"><td class="memItemLeft" align="right" valign="top">(NSDate *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#ae40ab5e5d3b185af4e32f59d6fc83196">getCreateTime</a></td></tr>
|
|
<tr class="separator:ae40ab5e5d3b185af4e32f59d6fc83196"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab98febffa921552d29c94cf479edb1aa"><td class="memItemLeft" align="right" valign="top">(NSDate *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#ab98febffa921552d29c94cf479edb1aa">getStartTime</a></td></tr>
|
|
<tr class="separator:ab98febffa921552d29c94cf479edb1aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c6f7ba20b0b485b9c0b2a254c4853c0"><td class="memItemLeft" align="right" valign="top">(NSDate *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a0c6f7ba20b0b485b9c0b2a254c4853c0">getEndTime</a></td></tr>
|
|
<tr class="separator:a0c6f7ba20b0b485b9c0b2a254c4853c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8add672fdb6ee376f5b36591aa519160"><td class="memItemLeft" align="right" valign="top">(long) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a8add672fdb6ee376f5b36591aa519160">getDuration</a></td></tr>
|
|
<tr class="separator:a8add672fdb6ee376f5b36591aa519160"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae253ae3ec2c2d0fb3068746a4c6672fc"><td class="memItemLeft" align="right" valign="top">(NSArray *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#ae253ae3ec2c2d0fb3068746a4c6672fc">getArguments</a></td></tr>
|
|
<tr class="separator:ae253ae3ec2c2d0fb3068746a4c6672fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ad0adb6737b268c7e7a056763154620"><td class="memItemLeft" align="right" valign="top">(NSString *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a1ad0adb6737b268c7e7a056763154620">getCommand</a></td></tr>
|
|
<tr class="separator:a1ad0adb6737b268c7e7a056763154620"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3d9782c34aa457f8d61c178d5904080"><td class="memItemLeft" align="right" valign="top">(NSArray *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#af3d9782c34aa457f8d61c178d5904080">getAllLogsWithTimeout:</a></td></tr>
|
|
<tr class="separator:af3d9782c34aa457f8d61c178d5904080"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a617a6c5fe1670d4e1bc2ceec3da8fb1b"><td class="memItemLeft" align="right" valign="top">(NSArray *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a617a6c5fe1670d4e1bc2ceec3da8fb1b">getAllLogs</a></td></tr>
|
|
<tr class="separator:a617a6c5fe1670d4e1bc2ceec3da8fb1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5726b321a91a6d5f7f33749735207578"><td class="memItemLeft" align="right" valign="top">(NSArray *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a5726b321a91a6d5f7f33749735207578">getLogs</a></td></tr>
|
|
<tr class="separator:a5726b321a91a6d5f7f33749735207578"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a084ed168e05642b1325c9554b7d06a94"><td class="memItemLeft" align="right" valign="top">(NSString *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a084ed168e05642b1325c9554b7d06a94">getAllLogsAsStringWithTimeout:</a></td></tr>
|
|
<tr class="separator:a084ed168e05642b1325c9554b7d06a94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38795d1f59e4c06eceed7a80e88e5410"><td class="memItemLeft" align="right" valign="top">(NSString *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a38795d1f59e4c06eceed7a80e88e5410">getAllLogsAsString</a></td></tr>
|
|
<tr class="separator:a38795d1f59e4c06eceed7a80e88e5410"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa90192e2e7b99eb3701bb871b498ea56"><td class="memItemLeft" align="right" valign="top">(NSString *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#aa90192e2e7b99eb3701bb871b498ea56">getLogsAsString</a></td></tr>
|
|
<tr class="separator:aa90192e2e7b99eb3701bb871b498ea56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f16866ca108cc0e2f680e949bdecdbc"><td class="memItemLeft" align="right" valign="top">(NSString *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a8f16866ca108cc0e2f680e949bdecdbc">getOutput</a></td></tr>
|
|
<tr class="separator:a8f16866ca108cc0e2f680e949bdecdbc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a246b35cf2f631aac1a833ea4946ba853"><td class="memItemLeft" align="right" valign="top">(SessionState) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a246b35cf2f631aac1a833ea4946ba853">getState</a></td></tr>
|
|
<tr class="separator:a246b35cf2f631aac1a833ea4946ba853"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5485f197c291f2f492c5a1430558ad6c"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="../../db/d76/interface_return_code.html">ReturnCode</a> *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a5485f197c291f2f492c5a1430558ad6c">getReturnCode</a></td></tr>
|
|
<tr class="separator:a5485f197c291f2f492c5a1430558ad6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38eec854791e072e3165105a21d160bf"><td class="memItemLeft" align="right" valign="top">(NSString *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a38eec854791e072e3165105a21d160bf">getFailStackTrace</a></td></tr>
|
|
<tr class="separator:a38eec854791e072e3165105a21d160bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ece879f38f0d8e469fd200752e8e386"><td class="memItemLeft" align="right" valign="top">(LogRedirectionStrategy) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a7ece879f38f0d8e469fd200752e8e386">getLogRedirectionStrategy</a></td></tr>
|
|
<tr class="separator:a7ece879f38f0d8e469fd200752e8e386"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3959faf8a306cf4dc3624ea532671e44"><td class="memItemLeft" align="right" valign="top">(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a3959faf8a306cf4dc3624ea532671e44">thereAreAsynchronousMessagesInTransmit</a></td></tr>
|
|
<tr class="separator:a3959faf8a306cf4dc3624ea532671e44"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a908e20b8dd5aad50c251c928976eef90"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a908e20b8dd5aad50c251c928976eef90">addLog:</a></td></tr>
|
|
<tr class="separator:a908e20b8dd5aad50c251c928976eef90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f0348ef0afc09f0cbd6c6f0ee5b70ba"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a7f0348ef0afc09f0cbd6c6f0ee5b70ba">startRunning</a></td></tr>
|
|
<tr class="separator:a7f0348ef0afc09f0cbd6c6f0ee5b70ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa47a1375bd0f59f6e8e72e39b2a9f2e9"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#aa47a1375bd0f59f6e8e72e39b2a9f2e9">complete:</a></td></tr>
|
|
<tr class="separator:aa47a1375bd0f59f6e8e72e39b2a9f2e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6abb15f5bee72942fab388106e0908c"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#aa6abb15f5bee72942fab388106e0908c">fail:</a></td></tr>
|
|
<tr class="separator:aa6abb15f5bee72942fab388106e0908c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9167d240e342a8c6ea523422d53cb3b"><td class="memItemLeft" align="right" valign="top">(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#ae9167d240e342a8c6ea523422d53cb3b">isFFmpeg</a></td></tr>
|
|
<tr class="separator:ae9167d240e342a8c6ea523422d53cb3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada8ffc4232f8da7a6478a6a10f00d323"><td class="memItemLeft" align="right" valign="top">(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#ada8ffc4232f8da7a6478a6a10f00d323">isFFprobe</a></td></tr>
|
|
<tr class="separator:ada8ffc4232f8da7a6478a6a10f00d323"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e74551bdb5f78382e8e1dee20752544"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="../../d2/d81/protocol_session-p.html#a5e74551bdb5f78382e8e1dee20752544">cancel</a></td></tr>
|
|
<tr class="separator:a5e74551bdb5f78382e8e1dee20752544"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >Common interface for all <code><a class="el" href="../../d2/d0b/interface_f_fmpeg_kit.html">FFmpegKit</a></code> sessions. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d0/d5a/_session_8h_source.html#l00034">34</a> of file <a class="el" href="../../d0/d5a/_session_8h_source.html">Session.h</a>.</p>
|
|
</div><h2 class="groupheader">Method Documentation</h2>
|
|
<a id="a908e20b8dd5aad50c251c928976eef90" name="a908e20b8dd5aad50c251c928976eef90"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a908e20b8dd5aad50c251c928976eef90">◆ </a></span>addLog:</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) addLog: </td>
|
|
<td></td>
|
|
<td class="paramtype">(<a class="el" href="../../d2/d1c/interface_log.html">Log</a> *) </td>
|
|
<td class="paramname"><em>log</em></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Adds a new log entry for this session.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">log</td><td>log entry </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a3e673629123b8e7dafe0f908585dcea3">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5e74551bdb5f78382e8e1dee20752544" name="a5e74551bdb5f78382e8e1dee20752544"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e74551bdb5f78382e8e1dee20752544">◆ </a></span>cancel</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) cancel </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Cancels running the session. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a5717397901305769b7903c9b15001aa3">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa47a1375bd0f59f6e8e72e39b2a9f2e9" name="aa47a1375bd0f59f6e8e72e39b2a9f2e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa47a1375bd0f59f6e8e72e39b2a9f2e9">◆ </a></span>complete:</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) complete: </td>
|
|
<td></td>
|
|
<td class="paramtype">(<a class="el" href="../../db/d76/interface_return_code.html">ReturnCode</a> *) </td>
|
|
<td class="paramname"><em>returnCode</em></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Completes running the session with the provided return code.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">returnCode</td><td>return code of the execution </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a4b50d157843082cd38da70e7cda1a00f">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa6abb15f5bee72942fab388106e0908c" name="aa6abb15f5bee72942fab388106e0908c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa6abb15f5bee72942fab388106e0908c">◆ </a></span>fail:</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) fail: </td>
|
|
<td></td>
|
|
<td class="paramtype">(NSException *) </td>
|
|
<td class="paramname"><em>exception</em></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Ends running the session with a failure.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">exception</td><td>execution received </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a2d67b484e6449dad034c317a1b16f222">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a617a6c5fe1670d4e1bc2ceec3da8fb1b" name="a617a6c5fe1670d4e1bc2ceec3da8fb1b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a617a6c5fe1670d4e1bc2ceec3da8fb1b">◆ </a></span>getAllLogs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSArray *) getAllLogs </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns all log entries generated for this session. If there are asynchronous messages that are not delivered yet, this method waits for them.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>list of log entries generated for this session </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a70160e2d81aadf34c94f9225b33de804">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a38795d1f59e4c06eceed7a80e88e5410" name="a38795d1f59e4c06eceed7a80e88e5410"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a38795d1f59e4c06eceed7a80e88e5410">◆ </a></span>getAllLogsAsString</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSString *) getAllLogsAsString </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns all log entries generated for this session as a concatenated string. If there are asynchronous messages that are not delivered yet, this method waits for them.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>all log entries generated for this session as a concatenated string </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a127dab931f6a0479a40c62557c403bd1">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a084ed168e05642b1325c9554b7d06a94" name="a084ed168e05642b1325c9554b7d06a94"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a084ed168e05642b1325c9554b7d06a94">◆ </a></span>getAllLogsAsStringWithTimeout:</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSString *) getAllLogsAsStringWithTimeout: </td>
|
|
<td></td>
|
|
<td class="paramtype">(<a class="el" href="../../d2/d36/fftools__ffmpeg__filter_8c.html#a61569f2965b7a369eb10b6d75d410d11">int</a>) </td>
|
|
<td class="paramname"><em>waitTimeout</em></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns all log entries generated for this session as a concatenated string. If there are asynchronous messages that are not delivered yet, this method waits for them until the given timeout.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">waitTimeout</td><td>wait timeout for asynchronous messages in milliseconds </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>all log entries generated for this session as a concatenated string </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#ae9b097754604fcb7fe3e77217ed79c9a">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af3d9782c34aa457f8d61c178d5904080" name="af3d9782c34aa457f8d61c178d5904080"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af3d9782c34aa457f8d61c178d5904080">◆ </a></span>getAllLogsWithTimeout:</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSArray *) getAllLogsWithTimeout: </td>
|
|
<td></td>
|
|
<td class="paramtype">(<a class="el" href="../../d2/d36/fftools__ffmpeg__filter_8c.html#a61569f2965b7a369eb10b6d75d410d11">int</a>) </td>
|
|
<td class="paramname"><em>waitTimeout</em></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns all log entries generated for this session. If there are asynchronous messages that are not delivered yet, this method waits for them until the given timeout.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">waitTimeout</td><td>wait timeout for asynchronous messages in milliseconds </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>list of log entries generated for this session </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a33e87a26db76796838e3ebc98372e28f">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae253ae3ec2c2d0fb3068746a4c6672fc" name="ae253ae3ec2c2d0fb3068746a4c6672fc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae253ae3ec2c2d0fb3068746a4c6672fc">◆ </a></span>getArguments</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSArray *) getArguments </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns command arguments as an array.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>command arguments as an array </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a6fcd5fea52b0cc8ba7365f826e771937">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1ad0adb6737b268c7e7a056763154620" name="a1ad0adb6737b268c7e7a056763154620"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1ad0adb6737b268c7e7a056763154620">◆ </a></span>getCommand</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSString *) getCommand </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns command arguments as a concatenated string.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>command arguments as a concatenated string </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a8b7f6aae55d44c3c892077345e914a13">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae40ab5e5d3b185af4e32f59d6fc83196" name="ae40ab5e5d3b185af4e32f59d6fc83196"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae40ab5e5d3b185af4e32f59d6fc83196">◆ </a></span>getCreateTime</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSDate *) getCreateTime </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns session create time.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>session create time </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a54aa9b8397a1d1f4ab6956a75e93cc27">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8add672fdb6ee376f5b36591aa519160" name="a8add672fdb6ee376f5b36591aa519160"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8add672fdb6ee376f5b36591aa519160">◆ </a></span>getDuration</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (long) getDuration </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns the time taken to execute this session.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>time taken to execute this session in milliseconds or zero (0) if the session is not over yet </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#ae2f37b66f6ca7bd65caf9d009bef2ac9">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c6f7ba20b0b485b9c0b2a254c4853c0" name="a0c6f7ba20b0b485b9c0b2a254c4853c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c6f7ba20b0b485b9c0b2a254c4853c0">◆ </a></span>getEndTime</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSDate *) getEndTime </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns session end time.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>session end time </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a64aef70b84ca3f54ab5de0c3733341f9">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a24779d12b9fea28a2cb8ab7669c93c29" name="a24779d12b9fea28a2cb8ab7669c93c29"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a24779d12b9fea28a2cb8ab7669c93c29">◆ </a></span>getExecuteCallback</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (<a class="el" href="../../de/d57/_execute_callback_8h.html#ae866bcbfaac596a73cc73249540d2e12">ExecuteCallback</a>) getExecuteCallback </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns the session specific execute callback.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>session specific execute callback </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a8b799700f39c9e6b9c936caa3f628117">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a38eec854791e072e3165105a21d160bf" name="a38eec854791e072e3165105a21d160bf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a38eec854791e072e3165105a21d160bf">◆ </a></span>getFailStackTrace</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSString *) getFailStackTrace </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns the stack trace of the exception received while executing this session. </p>
|
|
<p >The stack trace is only set for sessions that end with SessionStateFailed state. For sessions that has SessionStateCompleted state this method returns nil.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>stack trace of the exception received while executing this session, nil if session is not started, still running or completed </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#ad263436dedfd63bbc20473a398dcff72">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab788f0f4fb8b93ccf627faa9bf06652b" name="ab788f0f4fb8b93ccf627faa9bf06652b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab788f0f4fb8b93ccf627faa9bf06652b">◆ </a></span>getLogCallback</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (<a class="el" href="../../d4/daf/_log_callback_8h.html#a85ffce44df85447234279b01b028ddd0">LogCallback</a>) getLogCallback </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns the session specific log callback.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>session specific log callback </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a5714b1ddee86cfd0750b28677b3e6fe5">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7ece879f38f0d8e469fd200752e8e386" name="a7ece879f38f0d8e469fd200752e8e386"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7ece879f38f0d8e469fd200752e8e386">◆ </a></span>getLogRedirectionStrategy</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (LogRedirectionStrategy) getLogRedirectionStrategy </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns session specific log redirection strategy.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>session specific log redirection strategy </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a6457c388c0f36d0f9f5f1f87c3a9e8b9">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5726b321a91a6d5f7f33749735207578" name="a5726b321a91a6d5f7f33749735207578"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5726b321a91a6d5f7f33749735207578">◆ </a></span>getLogs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSArray *) getLogs </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns all log entries delivered for this session. Note that if there are asynchronous messages that are not delivered yet, this method will not wait for them and will return immediately.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>list of log entries received for this session </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#ae18e2d794ebc1c926d01fc6461dd3396">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa90192e2e7b99eb3701bb871b498ea56" name="aa90192e2e7b99eb3701bb871b498ea56"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa90192e2e7b99eb3701bb871b498ea56">◆ </a></span>getLogsAsString</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSString *) getLogsAsString </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns all log entries delivered for this session as a concatenated string. Note that if there are asynchronous messages that are not delivered yet, this method will not wait for them and will return immediately.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>list of log entries received for this session </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a3ab5a65f466988f765460f79e25fbc5f">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f16866ca108cc0e2f680e949bdecdbc" name="a8f16866ca108cc0e2f680e949bdecdbc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f16866ca108cc0e2f680e949bdecdbc">◆ </a></span>getOutput</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSString *) getOutput </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns the log output generated while running the session.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>log output generated </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a27e97db93a99e21125f26bc9ba2480e7">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5485f197c291f2f492c5a1430558ad6c" name="a5485f197c291f2f492c5a1430558ad6c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5485f197c291f2f492c5a1430558ad6c">◆ </a></span>getReturnCode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (<a class="el" href="../../db/d76/interface_return_code.html">ReturnCode</a> *) getReturnCode </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns the return code for this session. Note that return code is only set for sessions that end with SessionStateCompleted state. If a session is not started, still running or failed then this method returns nil.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the return code for this session if the session is completed, nil if session is not started, still running or failed </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#ab5182b56813e4571b0ced29e86499938">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a14e2b9c358fba656896b59dfc8d217d7" name="a14e2b9c358fba656896b59dfc8d217d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a14e2b9c358fba656896b59dfc8d217d7">◆ </a></span>getSessionId</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (long) getSessionId </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns the session identifier.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>session identifier </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a7bb11b933971a6bd7cda75deaeb174bf">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab98febffa921552d29c94cf479edb1aa" name="ab98febffa921552d29c94cf479edb1aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab98febffa921552d29c94cf479edb1aa">◆ </a></span>getStartTime</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (NSDate *) getStartTime </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns session start time.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>session start time </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a5cd13f2135a14bf6dee55a7606168969">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a246b35cf2f631aac1a833ea4946ba853" name="a246b35cf2f631aac1a833ea4946ba853"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a246b35cf2f631aac1a833ea4946ba853">◆ </a></span>getState</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (SessionState) getState </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns the state of the session.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>state of the session </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a8843a6a907181bb96d43297974661519">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae9167d240e342a8c6ea523422d53cb3b" name="ae9167d240e342a8c6ea523422d53cb3b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9167d240e342a8c6ea523422d53cb3b">◆ </a></span>isFFmpeg</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (BOOL) isFFmpeg </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns whether it is an <code>FFmpeg</code> session or not.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if it is an <code>FFmpeg</code> session, false otherwise </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#ab9dc47ada98d30cd2963d47bc9a5cd4a">AbstractSession</a>, <a class="el" href="../../da/daf/interface_f_fmpeg_session.html#ab7fb18bda8256223efe12fe97e9ee553">FFmpegSession</a>, and <a class="el" href="../../dd/d15/interface_f_fprobe_session.html#a82863529b720fe4a82e31ca522092c05">FFprobeSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ada8ffc4232f8da7a6478a6a10f00d323" name="ada8ffc4232f8da7a6478a6a10f00d323"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ada8ffc4232f8da7a6478a6a10f00d323">◆ </a></span>isFFprobe</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (BOOL) isFFprobe </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns whether it is an <code>FFprobe</code> session or not.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if it is an <code>FFprobe</code> session, false otherwise </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a29823b04e8bb16c36e028e4863467990">AbstractSession</a>, <a class="el" href="../../da/daf/interface_f_fmpeg_session.html#ace8a087e984202c06d15c69d93a183fa">FFmpegSession</a>, and <a class="el" href="../../dd/d15/interface_f_fprobe_session.html#ac0468e217248fe18d8a9ef1e4c82d273">FFprobeSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7f0348ef0afc09f0cbd6c6f0ee5b70ba" name="a7f0348ef0afc09f0cbd6c6f0ee5b70ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f0348ef0afc09f0cbd6c6f0ee5b70ba">◆ </a></span>startRunning</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) startRunning </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Starts running the session. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#a6bde056d4edf8ebb9972838428f67e79">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3959faf8a306cf4dc3624ea532671e44" name="a3959faf8a306cf4dc3624ea532671e44"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3959faf8a306cf4dc3624ea532671e44">◆ </a></span>thereAreAsynchronousMessagesInTransmit</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (BOOL) thereAreAsynchronousMessagesInTransmit </td>
|
|
<td></td>
|
|
<td class="paramname"></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">required</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns whether there are still asynchronous messages being transmitted for this session or not.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if there are still asynchronous messages being transmitted, false otherwise </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="../../db/de2/interface_abstract_session.html#ad56d1e970d591ea6898ff4fc09d75d71">AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this protocol was generated from the following file:<ul>
|
|
<li><a class="el" href="../../d0/d5a/_session_8h_source.html">Session.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Sep 18 2021 14:51:17 for FFmpegKit iOS / macOS / tvOS API by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
|
|
</small></address>
|
|
</body>
|
|
</html>
|