997 lines
51 KiB
HTML
997 lines
51 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=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FFmpegKit Linux API: ffmpegkit::Session 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 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 Linux API
|
|
 <span id="projectnumber">4.5.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="../../d2/d25/namespaceffmpegkit.html">ffmpegkit</a></li><li class="navelem"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html">Session</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ffmpegkit::Session Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a8f53bebf7a57af94915b55d0ed843f2e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a961de60de61ed79c2c7dfee08c9fa939">ffmpegkit::LogCallback</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a8f53bebf7a57af94915b55d0ed843f2e">getLogCallback</a> () const =0</td></tr>
|
|
<tr class="separator:a8f53bebf7a57af94915b55d0ed843f2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8cc37ef959603974566a41bf8b350afd"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a8cc37ef959603974566a41bf8b350afd">getSessionId</a> () const =0</td></tr>
|
|
<tr class="separator:a8cc37ef959603974566a41bf8b350afd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad60dc768bc3ac021109788d699a3c02f"><td class="memItemLeft" align="right" valign="top">virtual std::chrono::time_point< std::chrono::system_clock > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#ad60dc768bc3ac021109788d699a3c02f">getCreateTime</a> () const =0</td></tr>
|
|
<tr class="separator:ad60dc768bc3ac021109788d699a3c02f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37d0fefa1af768293efbb27cb6f3b963"><td class="memItemLeft" align="right" valign="top">virtual std::chrono::time_point< std::chrono::system_clock > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a37d0fefa1af768293efbb27cb6f3b963">getStartTime</a> () const =0</td></tr>
|
|
<tr class="separator:a37d0fefa1af768293efbb27cb6f3b963"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf74622e964e402e86f86f2fc51516fd"><td class="memItemLeft" align="right" valign="top">virtual std::chrono::time_point< std::chrono::system_clock > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#aaf74622e964e402e86f86f2fc51516fd">getEndTime</a> () const =0</td></tr>
|
|
<tr class="separator:aaf74622e964e402e86f86f2fc51516fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c29ba3c1d1e7cf98ad1cd33ccf80496"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a2c29ba3c1d1e7cf98ad1cd33ccf80496">getDuration</a> () const =0</td></tr>
|
|
<tr class="separator:a2c29ba3c1d1e7cf98ad1cd33ccf80496"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac8c565b60b800c2f53314a3b6ed0d076"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< std::list< std::string > > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#ac8c565b60b800c2f53314a3b6ed0d076">getArguments</a> () const =0</td></tr>
|
|
<tr class="separator:ac8c565b60b800c2f53314a3b6ed0d076"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad0335e493390f541b3990955cf58effb"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#ad0335e493390f541b3990955cf58effb">getCommand</a> () const =0</td></tr>
|
|
<tr class="separator:ad0335e493390f541b3990955cf58effb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a67c262c9ed675a12a78bceefa25905"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< std::list< std::shared_ptr< <a class="el" href="../../db/d1c/classffmpegkit_1_1_log.html">ffmpegkit::Log</a> > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a7a67c262c9ed675a12a78bceefa25905">getAllLogsWithTimeout</a> (const <a class="el" href="../../d2/d36/fftools__ffmpeg__filter_8c.html#a61569f2965b7a369eb10b6d75d410d11">int</a> waitTimeout) const =0</td></tr>
|
|
<tr class="separator:a7a67c262c9ed675a12a78bceefa25905"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5454b0181929ebe18efb4a14a776c396"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< std::list< std::shared_ptr< <a class="el" href="../../db/d1c/classffmpegkit_1_1_log.html">ffmpegkit::Log</a> > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a5454b0181929ebe18efb4a14a776c396">getAllLogs</a> () const =0</td></tr>
|
|
<tr class="separator:a5454b0181929ebe18efb4a14a776c396"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5121d4443a1d5cb048c3433d8743fcd0"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< std::list< std::shared_ptr< <a class="el" href="../../db/d1c/classffmpegkit_1_1_log.html">ffmpegkit::Log</a> > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a5121d4443a1d5cb048c3433d8743fcd0">getLogs</a> () const =0</td></tr>
|
|
<tr class="separator:a5121d4443a1d5cb048c3433d8743fcd0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16fb68a703d240c6e0f24cb69e445f27"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a16fb68a703d240c6e0f24cb69e445f27">getAllLogsAsStringWithTimeout</a> (const <a class="el" href="../../d2/d36/fftools__ffmpeg__filter_8c.html#a61569f2965b7a369eb10b6d75d410d11">int</a> waitTimeout) const =0</td></tr>
|
|
<tr class="separator:a16fb68a703d240c6e0f24cb69e445f27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07cac9cccb5c166fcc62e6f24e66bf81"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a07cac9cccb5c166fcc62e6f24e66bf81">getAllLogsAsString</a> () const =0</td></tr>
|
|
<tr class="separator:a07cac9cccb5c166fcc62e6f24e66bf81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac710f753ff41150e149f30108a6a9902"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#ac710f753ff41150e149f30108a6a9902">getLogsAsString</a> () const =0</td></tr>
|
|
<tr class="separator:ac710f753ff41150e149f30108a6a9902"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3132ed21a2856ccea1bc53f13747b9d1"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a3132ed21a2856ccea1bc53f13747b9d1">getOutput</a> () const =0</td></tr>
|
|
<tr class="separator:a3132ed21a2856ccea1bc53f13747b9d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4975f0b84898dbf73a2d735dc9fed41"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a6d76b34ad27245e8ba161c8f30ab5c8f">ffmpegkit::SessionState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#ad4975f0b84898dbf73a2d735dc9fed41">getState</a> () const =0</td></tr>
|
|
<tr class="separator:ad4975f0b84898dbf73a2d735dc9fed41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e787ead46a84f3e253aa0254c8c1f3c"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="../../d4/dcf/classffmpegkit_1_1_return_code.html">ffmpegkit::ReturnCode</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a6e787ead46a84f3e253aa0254c8c1f3c">getReturnCode</a> () const =0</td></tr>
|
|
<tr class="separator:a6e787ead46a84f3e253aa0254c8c1f3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84d46f5c402e5513b73be1a044052894"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a84d46f5c402e5513b73be1a044052894">getFailStackTrace</a> () const =0</td></tr>
|
|
<tr class="separator:a84d46f5c402e5513b73be1a044052894"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a279d6f2564448ff711d03401fd1e18ba"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a11bee89be98423d1dc425a2849001ebe">LogRedirectionStrategy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a279d6f2564448ff711d03401fd1e18ba">getLogRedirectionStrategy</a> () const =0</td></tr>
|
|
<tr class="separator:a279d6f2564448ff711d03401fd1e18ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a336e447eeb089650b5d31cb655e1e74f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a336e447eeb089650b5d31cb655e1e74f">thereAreAsynchronousMessagesInTransmit</a> () const =0</td></tr>
|
|
<tr class="separator:a336e447eeb089650b5d31cb655e1e74f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45b8d00f933834b0315672b82e44d14c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a45b8d00f933834b0315672b82e44d14c">addLog</a> (const std::shared_ptr< <a class="el" href="../../db/d1c/classffmpegkit_1_1_log.html">ffmpegkit::Log</a> > log)=0</td></tr>
|
|
<tr class="separator:a45b8d00f933834b0315672b82e44d14c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae1197238a848be3de55c3d38a070ebd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#aae1197238a848be3de55c3d38a070ebd">startRunning</a> ()=0</td></tr>
|
|
<tr class="separator:aae1197238a848be3de55c3d38a070ebd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ee68d280a2a15dc654e547273b91116"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a4ee68d280a2a15dc654e547273b91116">complete</a> (const std::shared_ptr< <a class="el" href="../../d4/dcf/classffmpegkit_1_1_return_code.html">ffmpegkit::ReturnCode</a> > returnCode)=0</td></tr>
|
|
<tr class="separator:a4ee68d280a2a15dc654e547273b91116"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0437449324dc9c28a6abbee57b97b478"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a0437449324dc9c28a6abbee57b97b478">fail</a> (const char *error)=0</td></tr>
|
|
<tr class="separator:a0437449324dc9c28a6abbee57b97b478"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4f761bdc94926fb9ec97f21d2a7df02"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#ad4f761bdc94926fb9ec97f21d2a7df02">isFFmpeg</a> () const =0</td></tr>
|
|
<tr class="separator:ad4f761bdc94926fb9ec97f21d2a7df02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2486e9f904b06d9eae1a4a8a047c22ff"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#a2486e9f904b06d9eae1a4a8a047c22ff">isFFprobe</a> () const =0</td></tr>
|
|
<tr class="separator:a2486e9f904b06d9eae1a4a8a047c22ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf6734f48296077fd8a7644960c2e08b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#abf6734f48296077fd8a7644960c2e08b">isMediaInformation</a> () const =0</td></tr>
|
|
<tr class="separator:abf6734f48296077fd8a7644960c2e08b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6e3e93db2042cc25796ca4d3e4135c7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0e/classffmpegkit_1_1_session.html#ab6e3e93db2042cc25796ca4d3e4135c7">cancel</a> ()=0</td></tr>
|
|
<tr class="separator:ab6e3e93db2042cc25796ca4d3e4135c7"><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="../../db/d71/classffmpegkit_1_1_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#l00037">37</a> of file <a class="el" href="../../d0/d5a/_session_8h_source.html">Session.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a45b8d00f933834b0315672b82e44d14c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a45b8d00f933834b0315672b82e44d14c">◆ </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">virtual void ffmpegkit::Session::addLog </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::shared_ptr< <a class="el" href="../../db/d1c/classffmpegkit_1_1_log.html">ffmpegkit::Log</a> > </td>
|
|
<td class="paramname"><em>log</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Adds a new log entry for this session.</p>
|
|
<p>It is invoked internally by <code><a class="el" href="../../db/d71/classffmpegkit_1_1_f_fmpeg_kit.html">FFmpegKit</a></code> library methods. Must not be used by user applications.</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a2a528caf04c52d6d49b9c04aa11d4cac">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab6e3e93db2042cc25796ca4d3e4135c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab6e3e93db2042cc25796ca4d3e4135c7">◆ </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">virtual void ffmpegkit::Session::cancel </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Cancels running the session. </p>
|
|
|
|
<p>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#af67c25c9ba25ec224c70cfffe69e88be">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ee68d280a2a15dc654e547273b91116"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ee68d280a2a15dc654e547273b91116">◆ </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">virtual void ffmpegkit::Session::complete </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::shared_ptr< <a class="el" href="../../d4/dcf/classffmpegkit_1_1_return_code.html">ffmpegkit::ReturnCode</a> > </td>
|
|
<td class="paramname"><em>returnCode</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a9d5be42b5576ee247627d113f74ec851">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0437449324dc9c28a6abbee57b97b478"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0437449324dc9c28a6abbee57b97b478">◆ </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">virtual void ffmpegkit::Session::fail </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>error</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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">error</td><td>error received </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a028bdf7bd5506d9a9c574db0970bf0c2">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5454b0181929ebe18efb4a14a776c396"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5454b0181929ebe18efb4a14a776c396">◆ </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">virtual std::shared_ptr<std::list<std::shared_ptr<<a class="el" href="../../db/d1c/classffmpegkit_1_1_log.html">ffmpegkit::Log</a>> > > ffmpegkit::Session::getAllLogs </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#aac9ea68506e6850c61129387e9267f8b">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a07cac9cccb5c166fcc62e6f24e66bf81"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07cac9cccb5c166fcc62e6f24e66bf81">◆ </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">virtual std::string ffmpegkit::Session::getAllLogsAsString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a45ae0bcffbc0941e69b504e8f9597509">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a16fb68a703d240c6e0f24cb69e445f27"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a16fb68a703d240c6e0f24cb69e445f27">◆ </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">virtual std::string ffmpegkit::Session::getAllLogsAsStringWithTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../d2/d36/fftools__ffmpeg__filter_8c.html#a61569f2965b7a369eb10b6d75d410d11">int</a> </td>
|
|
<td class="paramname"><em>waitTimeout</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#adff747b9c88db9c08dcdba0998bfd4fd">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7a67c262c9ed675a12a78bceefa25905"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7a67c262c9ed675a12a78bceefa25905">◆ </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">virtual std::shared_ptr<std::list<std::shared_ptr<<a class="el" href="../../db/d1c/classffmpegkit_1_1_log.html">ffmpegkit::Log</a>> > > ffmpegkit::Session::getAllLogsWithTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../d2/d36/fftools__ffmpeg__filter_8c.html#a61569f2965b7a369eb10b6d75d410d11">int</a> </td>
|
|
<td class="paramname"><em>waitTimeout</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a8956c557d46197a5c9692493d9767039">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac8c565b60b800c2f53314a3b6ed0d076"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac8c565b60b800c2f53314a3b6ed0d076">◆ </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">virtual std::shared_ptr<std::list<std::string> > ffmpegkit::Session::getArguments </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns command arguments as a list.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>command arguments as a list </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#ad64ef04aef27be8ff64610906e3f1a6b">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad0335e493390f541b3990955cf58effb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad0335e493390f541b3990955cf58effb">◆ </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">virtual std::string ffmpegkit::Session::getCommand </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#abbff9035abb4be844fdec3c1bb85ad7f">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad60dc768bc3ac021109788d699a3c02f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad60dc768bc3ac021109788d699a3c02f">◆ </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">virtual std::chrono::time_point<std::chrono::system_clock> ffmpegkit::Session::getCreateTime </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a6275bb3c30d03d2206592278185d42b4">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2c29ba3c1d1e7cf98ad1cd33ccf80496"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2c29ba3c1d1e7cf98ad1cd33ccf80496">◆ </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">virtual long ffmpegkit::Session::getDuration </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a2e6c6f9f02c25cd8b3094f3fb388a581">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf74622e964e402e86f86f2fc51516fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf74622e964e402e86f86f2fc51516fd">◆ </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">virtual std::chrono::time_point<std::chrono::system_clock> ffmpegkit::Session::getEndTime </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a42c94094ebb152fd0dee322e28f1c832">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a84d46f5c402e5513b73be1a044052894"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84d46f5c402e5513b73be1a044052894">◆ </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">virtual std::string ffmpegkit::Session::getFailStackTrace </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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 an empty string.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>stack trace of the exception received while executing this session, an empty string if session is not started, still running or completed </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#ab2db6272ef27d49949107f1d7657cadc">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f53bebf7a57af94915b55d0ed843f2e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f53bebf7a57af94915b55d0ed843f2e">◆ </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">virtual <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a961de60de61ed79c2c7dfee08c9fa939">ffmpegkit::LogCallback</a> ffmpegkit::Session::getLogCallback </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a5c293803198b3a3aa137efc80bcbf7ab">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a279d6f2564448ff711d03401fd1e18ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a279d6f2564448ff711d03401fd1e18ba">◆ </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">virtual <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a11bee89be98423d1dc425a2849001ebe">LogRedirectionStrategy</a> ffmpegkit::Session::getLogRedirectionStrategy </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#ae123c336330266b34a01da81c7b9b0bb">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5121d4443a1d5cb048c3433d8743fcd0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5121d4443a1d5cb048c3433d8743fcd0">◆ </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">virtual std::shared_ptr<std::list<std::shared_ptr<<a class="el" href="../../db/d1c/classffmpegkit_1_1_log.html">ffmpegkit::Log</a>> > > ffmpegkit::Session::getLogs </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#adf48bfff50be8766d896a718ae3c7102">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac710f753ff41150e149f30108a6a9902"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac710f753ff41150e149f30108a6a9902">◆ </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">virtual std::string ffmpegkit::Session::getLogsAsString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a2a8031eeb92a9857cc8c8273b80d6d9e">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3132ed21a2856ccea1bc53f13747b9d1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3132ed21a2856ccea1bc53f13747b9d1">◆ </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">virtual std::string ffmpegkit::Session::getOutput </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a4c0bf6d0eefd029d9c077dd04b557e20">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6e787ead46a84f3e253aa0254c8c1f3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6e787ead46a84f3e253aa0254c8c1f3c">◆ </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">virtual std::shared_ptr<<a class="el" href="../../d4/dcf/classffmpegkit_1_1_return_code.html">ffmpegkit::ReturnCode</a>> ffmpegkit::Session::getReturnCode </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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 nullptr.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the return code for this session if the session has completed, nullptr if session is not started, still running or failed </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a831bba85f9e0f0011e0ef2a5a0416b05">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8cc37ef959603974566a41bf8b350afd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8cc37ef959603974566a41bf8b350afd">◆ </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">virtual long ffmpegkit::Session::getSessionId </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a3053747e2f546263d68dbdd698f7234b">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a37d0fefa1af768293efbb27cb6f3b963"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a37d0fefa1af768293efbb27cb6f3b963">◆ </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">virtual std::chrono::time_point<std::chrono::system_clock> ffmpegkit::Session::getStartTime </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#aaffadb42d205ff5df0f03e32f190d01d">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad4975f0b84898dbf73a2d735dc9fed41"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad4975f0b84898dbf73a2d735dc9fed41">◆ </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">virtual <a class="el" href="../../d2/d25/namespaceffmpegkit.html#a6d76b34ad27245e8ba161c8f30ab5c8f">ffmpegkit::SessionState</a> ffmpegkit::Session::getState </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#ac09abdfa6ca35b9e47c63e91051e2dd6">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad4f761bdc94926fb9ec97f21d2a7df02"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad4f761bdc94926fb9ec97f21d2a7df02">◆ </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">virtual bool ffmpegkit::Session::isFFmpeg </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a1de92273a4f99fd1afd1333845a50081">ffmpegkit::AbstractSession</a>, <a class="el" href="../../d2/dee/classffmpegkit_1_1_f_fmpeg_session.html#a775982f92212bb2a5d9a94f7c2f00c10">ffmpegkit::FFmpegSession</a>, <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html#a8564e2ec6735cb868c6d78dbc33554f5">ffmpegkit::MediaInformationSession</a>, and <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html#a150f7a4f5f196a3b65433cfb73ed36d4">ffmpegkit::FFprobeSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2486e9f904b06d9eae1a4a8a047c22ff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2486e9f904b06d9eae1a4a8a047c22ff">◆ </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">virtual bool ffmpegkit::Session::isFFprobe </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#afcd5ca2f7f654ca06feaef2de3993a34">ffmpegkit::AbstractSession</a>, <a class="el" href="../../d2/dee/classffmpegkit_1_1_f_fmpeg_session.html#a241bdf03cea442fb29261ff64763faac">ffmpegkit::FFmpegSession</a>, <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html#aa95a1267abc565c3ffc3163085805cdf">ffmpegkit::MediaInformationSession</a>, and <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html#a23da7c24a487747ee61ab0836fb8428c">ffmpegkit::FFprobeSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abf6734f48296077fd8a7644960c2e08b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abf6734f48296077fd8a7644960c2e08b">◆ </a></span>isMediaInformation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ffmpegkit::Session::isMediaInformation </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns whether it is a <code><a class="el" href="../../df/d06/classffmpegkit_1_1_media_information.html">MediaInformation</a></code> session or not.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if it is a <code><a class="el" href="../../df/d06/classffmpegkit_1_1_media_information.html">MediaInformation</a></code> session, false otherwise </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#ae7d0123e0b30a1adb727bdf2173d3313">ffmpegkit::AbstractSession</a>, <a class="el" href="../../d2/dee/classffmpegkit_1_1_f_fmpeg_session.html#acb5ae95c41830a8cd38b989979c42bc1">ffmpegkit::FFmpegSession</a>, <a class="el" href="../../df/db7/classffmpegkit_1_1_media_information_session.html#adb9c1dc1d62ca03a7474c9ace6e9fa89">ffmpegkit::MediaInformationSession</a>, and <a class="el" href="../../da/d5c/classffmpegkit_1_1_f_fprobe_session.html#a17e2678ef159b9e764842d5540b20f89">ffmpegkit::FFprobeSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aae1197238a848be3de55c3d38a070ebd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae1197238a848be3de55c3d38a070ebd">◆ </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">virtual void ffmpegkit::Session::startRunning </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Starts running the session. </p>
|
|
|
|
<p>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#a8f6474fffd31aab725847249432bf659">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a336e447eeb089650b5d31cb655e1e74f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a336e447eeb089650b5d31cb655e1e74f">◆ </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">virtual bool ffmpegkit::Session::thereAreAsynchronousMessagesInTransmit </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</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>Implemented in <a class="el" href="../../d2/d41/classffmpegkit_1_1_abstract_session.html#ac9a016f249e55408155bc4961329e788">ffmpegkit::AbstractSession</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class 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 Mon Aug 15 2022 23:59:53 for FFmpegKit Linux API by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|