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

Update doc

Browse source
This commit is contained in:
Romain Neutron 2012-09-03 15:53:46 +02:00
commit ddedd4529c
6 changed files with 79 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/API/API/FFMpeg/FFMpegServiceProvider.html
View file

@ -82,7 +82,7 @@
</div>
<h3 id="method_boot">
<div class="location">at line 43</div>
<div class="location">at line 45</div>
<code> public
<strong>boot</strong>(<abbr title="Silex\Application">Application</abbr> $app)</code>
</h3>

28
docs/source/API/API/cache/twig/b4/bf/d36af4142394bd8383e6935b2add.php vendored
View file

@ -35,7 +35,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
protected function doDisplay(array $context, array $blocks = array())
{
// line 3
$context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"] = $this->env->loadTemplate("macros.twig");
$context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"] = $this->env->loadTemplate("macros.twig");
$this->getParent($context)->display($context, array_merge($this->blocks, $blocks));
}
@ -66,7 +66,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
echo "</div>
<h1>";
// line 11
echo $context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"]->getnamespace_link($this->getAttribute($this->getContext($context, "class"), "namespace"));
echo $context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"]->getnamespace_link($this->getAttribute($this->getContext($context, "class"), "namespace"));
if ($this->getAttribute($this->getContext($context, "class"), "namespace")) {
echo "\\";
}
@ -171,7 +171,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
if ($this->getAttribute($this->getContext($context, "class"), "parent")) {
// line 52
echo " extends ";
echo $context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"]->getclass_link($this->getAttribute($this->getContext($context, "class"), "parent"));
echo $context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"]->getclass_link($this->getAttribute($this->getContext($context, "class"), "parent"));
}
// line 54
if ((twig_length_filter($this->env, $this->getAttribute($this->getContext($context, "class"), "interfaces")) > 0)) {
@ -196,7 +196,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
}
foreach ($context['_seq'] as $context["_key"] => $context["interface"]) {
// line 57
echo $context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"]->getclass_link($this->getContext($context, "interface"));
echo $context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"]->getclass_link($this->getContext($context, "interface"));
// line 58
if ((!$this->getAttribute($this->getContext($context, "loop"), "last"))) {
echo ", ";
@ -250,7 +250,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
}
// line 70
echo " ";
echo $context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"]->gethint_link($this->getAttribute($this->getContext($context, "method"), "hint"));
echo $context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"]->gethint_link($this->getAttribute($this->getContext($context, "method"), "hint"));
echo "
<strong>";
// line 71
@ -263,9 +263,9 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
public function block_method_parameters_signature($context, array $blocks = array())
{
// line 75
$context["__internal_e0d81bb7d73da72925e87a640e625bc543b0caa1"] = $this->env->loadTemplate("macros.twig");
$context["__internal_aae0b0eefba5bd21532253b760fb67a75bc0c177"] = $this->env->loadTemplate("macros.twig");
// line 76
echo $context["__internal_e0d81bb7d73da72925e87a640e625bc543b0caa1"]->getmethod_parameters_signature($this->getContext($context, "method"));
echo $context["__internal_aae0b0eefba5bd21532253b760fb67a75bc0c177"]->getmethod_parameters_signature($this->getContext($context, "method"));
}
// line 79
@ -283,7 +283,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
<td>";
// line 83
if ($this->getAttribute($this->getContext($context, "parameter"), "hint")) {
echo $context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"]->gethint_link($this->getAttribute($this->getContext($context, "parameter"), "hint"));
echo $context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"]->gethint_link($this->getAttribute($this->getContext($context, "parameter"), "hint"));
}
echo "</td>
<td>\$";
@ -313,7 +313,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
<tr>
<td>";
// line 94
echo $context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"]->gethint_link($this->getAttribute($this->getContext($context, "method"), "hint"));
echo $context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"]->gethint_link($this->getAttribute($this->getContext($context, "method"), "hint"));
echo "</td>
<td>";
// line 95
@ -338,7 +338,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
echo " <tr>
<td>";
// line 104
echo $context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"]->getclass_link($this->getAttribute($this->getContext($context, "exception"), 0, array(), "array"));
echo $context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"]->getclass_link($this->getAttribute($this->getContext($context, "exception"), 0, array(), "array"));
echo "</td>
<td>";
// line 105
@ -451,7 +451,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
}
// line 143
echo " ";
echo $context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"]->gethint_link($this->getAttribute($this->getContext($context, "property"), "hint"));
echo $context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"]->gethint_link($this->getAttribute($this->getContext($context, "property"), "hint"));
echo "
</td>
<td>\$";
@ -504,7 +504,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
if ($this->getAttribute($this->getContext($context, "method"), "static")) {
echo "static&nbsp;";
}
echo $context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"]->gethint_link($this->getAttribute($this->getContext($context, "method"), "hint"));
echo $context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"]->gethint_link($this->getAttribute($this->getContext($context, "method"), "hint"));
echo "
</td>
<td class=\"last\">
@ -526,7 +526,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
if (($this->getAttribute($this->getContext($context, "method"), "class") != $this->getContext($context, "class"))) {
// line 165
echo "<small>from&nbsp;";
echo $context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"]->getmethod_link($this->getContext($context, "method"), array(), false, true);
echo $context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"]->getmethod_link($this->getContext($context, "method"), array(), false, true);
echo "</small>";
}
// line 167
@ -601,7 +601,7 @@ class __TwigTemplate_b4bfd36af4142394bd8383e6935b2add extends Twig_Template
// line 181
if (($this->getAttribute($this->getContext($context, "method"), "class") != $this->getContext($context, "class"))) {
echo "in ";
echo $context["__internal_135fc768e5283a055c31f2967bd10ac1026bdd85"]->getmethod_link($this->getContext($context, "method"), array(), false, true);
echo $context["__internal_f5bb4fd7271e552b84dd4e0f323dc1a92792b6f5"]->getmethod_link($this->getContext($context, "method"), array(), false, true);
echo " ";
}
echo "at line ";

10
docs/source/API/API/cache/twig/c0/fb/1aefe71f983057b0b726879f8ad9.php vendored
View file

@ -25,7 +25,7 @@ class __TwigTemplate_c0fb1aefe71f983057b0b726879f8ad9 extends Twig_Template
protected function doDisplay(array $context, array $blocks = array())
{
// line 3
$context["__internal_ff2b118394f3774090df3e995c66bf1aabb901bc"] = $this->env->loadTemplate("macros.twig");
$context["__internal_aa87abe113c1c7ca4f2721a469e6cbc2ef862774"] = $this->env->loadTemplate("macros.twig");
$this->parent->display($context, array_merge($this->blocks, $blocks));
}
@ -72,7 +72,7 @@ class __TwigTemplate_c0fb1aefe71f983057b0b726879f8ad9 extends Twig_Template
{
// line 21
echo " <h1>";
echo $context["__internal_ff2b118394f3774090df3e995c66bf1aabb901bc"]->getnamespace_link($this->getContext($context, "namespace"), array("target" => "main"));
echo $context["__internal_aa87abe113c1c7ca4f2721a469e6cbc2ef862774"]->getnamespace_link($this->getContext($context, "namespace"), array("target" => "main"));
echo "</h1>
";
@ -87,7 +87,7 @@ class __TwigTemplate_c0fb1aefe71f983057b0b726879f8ad9 extends Twig_Template
foreach ($context['_seq'] as $context["_key"] => $context["class"]) {
// line 26
echo " <li>";
echo $context["__internal_ff2b118394f3774090df3e995c66bf1aabb901bc"]->getclass_link($this->getContext($context, "class"), array("target" => "main"));
echo $context["__internal_aa87abe113c1c7ca4f2721a469e6cbc2ef862774"]->getclass_link($this->getContext($context, "class"), array("target" => "main"));
echo "</li>
";
}
@ -113,7 +113,7 @@ class __TwigTemplate_c0fb1aefe71f983057b0b726879f8ad9 extends Twig_Template
foreach ($context['_seq'] as $context["_key"] => $context["class"]) {
// line 35
echo " <li>";
echo $context["__internal_ff2b118394f3774090df3e995c66bf1aabb901bc"]->getclass_link($this->getContext($context, "class"), array("target" => "main"));
echo $context["__internal_aa87abe113c1c7ca4f2721a469e6cbc2ef862774"]->getclass_link($this->getContext($context, "class"), array("target" => "main"));
echo "</li>
";
}
@ -139,7 +139,7 @@ class __TwigTemplate_c0fb1aefe71f983057b0b726879f8ad9 extends Twig_Template
foreach ($context['_seq'] as $context["_key"] => $context["class"]) {
// line 44
echo " <li>";
echo $context["__internal_ff2b118394f3774090df3e995c66bf1aabb901bc"]->getclass_link($this->getContext($context, "class"), array("target" => "main"));
echo $context["__internal_aa87abe113c1c7ca4f2721a469e6cbc2ef862774"]->getclass_link($this->getContext($context, "class"), array("target" => "main"));
echo "</li>
";
}

8
docs/source/API/API/cache/twig/e9/56/2e21b2193ee048505a9f07edfd06.php vendored
View file

@ -23,7 +23,7 @@ class __TwigTemplate_e9562e21b2193ee048505a9f07edfd06 extends Twig_Template
protected function doDisplay(array $context, array $blocks = array())
{
// line 3
$context["__internal_b6c3c16e7b8e4f1a04c567d6645e106e887ce539"] = $this->env->loadTemplate("macros.twig");
$context["__internal_55f975efa34a6934423be47a7a9935511ef19639"] = $this->env->loadTemplate("macros.twig");
$this->getParent($context)->display($context, array_merge($this->blocks, $blocks));
}
@ -70,7 +70,7 @@ class __TwigTemplate_e9562e21b2193ee048505a9f07edfd06 extends Twig_Template
echo " <tr>
<td>";
// line 19
echo $context["__internal_b6c3c16e7b8e4f1a04c567d6645e106e887ce539"]->getclass_link($this->getContext($context, "class"));
echo $context["__internal_55f975efa34a6934423be47a7a9935511ef19639"]->getclass_link($this->getContext($context, "class"));
echo "</td>
<td class=\"last\">";
// line 20
@ -103,7 +103,7 @@ class __TwigTemplate_e9562e21b2193ee048505a9f07edfd06 extends Twig_Template
echo " <tr>
<td>";
// line 31
echo $context["__internal_b6c3c16e7b8e4f1a04c567d6645e106e887ce539"]->getclass_link($this->getContext($context, "interface"));
echo $context["__internal_55f975efa34a6934423be47a7a9935511ef19639"]->getclass_link($this->getContext($context, "interface"));
echo "</td>
<td class=\"last\">";
// line 32
@ -136,7 +136,7 @@ class __TwigTemplate_e9562e21b2193ee048505a9f07edfd06 extends Twig_Template
echo " <tr>
<td>";
// line 43
echo $context["__internal_b6c3c16e7b8e4f1a04c567d6645e106e887ce539"]->getclass_link($this->getContext($context, "exception"));
echo $context["__internal_55f975efa34a6934423be47a7a9935511ef19639"]->getclass_link($this->getContext($context, "exception"));
echo "</td>
<td class=\"last\">";
// line 44

2
docs/source/API/API/renderer.index
View file

@ -1 +1 @@
C:19:"Sami\Renderer\Index":2420:{a:3:{i:0;a:27:{s:23:"FFMpeg\AdapterInterface";s:40:"692055cd227655999c71a444af1aca35a74b4bef";s:13:"FFMpeg\Binary";s:40:"6e557aa8ddcbaf3abca784abd56f84ce06b4d954";s:40:"FFMpeg\Exception\BinaryNotFoundException";s:40:"87f8f8a978534ffac0938c80140f53937be42b20";s:26:"FFMpeg\Exception\Exception";s:40:"f34b568cf514a3e72dd2f6b85ccb72985173fd04";s:41:"FFMpeg\Exception\InvalidArgumentException";s:40:"7c8fce1704e07a412e53455727b4fb3b76add274";s:31:"FFMpeg\Exception\LogicException";s:40:"312d742fa4413eb0bbc96cc9a5878c3a882a7d9e";s:33:"FFMpeg\Exception\RuntimeException";s:40:"4eb84ded48af1748aac5d58f5386c489fccd7b41";s:13:"FFMpeg\FFMpeg";s:40:"905f049ce59818433a6cf2a5d04a18b07b97a033";s:28:"FFMpeg\FFMpegServiceProvider";s:40:"8b54eb93db178c9e38247fb2577fd23bc8c5a9c9";s:14:"FFMpeg\FFProbe";s:40:"f87511d2e814fb6babca5fe51b312fa90a1f56e9";s:19:"FFMpeg\Format\Audio";s:40:"de3bd45cfbe199120004b172937c2424519c2ed0";s:32:"FFMpeg\Format\Audio\DefaultAudio";s:40:"046d63981e0d45fe78ae0218504085aded8e4465";s:24:"FFMpeg\Format\Audio\Flac";s:40:"dd42337e79f87bf1e65107553d718ddd9620fdaf";s:31:"FFMpeg\Format\Audio\Interactive";s:40:"c690469cd7aff29b71406326c0895c0669d02855";s:23:"FFMpeg\Format\Audio\Mp3";s:40:"0636d17bef3adb55c8ed0ab0ef2c855bf62321db";s:31:"FFMpeg\Format\Audio\Resamplable";s:40:"24be9dee2b1bf9a8d658fdf0d9a45866f1763aa1";s:32:"FFMpeg\Format\Audio\Transcodable";s:40:"bbf9a19a6dfb3c305826cc7922aab24a9c03afd1";s:23:"FFMpeg\Format\Dimension";s:40:"fe4fb8353f1a170ee8d47b02d1d1191ad1da39c3";s:19:"FFMpeg\Format\Video";s:40:"eca501be9309a062e98afcb5d68a4372a39ebc63";s:32:"FFMpeg\Format\Video\DefaultVideo";s:40:"e84cc619bf30ee9793f61478e3812403c30394af";s:31:"FFMpeg\Format\Video\Interactive";s:40:"36c13c440c19994100f1d442ac36079ef65052c7";s:23:"FFMpeg\Format\Video\Ogg";s:40:"21a4630b36a411a622ad99201545e3d7fcfa75e6";s:31:"FFMpeg\Format\Video\Resamplable";s:40:"b3af34bb13a73f82994589fa99c5ed0d647f320a";s:29:"FFMpeg\Format\Video\Resizable";s:40:"500e975f6a744fdcbb15c1012598025b3699c877";s:32:"FFMpeg\Format\Video\Transcodable";s:40:"c9a038aabc4e2f3ca993b65851a215e6ce3f93bd";s:24:"FFMpeg\Format\Video\WebM";s:40:"162abdf0e0e688a8e5a0cc53cfeddde869a302b1";s:24:"FFMpeg\Format\Video\X264";s:40:"c235f5ff052386b78fe42c6b10cdfecb3a655394";}i:1;a:1:{i:0;s:6:"master";}i:2;a:5:{i:0;s:6:"FFMpeg";i:1;s:16:"FFMpeg\Exception";i:2;s:13:"FFMpeg\Format";i:3;s:19:"FFMpeg\Format\Audio";i:4;s:19:"FFMpeg\Format\Video";}}}
C:19:"Sami\Renderer\Index":2420:{a:3:{i:0;a:27:{s:23:"FFMpeg\AdapterInterface";s:40:"692055cd227655999c71a444af1aca35a74b4bef";s:13:"FFMpeg\Binary";s:40:"6e557aa8ddcbaf3abca784abd56f84ce06b4d954";s:40:"FFMpeg\Exception\BinaryNotFoundException";s:40:"87f8f8a978534ffac0938c80140f53937be42b20";s:26:"FFMpeg\Exception\Exception";s:40:"f34b568cf514a3e72dd2f6b85ccb72985173fd04";s:41:"FFMpeg\Exception\InvalidArgumentException";s:40:"7c8fce1704e07a412e53455727b4fb3b76add274";s:31:"FFMpeg\Exception\LogicException";s:40:"312d742fa4413eb0bbc96cc9a5878c3a882a7d9e";s:33:"FFMpeg\Exception\RuntimeException";s:40:"4eb84ded48af1748aac5d58f5386c489fccd7b41";s:13:"FFMpeg\FFMpeg";s:40:"905f049ce59818433a6cf2a5d04a18b07b97a033";s:28:"FFMpeg\FFMpegServiceProvider";s:40:"027db9117d10ad32be1fdac585e7387e899592e5";s:14:"FFMpeg\FFProbe";s:40:"f87511d2e814fb6babca5fe51b312fa90a1f56e9";s:19:"FFMpeg\Format\Audio";s:40:"de3bd45cfbe199120004b172937c2424519c2ed0";s:32:"FFMpeg\Format\Audio\DefaultAudio";s:40:"046d63981e0d45fe78ae0218504085aded8e4465";s:24:"FFMpeg\Format\Audio\Flac";s:40:"dd42337e79f87bf1e65107553d718ddd9620fdaf";s:31:"FFMpeg\Format\Audio\Interactive";s:40:"c690469cd7aff29b71406326c0895c0669d02855";s:23:"FFMpeg\Format\Audio\Mp3";s:40:"0636d17bef3adb55c8ed0ab0ef2c855bf62321db";s:31:"FFMpeg\Format\Audio\Resamplable";s:40:"24be9dee2b1bf9a8d658fdf0d9a45866f1763aa1";s:32:"FFMpeg\Format\Audio\Transcodable";s:40:"bbf9a19a6dfb3c305826cc7922aab24a9c03afd1";s:23:"FFMpeg\Format\Dimension";s:40:"fe4fb8353f1a170ee8d47b02d1d1191ad1da39c3";s:19:"FFMpeg\Format\Video";s:40:"eca501be9309a062e98afcb5d68a4372a39ebc63";s:32:"FFMpeg\Format\Video\DefaultVideo";s:40:"e84cc619bf30ee9793f61478e3812403c30394af";s:31:"FFMpeg\Format\Video\Interactive";s:40:"36c13c440c19994100f1d442ac36079ef65052c7";s:23:"FFMpeg\Format\Video\Ogg";s:40:"21a4630b36a411a622ad99201545e3d7fcfa75e6";s:31:"FFMpeg\Format\Video\Resamplable";s:40:"b3af34bb13a73f82994589fa99c5ed0d647f320a";s:29:"FFMpeg\Format\Video\Resizable";s:40:"500e975f6a744fdcbb15c1012598025b3699c877";s:32:"FFMpeg\Format\Video\Transcodable";s:40:"c9a038aabc4e2f3ca993b65851a215e6ce3f93bd";s:24:"FFMpeg\Format\Video\WebM";s:40:"162abdf0e0e688a8e5a0cc53cfeddde869a302b1";s:24:"FFMpeg\Format\Video\X264";s:40:"c235f5ff052386b78fe42c6b10cdfecb3a655394";}i:1;a:1:{i:0;s:6:"master";}i:2;a:5:{i:0;s:6:"FFMpeg";i:1;s:16:"FFMpeg\Exception";i:2;s:13:"FFMpeg\Format";i:3;s:19:"FFMpeg\Format\Audio";i:4;s:19:"FFMpeg\Format\Video";}}}

54
docs/source/Recipes.rst
View file

@ -48,6 +48,60 @@ You can also initialize with a custom path to the binary :
<?php
$ffmpeg = new FFMpeg('/usr/local/src/ffmpeg/bin/ffmpeg', $logger);
Working with Silex Microframework
---------------------------------
If you're using `Silex MicroFramework <http://silex.sensiolabs.org/>`_, you can
use FFMpeg-PHP with the bundled Service Provider :
.. code-block:: php
<?php
use Silex\Application;
use FFMpeg\FFMpegServiceProvider;
$app = new Application();
$app->register(new FFMpegServiceProvider());
// Instance of FFMpeg\FFMpeg
$app['ffmpeg.ffmpeg'];
// Instance of FFMpeg\FFProbe
$app['ffmpeg.ffprobe'];
Service Provider options
^^^^^^^^^^^^^^^^^^^^^^^^
By default, `FFMpegServiceProvider` will look for monolog service to log
messages. You can customize FFMpeg logger with the 'ffmpeg.logger' option.
You can also customize the number of threads to open and the path to FFMpeg and
FFProbe binaries :
.. code-block:: php
<?php
use Silex\Application;
use FFMpeg\FFMpegServiceProvider;
use Monolog\Logger;
use Monolog\Handler\NullHandler;
$app = new Application();
$logger = new Logger('FFMpeg');
$logger->pushHandler(new NullHandler());
$options = array(
'ffmpeg.ffmpeg.binary' => '/path/to/custom/ffmpeg/binary',
'ffmpeg.ffprobe.binary' => '/path/to/custom/ffprobe/binary',
'ffmpeg.threads' => 8, # number of threads to open
'ffmpeg.logger' => $logger, # custom logger service
);
$app->register(new FFMpegServiceProvider(), $options);
Formats
-------