<!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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: FFMPEG 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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classFFMPEG-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FFMPEG Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This plugin class reads and writes sounds via ffmpeg.
<a href="classFFMPEG.html#details">More...</a></p>
<p><code>#include <<a class="el" href="FFMPEG_8h_source.html">FFMPEG.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for FFMPEG:</div>
<div class="dyncontent">
<div class="center"><img src="classFFMPEG__inherit__graph.png" border="0" usemap="#FFMPEG_inherit__map" alt="Inheritance graph"/></div>
<map name="FFMPEG_inherit__map" id="FFMPEG_inherit__map">
<area shape="rect" title="This plugin class reads and writes sounds via ffmpeg." alt="" coords="62,80,138,107"/>
<area shape="rect" href="classIFileInput.html" title="The IFileInput interface represents a file input plugin that can create file input readers from filen..." alt="" coords="5,5,85,32"/>
<area shape="rect" href="classIFileOutput.html" title="The IFileOutput interface represents a file output plugin that can write files." alt="" coords="109,5,200,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:ad53410e210d1b1ace3ee67724d43bd16"><td class="memItemLeft" align="right" valign="top"><a id="ad53410e210d1b1ace3ee67724d43bd16"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFMPEG.html#ad53410e210d1b1ace3ee67724d43bd16">FFMPEG</a> ()</td></tr>
<tr class="memdesc:ad53410e210d1b1ace3ee67724d43bd16"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new ffmpeg plugin. <br /></td></tr>
<tr class="separator:ad53410e210d1b1ace3ee67724d43bd16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae0555b22ba32d180ee8ea010368a721"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFMPEG.html#aae0555b22ba32d180ee8ea010368a721">createReader</a> (std::string filename)</td></tr>
<tr class="memdesc:aae0555b22ba32d180ee8ea010368a721"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reader for a file to be read. <a href="#aae0555b22ba32d180ee8ea010368a721">More...</a><br /></td></tr>
<tr class="separator:aae0555b22ba32d180ee8ea010368a721"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade323997e1ad5e6fc1f32f6087b858aa"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFMPEG.html#ade323997e1ad5e6fc1f32f6087b858aa">createReader</a> (std::shared_ptr< <a class="el" href="classBuffer.html">Buffer</a> > buffer)</td></tr>
<tr class="memdesc:ade323997e1ad5e6fc1f32f6087b858aa"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reader for a file to be read from memory. <a href="#ade323997e1ad5e6fc1f32f6087b858aa">More...</a><br /></td></tr>
<tr class="separator:ade323997e1ad5e6fc1f32f6087b858aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2725a96258c3c5e2a8d68f2f25544f1c"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classIWriter.html">IWriter</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFMPEG.html#a2725a96258c3c5e2a8d68f2f25544f1c">createWriter</a> (std::string filename, <a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> specs, <a class="el" href="IWriter_8h.html#a5cf5525d31d834a76660f18724233639">Container</a> format, <a class="el" href="IWriter_8h.html#a87487bf84e831b40083eb736cc1a237c">Codec</a> codec, unsigned int bitrate)</td></tr>
<tr class="memdesc:a2725a96258c3c5e2a8d68f2f25544f1c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new file writer. <a href="#a2725a96258c3c5e2a8d68f2f25544f1c">More...</a><br /></td></tr>
<tr class="separator:a2725a96258c3c5e2a8d68f2f25544f1c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a71b67b0e7c2bcea1a9dd5ec62730d444"><td class="memItemLeft" align="right" valign="top"><a id="a71b67b0e7c2bcea1a9dd5ec62730d444"></a>
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFFMPEG.html#a71b67b0e7c2bcea1a9dd5ec62730d444">registerPlugin</a> ()</td></tr>
<tr class="memdesc:a71b67b0e7c2bcea1a9dd5ec62730d444"><td class="mdescLeft"> </td><td class="mdescRight">Registers this plugin. <br /></td></tr>
<tr class="separator:a71b67b0e7c2bcea1a9dd5ec62730d444"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This plugin class reads and writes sounds via ffmpeg. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aae0555b22ba32d180ee8ea010368a721"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae0555b22ba32d180ee8ea010368a721">◆ </a></span>createReader() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::shared_ptr<<a class="el" href="classIReader.html">IReader</a>> FFMPEG::createReader </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a reader for a file to be read. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>Path to the file to be read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The reader that reads the file. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classException.html" title="The Exception class is the general exception base class.">Exception</a></td><td>Thrown if the file specified cannot be read. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classIFileInput.html#a68772ef755efdcda211e38bc8bb7e650">IFileInput</a>.</p>
</div>
</div>
<a id="ade323997e1ad5e6fc1f32f6087b858aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade323997e1ad5e6fc1f32f6087b858aa">◆ </a></span>createReader() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::shared_ptr<<a class="el" href="classIReader.html">IReader</a>> FFMPEG::createReader </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classBuffer.html">Buffer</a> > </td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a reader for a file to be read from memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>The in-memory file buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The reader that reads the file. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classException.html" title="The Exception class is the general exception base class.">Exception</a></td><td>Thrown if the file specified cannot be read. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classIFileInput.html#aa473f2059702552c108eaa665df7428f">IFileInput</a>.</p>
</div>
</div>
<a id="a2725a96258c3c5e2a8d68f2f25544f1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2725a96258c3c5e2a8d68f2f25544f1c">◆ </a></span>createWriter()</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="classIWriter.html">IWriter</a>> FFMPEG::createWriter </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> </td>
<td class="paramname"><em>specs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="IWriter_8h.html#a5cf5525d31d834a76660f18724233639">Container</a> </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="IWriter_8h.html#a87487bf84e831b40083eb736cc1a237c">Codec</a> </td>
<td class="paramname"><em>codec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>bitrate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new file writer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>The path to the file to be written. </td></tr>
<tr><td class="paramname">specs</td><td>The file's audio specification. </td></tr>
<tr><td class="paramname">format</td><td>The file's container format. </td></tr>
<tr><td class="paramname">codec</td><td>The codec used for encoding the audio data. </td></tr>
<tr><td class="paramname">bitrate</td><td>The bitrate for encoding. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classException.html" title="The Exception class is the general exception base class.">Exception</a></td><td>Thrown if the file specified cannot be written. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classIFileOutput.html#a11b21d766b2af5361b998bce3a9e0f37">IFileOutput</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ffmpeg/<a class="el" href="FFMPEG_8h_source.html">FFMPEG.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
968
