Add documentation

This commit is contained in:
Romain Neutron 2012-04-13 16:06:26 +02:00
commit c92911c8db
4 changed files with 615 additions and 0 deletions

30
docs/source/index.rst Normal file
View file

@ -0,0 +1,30 @@
FFmpeg PHP documentation
========================
FFMpeg PHP is an Object Oriented library which allow easy to use file
conversion with ffmpeg.
Basics
------
The following code opens an audio file named "audio.wav" and convert it to a
256kbps mp3.
.. code-block:: php
<?php
$source = 'audio.wav';
$dest = 'audio.flac';
$ffmpeg = \FFMpeg\FFMpeg::load();
$ffmpeg->open('audio.wav');
$mp3Format = new FFMpeg\Format\Audio\Mp3();
$mp3Format->setKiloBitrate(256);
$ffmpeg->encode($mp3Format, 'audio.mp3');