dan/ffmpeg-mappable-media
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Move API folder

Browse source
This commit is contained in:
grosroro 2012-05-30 12:37:30 +02:00
commit e59f411c88
63 changed files with 9236 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

299
docs/API/FFMpeg/Format/Audio/DefaultAudio.html Normal file
View file

@ -0,0 +1,299 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\Audio\DefaultAudio | PHP FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
</head>
<body id="class">
<div class="header">
<ul>
<li><a href="../../../classes.html">Classes</a></li>
<li><a href="../../../namespaces.html">Namespaces</a></li>
<li><a href="../../../interfaces.html">Interfaces</a></li>
<li><a href="../../../doc-index.html">Index</a></li>
</ul>
<div id="title">PHP FFMpeg API</div>
<div class="type">Class</div>
<h1><a href="../../../FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a>\DefaultAudio</h1>
</div>
<div class="content">
<p>abstract class <strong>DefaultAudio</strong> implements
<a href="../../../FFMpeg/Format/Audio/ResamplableAudio.html"><abbr title="FFMpeg\Format\Audio\ResamplableAudio">ResamplableAudio</abbr></a>, <a href="../../../FFMpeg/Format/Audio/InteractiveAudio.html"><abbr title="FFMpeg\Format\Audio\InteractiveAudio">InteractiveAudio</abbr></a></p>
<div class="description">
<p>The abstract default Audio format</p>
<p></p>
</div>
<h2>Methods</h2>
<table>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getExtraParams">getExtraParams</a>()
<p>Returns extra parameters for the encoding</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAudioCodec">getAudioCodec</a>()
<p>{@inheritdoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec)
<p>Set the audio codec, Should be in the available ones, otherwise an exception is thrown</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getAudioSampleRate">getAudioSampleRate</a>()
<p>Get the audio sample rate</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioSampleRate">setAudioSampleRate</a>(integer $audioSampleRate)
<p>Set the audio sample rate</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>{@inheritdoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setKiloBitrate">setKiloBitrate</a>(int $kiloBitrate)
<p>Set the kiloBitrate value</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getExtraParams">
<div class="location">at line 32</div>
<code> public string
<strong>getExtraParams</strong>()</code>
</h3>
<div class="details">
<p>Returns extra parameters for the encoding</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAudioCodec">
<div class="location">at line 40</div>
<code> public
<strong>getAudioCodec</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setAudioCodec">
<div class="location">at line 52</div>
<code> public
<strong>setAudioCodec</strong>(string $audioCodec)</code>
</h3>
<div class="details">
<p>Set the audio codec, Should be in the available ones, otherwise an exception is thrown</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>string</td>
<td>$audioCodec</td>
<td></td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAudioSampleRate">
<div class="location">at line 69</div>
<code> public integer
<strong>getAudioSampleRate</strong>()</code>
</h3>
<div class="details">
<p>Get the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setAudioSampleRate">
<div class="location">at line 80</div>
<code> public
<strong>setAudioSampleRate</strong>(integer $audioSampleRate)</code>
</h3>
<div class="details">
<p>Set the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$audioSampleRate</td>
<td></td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getKiloBitrate">
<div class="location">at line 94</div>
<code> public
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setKiloBitrate">
<div class="location">at line 105</div>
<code> public
<strong>setKiloBitrate</strong>(int $kiloBitrate)</code>
</h3>
<div class="details">
<p>Set the kiloBitrate value</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>int</td>
<td>$kiloBitrate</td>
<td>integer $kiloBitrate</td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
</div>
</body>
</html>

323
docs/API/FFMpeg/Format/Audio/Flac.html Normal file
View file

@ -0,0 +1,323 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\Audio\Flac | PHP FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
</head>
<body id="class">
<div class="header">
<ul>
<li><a href="../../../classes.html">Classes</a></li>
<li><a href="../../../namespaces.html">Namespaces</a></li>
<li><a href="../../../interfaces.html">Interfaces</a></li>
<li><a href="../../../doc-index.html">Index</a></li>
</ul>
<div id="title">PHP FFMpeg API</div>
<div class="type">Class</div>
<h1><a href="../../../FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a>\Flac</h1>
</div>
<div class="content">
<p>class <strong>Flac</strong> extends <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></p>
<div class="description">
<p>The Flac audio format</p>
<p></p>
</div>
<h2>Methods</h2>
<table>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getExtraParams">getExtraParams</a>()
<p>Returns extra parameters for the encoding</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAudioCodec">getAudioCodec</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec)
<p>Set the audio codec, Should be in the available ones, otherwise an exception is thrown</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getAudioSampleRate">getAudioSampleRate</a>()
<p>Get the audio sample rate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioSampleRate">setAudioSampleRate</a>(integer $audioSampleRate)
<p>Set the audio sample rate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setKiloBitrate">setKiloBitrate</a>(int $kiloBitrate)
<p>Set the kiloBitrate value</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getExtraParams">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 32</div>
<code> public string
<strong>getExtraParams</strong>()</code>
</h3>
<div class="details">
<p>Returns extra parameters for the encoding</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAudioCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 40</div>
<code> public
<strong>getAudioCodec</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setAudioCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 52</div>
<code> public
<strong>setAudioCodec</strong>(string $audioCodec)</code>
</h3>
<div class="details">
<p>Set the audio codec, Should be in the available ones, otherwise an exception is thrown</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>string</td>
<td>$audioCodec</td>
<td></td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAudioSampleRate">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 69</div>
<code> public integer
<strong>getAudioSampleRate</strong>()</code>
</h3>
<div class="details">
<p>Get the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setAudioSampleRate">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 80</div>
<code> public
<strong>setAudioSampleRate</strong>(integer $audioSampleRate)</code>
</h3>
<div class="details">
<p>Set the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$audioSampleRate</td>
<td></td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getKiloBitrate">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 94</div>
<code> public
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setKiloBitrate">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 105</div>
<code> public
<strong>setKiloBitrate</strong>(int $kiloBitrate)</code>
</h3>
<div class="details">
<p>Set the kiloBitrate value</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>int</td>
<td>$kiloBitrate</td>
<td>integer $kiloBitrate</td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAvailableAudioCodecs">
<div class="location">at line 26</div>
<code> public
<strong>getAvailableAudioCodecs</strong>()</code>
</h3>
<div class="details">
<p>{@inheritDoc}</p>
<p></p>
<div class="tags">
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
</div>
</body>
</html>

153
docs/API/FFMpeg/Format/Audio/InteractiveAudio.html Normal file
View file

@ -0,0 +1,153 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\Audio\InteractiveAudio | PHP FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
</head>
<body id="class">
<div class="header">
<ul>
<li><a href="../../../classes.html">Classes</a></li>
<li><a href="../../../namespaces.html">Namespaces</a></li>
<li><a href="../../../interfaces.html">Interfaces</a></li>
<li><a href="../../../doc-index.html">Index</a></li>
</ul>
<div id="title">PHP FFMpeg API</div>
<div class="type">Interface</div>
<h1><a href="../../../FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a>\InteractiveAudio</h1>
</div>
<div class="content">
<p>interface <strong>InteractiveAudio</strong> implements
<a href="../../../FFMpeg/Format/Audio.html"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></p>
<div class="description">
<p>The interactive audio interface.</p>
<p>This provide a method to list available<br />
codecs. This is usefull to build interactive development and switch between<br />
different codecs</p>
</div>
<h2>Methods</h2>
<table>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getAudioCodec">getAudioCodec</a>()
<p>Returns the audio codec</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>Get the kiloBitrate value</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
array
</td>
<td class="last">
<a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
<p>Returns the list of available audio codecs for this format</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getAudioCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Audio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> at line 27</div>
<code> public string
<strong>getAudioCodec</strong>()</code>
</h3>
<div class="details">
<p>Returns the audio codec</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getKiloBitrate">
<div class="location">in <a href="../../../FFMpeg/Format/Audio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> at line 34</div>
<code> public integer
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>Get the kiloBitrate value</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAvailableAudioCodecs">
<div class="location">at line 31</div>
<code> public array
<strong>getAvailableAudioCodecs</strong>()</code>
</h3>
<div class="details">
<p>Returns the list of available audio codecs for this format</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>array</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
</div>
</body>
</html>

323
docs/API/FFMpeg/Format/Audio/Mp3.html Normal file
View file

@ -0,0 +1,323 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\Audio\Mp3 | PHP FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
</head>
<body id="class">
<div class="header">
<ul>
<li><a href="../../../classes.html">Classes</a></li>
<li><a href="../../../namespaces.html">Namespaces</a></li>
<li><a href="../../../interfaces.html">Interfaces</a></li>
<li><a href="../../../doc-index.html">Index</a></li>
</ul>
<div id="title">PHP FFMpeg API</div>
<div class="type">Class</div>
<h1><a href="../../../FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a>\Mp3</h1>
</div>
<div class="content">
<p>class <strong>Mp3</strong> extends <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></p>
<div class="description">
<p>The MP3 audio format</p>
<p></p>
</div>
<h2>Methods</h2>
<table>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getExtraParams">getExtraParams</a>()
<p>Returns extra parameters for the encoding</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAudioCodec">getAudioCodec</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioCodec">setAudioCodec</a>(string $audioCodec)
<p>Set the audio codec, Should be in the available ones, otherwise an exception is thrown</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getAudioSampleRate">getAudioSampleRate</a>()
<p>Get the audio sample rate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setAudioSampleRate">setAudioSampleRate</a>(integer $audioSampleRate)
<p>Set the audio sample rate</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>{@inheritdoc}</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setKiloBitrate">setKiloBitrate</a>(int $kiloBitrate)
<p>Set the kiloBitrate value</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getExtraParams">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 32</div>
<code> public string
<strong>getExtraParams</strong>()</code>
</h3>
<div class="details">
<p>Returns extra parameters for the encoding</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAudioCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 40</div>
<code> public
<strong>getAudioCodec</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setAudioCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 52</div>
<code> public
<strong>setAudioCodec</strong>(string $audioCodec)</code>
</h3>
<div class="details">
<p>Set the audio codec, Should be in the available ones, otherwise an exception is thrown</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>string</td>
<td>$audioCodec</td>
<td></td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAudioSampleRate">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioSampleRate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 69</div>
<code> public integer
<strong>getAudioSampleRate</strong>()</code>
</h3>
<div class="details">
<p>Get the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_setAudioSampleRate">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 80</div>
<code> public
<strong>setAudioSampleRate</strong>(integer $audioSampleRate)</code>
</h3>
<div class="details">
<p>Set the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>integer</td>
<td>$audioSampleRate</td>
<td></td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getKiloBitrate">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 94</div>
<code> public
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>{@inheritdoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_setKiloBitrate">
<div class="location">in <a href="../../../FFMpeg/Format/Audio/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a> at line 105</div>
<code> public
<strong>setKiloBitrate</strong>(int $kiloBitrate)</code>
</h3>
<div class="details">
<p>Set the kiloBitrate value</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>int</td>
<td>$kiloBitrate</td>
<td>integer $kiloBitrate</td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAvailableAudioCodecs">
<div class="location">at line 26</div>
<code> public
<strong>getAvailableAudioCodecs</strong>()</code>
</h3>
<div class="details">
<p>{@inheritDoc}</p>
<p></p>
<div class="tags">
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
</div>
</body>
</html>

151
docs/API/FFMpeg/Format/Audio/ResamplableAudio.html Normal file
View file

@ -0,0 +1,151 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\Audio\ResamplableAudio | PHP FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
</head>
<body id="class">
<div class="header">
<ul>
<li><a href="../../../classes.html">Classes</a></li>
<li><a href="../../../namespaces.html">Namespaces</a></li>
<li><a href="../../../interfaces.html">Interfaces</a></li>
<li><a href="../../../doc-index.html">Index</a></li>
</ul>
<div id="title">PHP FFMpeg API</div>
<div class="type">Interface</div>
<h1><a href="../../../FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a>\ResamplableAudio</h1>
</div>
<div class="content">
<p>interface <strong>ResamplableAudio</strong> implements
<a href="../../../FFMpeg/Format/Audio.html"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></p>
<div class="description">
<p>The resamplable audio interface</p>
<p>This provide a method to define the AudiosampleRate</p>
</div>
<h2>Methods</h2>
<table>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_getAudioCodec">getAudioCodec</a>()
<p>Returns the audio codec</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getKiloBitrate">getKiloBitrate</a>()
<p>Get the kiloBitrate value</p>
</td>
<td><small>from&nbsp;<a href="../../../FFMpeg/Format/Audio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></small></td>
</tr>
<tr>
<td class="type">
integer
</td>
<td class="last">
<a href="#method_getAudioSampleRate">getAudioSampleRate</a>()
<p>Get the audio sample rate</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method_getAudioCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Audio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> at line 27</div>
<code> public string
<strong>getAudioCodec</strong>()</code>
</h3>
<div class="details">
<p>Returns the audio codec</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getKiloBitrate">
<div class="location">in <a href="../../../FFMpeg/Format/Audio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> at line 34</div>
<code> public integer
<strong>getKiloBitrate</strong>()</code>
</h3>
<div class="details">
<p>Get the kiloBitrate value</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getAudioSampleRate">
<div class="location">at line 31</div>
<code> public integer
<strong>getAudioSampleRate</strong>()</code>
</h3>
<div class="details">
<p>Get the audio sample rate</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>integer</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
</div>
</body>
</html>

9
docs/API/FFMpeg/Format/Audio/namespace-frame.html Normal file
View file

@ -0,0 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\Format\Audio | PHP FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
</head>
</html>