diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index bfc3101..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,133 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -W -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -W -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -W -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -W -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -W -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -W -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -epub: - $(SPHINXBUILD) -W -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -W -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -W -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -W -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -W -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -W -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -W -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -W -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -W -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -W -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -W -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/source/API/API/FFMpeg.html b/docs/source/API/API/FFMpeg.html index 8934506..30b55e4 100644 --- a/docs/source/API/API/FFMpeg.html +++ b/docs/source/API/API/FFMpeg.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -25,15 +26,18 @@ - + - + - +
    FFMpeg +
    FFMpegServiceProvider +
    FFProbe +
    diff --git a/docs/source/API/API/FFMpeg/Coordinate.html b/docs/source/API/API/FFMpeg/Coordinate.html index fac00f9..a26339f 100644 --- a/docs/source/API/API/FFMpeg/Coordinate.html +++ b/docs/source/API/API/FFMpeg/Coordinate.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -25,7 +26,8 @@ - + @@ -33,15 +35,18 @@ - + - + - +
    AspectRatio +
    Dimension
    FrameRate +
    Point +
    TimeCode +
    diff --git a/docs/source/API/API/FFMpeg/Coordinate/AspectRatio.html b/docs/source/API/API/FFMpeg/Coordinate/AspectRatio.html index ae08833..732fcdb 100644 --- a/docs/source/API/API/FFMpeg/Coordinate/AspectRatio.html +++ b/docs/source/API/API/FFMpeg/Coordinate/AspectRatio.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Coordinate\AspectRatio

    -

    class AspectRatio

    +

    class + AspectRatio

    Constants

    @@ -31,106 +33,136 @@ AR_4_3 -

    -

    +

    +

    +

    +

    AR_16_9 -

    -

    +

    +

    +

    +

    AR_3_2 -

    -

    +

    +

    +

    +

    AR_5_3 -

    -

    +

    +

    +

    +

    AR_5_4 -

    -

    +

    +

    +

    +

    AR_1_1 -

    -

    +

    +

    +

    +

    AR_1_DOT_85_1 -

    -

    +

    +

    +

    +

    AR_2_DOT_39_1 -

    -

    +

    +

    +

    +

    AR_ROTATED_3_4 -

    -

    +

    +

    +

    +

    AR_ROTATED_9_16 -

    -

    +

    +

    +

    +

    AR_ROTATED_2_3 -

    -

    +

    +

    +

    +

    AR_ROTATED_3_5 -

    -

    +

    +

    +

    +

    AR_ROTATED_4_5 -

    -

    +

    +

    +

    +

    AR_ROTATED_1_DOT_85 -

    -

    +

    +

    +

    +

    AR_ROTATED_2_DOT_39 -

    -

    +

    +

    +

    +

    @@ -146,13 +178,14 @@ __construct($ratio) -

    +

    +

    - float + float getValue() @@ -201,8 +234,10 @@ __construct($ratio)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -210,7 +245,8 @@ $ratio - + + @@ -222,20 +258,22 @@

    at line 71
    - public float + public float getValue()

    Returns the value of the ratio.

    -

    +

    +

    Return Value

    - - + +
    floatfloat +
    @@ -251,7 +289,8 @@

    Computes the best width for given height and modulus.

    -

    +

    +

    Parameters

    @@ -259,12 +298,14 @@ Integer $height - + + Integer $modulus - + + @@ -274,7 +315,8 @@ - +
    Integer +
    @@ -290,7 +332,8 @@

    Computes the best height for given width and modulus.

    -

    +

    +

    Parameters

    @@ -298,12 +341,14 @@ Integer $width - + + Integer $modulus - + + @@ -313,7 +358,8 @@ - +
    Integer +
    @@ -329,8 +375,8 @@

    Creates a ratio based on Dimension.

    -

    The strategy parameter forces by default to use standardized ratios. If
    - custom ratio need to be used, disable it.

    +

    The strategy parameter forces by default to use standardized ratios. If +custom ratio need to be used, disable it.

    Parameters

    @@ -338,7 +384,8 @@ Dimension $dimension - + + Boolean @@ -353,7 +400,8 @@ - +
    AspectRatio +
    @@ -363,7 +411,8 @@ - +
    InvalidArgumentException +
    diff --git a/docs/source/API/API/FFMpeg/Coordinate/Dimension.html b/docs/source/API/API/FFMpeg/Coordinate/Dimension.html index 782eeea..ec52751 100644 --- a/docs/source/API/API/FFMpeg/Coordinate/Dimension.html +++ b/docs/source/API/API/FFMpeg/Coordinate/Dimension.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,11 +23,13 @@

    FFMpeg\Coordinate\Dimension

    -

    class Dimension

    +

    class + Dimension

    Dimension object, used for manipulating width and height couples

    -

    +

    +

    @@ -40,13 +43,14 @@ __construct(integer $width, integer $height) -

    +

    +

    - width + integer getWidth() @@ -85,8 +89,10 @@ __construct(integer $width, integer $height)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -94,12 +100,14 @@ integer $width - + + integer $height - + + @@ -120,20 +128,22 @@

    at line 45
    - public width + public integer getWidth()

    Returns width.

    -

    +

    +

    Return Value

    - - + +
    widthinteger +
    @@ -149,7 +159,8 @@

    Returns height.

    -

    +

    +

    Return Value

    @@ -157,7 +168,8 @@ - +
    integer +
    @@ -173,7 +185,8 @@

    Returns the ratio.

    -

    +

    +

    Parameters

    @@ -191,7 +204,8 @@ - +
    AspectRatio +
    diff --git a/docs/source/API/API/FFMpeg/Coordinate/FrameRate.html b/docs/source/API/API/FFMpeg/Coordinate/FrameRate.html index 876c568..ac9462a 100644 --- a/docs/source/API/API/FFMpeg/Coordinate/FrameRate.html +++ b/docs/source/API/API/FFMpeg/Coordinate/FrameRate.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Coordinate\FrameRate

    -

    class FrameRate

    +

    class + FrameRate

    @@ -36,17 +38,19 @@ __construct($value) -

    +

    +

    - float + float getValue() -

    +

    +

    @@ -61,8 +65,10 @@ __construct($value)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -70,7 +76,8 @@ $value - + + @@ -82,20 +89,23 @@

    at line 32
    - public float + public float getValue()

    -

    -

    +

    +

    +

    +

    Return Value

    - - + +
    floatfloat +
    diff --git a/docs/source/API/API/FFMpeg/Coordinate/Point.html b/docs/source/API/API/FFMpeg/Coordinate/Point.html index 78011d9..b908c58 100644 --- a/docs/source/API/API/FFMpeg/Coordinate/Point.html +++ b/docs/source/API/API/FFMpeg/Coordinate/Point.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Coordinate\Point

    -

    class Point

    +

    class + Point

    @@ -36,7 +38,8 @@ __construct($x, $y) -

    +

    +

    @@ -46,7 +49,8 @@ getX() -

    +

    +

    @@ -56,7 +60,8 @@ getY() -

    +

    +

    @@ -71,8 +76,10 @@ __construct($x, $y)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -80,12 +87,14 @@ $x - + + $y - + + @@ -101,8 +110,10 @@ getX()
    -

    -

    +

    +

    +

    +

    Return Value

    @@ -110,7 +121,8 @@ - +
    integer +
    @@ -125,8 +137,10 @@ getY()
    -

    -

    +

    +

    +

    +

    Return Value

    @@ -134,7 +148,8 @@ - +
    integer +
    diff --git a/docs/source/API/API/FFMpeg/Coordinate/TimeCode.html b/docs/source/API/API/FFMpeg/Coordinate/TimeCode.html index 1c3f4ce..e33e5dc 100644 --- a/docs/source/API/API/FFMpeg/Coordinate/TimeCode.html +++ b/docs/source/API/API/FFMpeg/Coordinate/TimeCode.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Coordinate\TimeCode

    -

    class TimeCode

    +

    class + TimeCode

    @@ -36,7 +38,8 @@ __construct($hours, $minutes, $seconds, $frames) -

    +

    +

    @@ -46,7 +49,8 @@ __toString() -

    +

    +

    @@ -65,7 +69,7 @@ static TimeCode - fromSeconds(float $quantity) + fromSeconds(float $quantity)

    Creates timecode from number of seconds.

    @@ -81,8 +85,10 @@ __construct($hours, $minutes, $seconds, $frames)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -90,22 +96,26 @@ $hours - + + $minutes - + + $seconds - + + $frames - + + @@ -121,8 +131,10 @@ __toString()
    -

    -

    +

    +

    +

    +

    @@ -137,7 +149,8 @@

    Creates timecode from string.

    -

    +

    +

    Parameters

    @@ -145,7 +158,8 @@ string $timecode - + + @@ -155,7 +169,8 @@ - +
    TimeCode +
    @@ -176,19 +191,21 @@

    at line 74
    static public TimeCode - fromSeconds(float $quantity) + fromSeconds(float $quantity)

    Creates timecode from number of seconds.

    -

    +

    +

    Parameters

    - + - +
    floatfloat $quantity +
    @@ -198,7 +215,8 @@ - +
    TimeCode +
    diff --git a/docs/source/API/API/FFMpeg/Driver.html b/docs/source/API/API/FFMpeg/Driver.html index bee9dc3..08ade38 100644 --- a/docs/source/API/API/FFMpeg/Driver.html +++ b/docs/source/API/API/FFMpeg/Driver.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -25,11 +26,13 @@ - + - +
    FFMpegDriver +
    FFProbeDriver +
    diff --git a/docs/source/API/API/FFMpeg/Driver/FFMpegDriver.html b/docs/source/API/API/FFMpeg/Driver/FFMpegDriver.html index 32b774a..16e8d49 100644 --- a/docs/source/API/API/FFMpeg/Driver/FFMpegDriver.html +++ b/docs/source/API/API/FFMpeg/Driver/FFMpegDriver.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Driver\FFMpegDriver

    -

    class FFMpegDriver extends AbstractBinary

    +

    class + FFMpegDriver extends AbstractBinary

    @@ -62,7 +64,8 @@

    {@inheritdoc}

    -

    +

    +

    @@ -77,7 +80,8 @@

    Creates an FFMpegDriver.

    -

    +

    +

    Parameters

    @@ -85,12 +89,14 @@ LoggerInterface $logger - + + array|Configuration $configuration - + + @@ -100,7 +106,8 @@ - +
    FFMpegDriver +
    diff --git a/docs/source/API/API/FFMpeg/Driver/FFProbeDriver.html b/docs/source/API/API/FFMpeg/Driver/FFProbeDriver.html index a992042..53b119d 100644 --- a/docs/source/API/API/FFMpeg/Driver/FFProbeDriver.html +++ b/docs/source/API/API/FFMpeg/Driver/FFProbeDriver.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Driver\FFProbeDriver

    -

    class FFProbeDriver extends AbstractBinary

    +

    class + FFProbeDriver extends AbstractBinary

    @@ -62,7 +64,8 @@

    {@inheritdoc}

    -

    +

    +

    @@ -77,7 +80,8 @@

    Creates an FFProbeDriver.

    -

    +

    +

    Parameters

    @@ -85,12 +89,14 @@ array|ConfigurationInterface $configuration - + + LoggerInterface $logger - + + @@ -100,7 +106,8 @@ - +
    FFProbeDriver +
    diff --git a/docs/source/API/API/FFMpeg/Exception.html b/docs/source/API/API/FFMpeg/Exception.html index e8caa8d..2746cb0 100644 --- a/docs/source/API/API/FFMpeg/Exception.html +++ b/docs/source/API/API/FFMpeg/Exception.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -25,15 +26,23 @@ - + - + + + + + - +
    ExecutableNotFoundException +
    InvalidArgumentException +
    LogicException +
    RuntimeException +
    @@ -41,7 +50,8 @@ - +
    ExceptionInterface +
    diff --git a/docs/source/API/API/FFMpeg/Exception/ExceptionInterface.html b/docs/source/API/API/FFMpeg/Exception/ExceptionInterface.html index 51e6eea..28f825b 100644 --- a/docs/source/API/API/FFMpeg/Exception/ExceptionInterface.html +++ b/docs/source/API/API/FFMpeg/Exception/ExceptionInterface.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Exception\ExceptionInterface

    -

    interface ExceptionInterface

    +

    interface + ExceptionInterface

    diff --git a/docs/source/API/API/FFMpeg/Exception/ExecutableNotFoundException.html b/docs/source/API/API/FFMpeg/Exception/ExecutableNotFoundException.html index e924cc9..0dd5663 100644 --- a/docs/source/API/API/FFMpeg/Exception/ExecutableNotFoundException.html +++ b/docs/source/API/API/FFMpeg/Exception/ExecutableNotFoundException.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Exception\ExecutableNotFoundException

    -

    class ExecutableNotFoundException extends RuntimeException

    +

    class + ExecutableNotFoundException extends RuntimeException

    diff --git a/docs/source/API/API/FFMpeg/Exception/InvalidArgumentException.html b/docs/source/API/API/FFMpeg/Exception/InvalidArgumentException.html index e348ba5..a3b0279 100644 --- a/docs/source/API/API/FFMpeg/Exception/InvalidArgumentException.html +++ b/docs/source/API/API/FFMpeg/Exception/InvalidArgumentException.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Exception\InvalidArgumentException

    -

    class InvalidArgumentException extends InvalidArgumentException implements +

    class + InvalidArgumentException extends InvalidArgumentException implements ExceptionInterface

    diff --git a/docs/source/API/API/FFMpeg/Exception/LogicException.html b/docs/source/API/API/FFMpeg/Exception/LogicException.html new file mode 100644 index 0000000..7d310ca --- /dev/null +++ b/docs/source/API/API/FFMpeg/Exception/LogicException.html @@ -0,0 +1,38 @@ + + + + + + FFMpeg\Exception\LogicException | PHP-FFMpeg API + + + +
    + + +
    PHP-FFMpeg API
    + +
    Class
    +

    FFMpeg\Exception\LogicException

    +
    +
    +

    class + LogicException extends LogicException implements + ExceptionInterface

    + + + + +
    + + + diff --git a/docs/source/API/API/FFMpeg/Exception/RuntimeException.html b/docs/source/API/API/FFMpeg/Exception/RuntimeException.html index 4194721..ef0bcd5 100644 --- a/docs/source/API/API/FFMpeg/Exception/RuntimeException.html +++ b/docs/source/API/API/FFMpeg/Exception/RuntimeException.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Exception\RuntimeException

    -

    class RuntimeException extends RuntimeException implements +

    class + RuntimeException extends RuntimeException implements ExceptionInterface

    diff --git a/docs/source/API/API/FFMpeg/FFMpeg.html b/docs/source/API/API/FFMpeg/FFMpeg.html index b36a2f0..a101240 100644 --- a/docs/source/API/API/FFMpeg/FFMpeg.html +++ b/docs/source/API/API/FFMpeg/FFMpeg.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFMpeg

    -

    class FFMpeg

    +

    class + FFMpeg

    @@ -36,7 +38,8 @@ __construct(FFMpegDriver $ffmpeg, FFProbe $ffprobe) -

    +

    +

    @@ -106,13 +109,15 @@

    Details

    -
    at line 28
    +
    at line 29
    public __construct(FFMpegDriver $ffmpeg, FFProbe $ffprobe)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -120,12 +125,14 @@ FFMpegDriver $ffmpeg - + + FFProbe $ffprobe - + + @@ -136,13 +143,14 @@

    -
    at line 41
    +
    at line 42
    public FFMpeg setFFProbe(FFProbe $ffprobe)

    Sets FFProbe.

    -

    +

    +

    Parameters

    @@ -150,7 +158,8 @@ FFProbe $ffprobe - + + @@ -160,7 +169,8 @@ - +
    FFMpeg +
    @@ -170,13 +180,14 @@

    -
    at line 53
    +
    at line 54
    public FFProbe getFFProbe()

    Gets FFProbe.

    -

    +

    +

    Return Value

    @@ -184,7 +195,8 @@ - +
    FFProbe +
    @@ -194,13 +206,14 @@

    -
    at line 63
    +
    at line 64
    public FFMpeg setFFMpegDriver(FFMpegDriver $ffmpeg)

    Sets the ffmpeg driver.

    -

    +

    +

    Parameters

    @@ -208,7 +221,8 @@ FFMpegDriver $ffmpeg - + + @@ -218,7 +232,8 @@ - +
    FFMpeg +
    @@ -228,13 +243,14 @@

    -
    at line 75
    +
    at line 76
    public FFMpegDriver getFFMpegDriver()

    Gets the ffmpeg driver.

    -

    +

    +

    Return Value

    @@ -242,7 +258,8 @@ - +
    FFMpegDriver +
    @@ -252,13 +269,14 @@

    -
    at line 89
    +
    at line 90
    public Audio|Video open(string $pathfile)

    Opens a file in order to be processed.

    -

    +

    +

    Parameters

    @@ -276,7 +294,8 @@ - +
    Audio|Video +
    @@ -286,7 +305,8 @@ - +
    InvalidArgumentException +
    @@ -295,13 +315,14 @@

    -
    at line 115
    +
    at line 114
    static public FFMpeg create(array|ConfigurationInterface $configuration = array(), LoggerInterface $logger = null, FFProbe $probe = null)

    Creates a new FFMpeg instance.

    -

    +

    +

    Parameters

    @@ -309,17 +330,20 @@ array|ConfigurationInterface $configuration - + + LoggerInterface $logger - + + FFProbe $probe - + + @@ -329,7 +353,8 @@ - +
    FFMpeg +
    diff --git a/docs/source/API/API/FFMpeg/FFMpegServiceProvider.html b/docs/source/API/API/FFMpeg/FFMpegServiceProvider.html index 329b4db..dc3623d 100644 --- a/docs/source/API/API/FFMpeg/FFMpegServiceProvider.html +++ b/docs/source/API/API/FFMpeg/FFMpegServiceProvider.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFMpegServiceProvider

    -

    class FFMpegServiceProvider implements +

    class + FFMpegServiceProvider implements ServiceProviderInterface

    @@ -37,7 +39,8 @@ register(Application $app) -

    +

    +

    @@ -47,7 +50,8 @@ boot(Application $app) -

    +

    +

    @@ -57,13 +61,15 @@

    Details

    -
    at line 22
    +
    at line 20
    public register(Application $app)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -71,7 +77,8 @@ Application $app - + + @@ -82,13 +89,15 @@

    -
    at line 63
    +
    at line 61
    public boot(Application $app)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -96,7 +105,8 @@ Application $app - + + diff --git a/docs/source/API/API/FFMpeg/FFProbe.html b/docs/source/API/API/FFMpeg/FFProbe.html index 8365b36..21a4d8c 100644 --- a/docs/source/API/API/FFMpeg/FFProbe.html +++ b/docs/source/API/API/FFMpeg/FFProbe.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFProbe

    -

    class FFProbe

    +

    class + FFProbe

    Constants

    @@ -31,15 +33,19 @@ TYPE_STREAMS -

    -

    +

    +

    +

    +

    TYPE_FORMAT -

    -

    +

    +

    +

    +

    @@ -55,7 +61,8 @@ __construct(FFProbeDriver $ffprobe, Cache $cache) -

    +

    +

    @@ -65,7 +72,8 @@ getParser() -

    +

    +

    @@ -75,7 +83,8 @@ setParser(OutputParserInterface $parser) -

    +

    +

    @@ -85,7 +94,8 @@ getFFProbeDriver() -

    +

    +

    @@ -95,7 +105,8 @@ setFFProbeDriver(FFProbeDriver $ffprobe) -

    +

    +

    @@ -105,7 +116,8 @@ setOptionsTester(OptionsTesterInterface $tester) -

    +

    +

    @@ -115,7 +127,8 @@ getOptionsTester() -

    +

    +

    @@ -125,7 +138,8 @@ setCache(Cache $cache) -

    +

    +

    @@ -135,7 +149,8 @@ getCache() -

    +

    +

    @@ -145,7 +160,8 @@ getMapper() -

    +

    +

    @@ -155,7 +171,8 @@ setMapper(MapperInterface $mapper) -

    +

    +

    @@ -165,7 +182,8 @@ format(string $pathfile) -

    +

    +

    @@ -175,7 +193,8 @@ streams(string $pathfile) -

    +

    +

    @@ -185,7 +204,8 @@ create(array|ConfigurationInterface $configuration = array(), LoggerInterface $logger = null, Cache $cache = null) -

    +

    +

    @@ -195,13 +215,15 @@

    Details

    -
    at line 45
    +
    at line 46
    public __construct(FFProbeDriver $ffprobe, Cache $cache)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -209,12 +231,14 @@ FFProbeDriver $ffprobe - + + Cache $cache - + + @@ -225,13 +249,15 @@

    -
    at line 57
    +
    at line 58
    public OutputParserInterface getParser()

    -

    -

    +

    +

    +

    +

    Return Value

    @@ -239,7 +265,8 @@ - +
    OutputParserInterface +
    @@ -249,13 +276,15 @@

    -
    at line 67
    +
    at line 68
    public FFProbe setParser(OutputParserInterface $parser)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -263,7 +292,8 @@ OutputParserInterface $parser - + + @@ -273,7 +303,8 @@ - +
    FFProbe +
    @@ -283,13 +314,15 @@

    -
    at line 77
    +
    at line 78
    public FFProbeDriver getFFProbeDriver()

    -

    -

    +

    +

    +

    +

    Return Value

    @@ -297,7 +330,8 @@ - +
    FFProbeDriver +
    @@ -307,13 +341,15 @@

    -
    at line 87
    +
    at line 88
    public FFProbe setFFProbeDriver(FFProbeDriver $ffprobe)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -321,7 +357,8 @@ FFProbeDriver $ffprobe - + + @@ -331,7 +368,8 @@ - +
    FFProbe +
    @@ -341,13 +379,15 @@

    -
    at line 99
    +
    at line 100
    public FFProbe setOptionsTester(OptionsTesterInterface $tester)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -355,7 +395,8 @@ OptionsTesterInterface $tester - + + @@ -365,7 +406,8 @@ - +
    FFProbe +
    @@ -375,13 +417,15 @@

    -
    at line 109
    +
    at line 110
    public OptionsTesterInterface getOptionsTester()

    -

    -

    +

    +

    +

    +

    Return Value

    @@ -389,7 +433,8 @@ - +
    OptionsTesterInterface +
    @@ -399,13 +444,15 @@

    -
    at line 119
    +
    at line 120
    public FFProbe setCache(Cache $cache)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -413,7 +460,8 @@ Cache $cache - + + @@ -423,7 +471,8 @@ - +
    FFProbe +
    @@ -433,13 +482,15 @@

    -
    at line 129
    +
    at line 130
    public Cache getCache()

    -

    -

    +

    +

    +

    +

    Return Value

    @@ -447,7 +498,8 @@ - +
    Cache +
    @@ -457,13 +509,15 @@

    -
    at line 137
    +
    at line 138
    public MapperInterface getMapper()

    -

    -

    +

    +

    +

    +

    Return Value

    @@ -471,7 +525,8 @@ - +
    MapperInterface +
    @@ -481,13 +536,15 @@

    -
    at line 147
    +
    at line 148
    public FFProbe setMapper(MapperInterface $mapper)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -495,7 +552,8 @@ MapperInterface $mapper - + + @@ -505,7 +563,8 @@ - +
    FFProbe +
    @@ -515,13 +574,15 @@

    -
    at line 166
    +
    at line 167
    public Format format(string $pathfile)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -529,7 +590,8 @@ string $pathfile - + + @@ -549,11 +611,13 @@ - + - +
    InvalidArgumentException +
    RuntimeException +
    @@ -562,13 +626,15 @@

    -
    at line 183
    +
    at line 184
    public StreamCollection streams(string $pathfile)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -576,7 +642,8 @@ string $pathfile - + + @@ -596,11 +663,13 @@ - + - +
    InvalidArgumentException +
    RuntimeException +
    @@ -609,13 +678,15 @@

    -
    at line 199
    +
    at line 200
    static public FFProbe create(array|ConfigurationInterface $configuration = array(), LoggerInterface $logger = null, Cache $cache = null)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -623,17 +694,20 @@ array|ConfigurationInterface $configuration - + + LoggerInterface $logger - + + Cache $cache - + + @@ -643,7 +717,8 @@ - +
    FFProbe +
    diff --git a/docs/source/API/API/FFMpeg/FFProbe/DataMapping.html b/docs/source/API/API/FFMpeg/FFProbe/DataMapping.html index dd631e2..27260db 100644 --- a/docs/source/API/API/FFMpeg/FFProbe/DataMapping.html +++ b/docs/source/API/API/FFMpeg/FFProbe/DataMapping.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -25,19 +26,23 @@ - + - + - + - +
    AbstractData +
    Format +
    Stream +
    StreamCollection +
    diff --git a/docs/source/API/API/FFMpeg/FFProbe/DataMapping/AbstractData.html b/docs/source/API/API/FFMpeg/FFProbe/DataMapping/AbstractData.html index 40c7bc2..d85d701 100644 --- a/docs/source/API/API/FFMpeg/FFProbe/DataMapping/AbstractData.html +++ b/docs/source/API/API/FFMpeg/FFProbe/DataMapping/AbstractData.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFProbe\DataMapping\AbstractData

    -

    abstract class AbstractData implements +

    abstract class + AbstractData implements Countable

    @@ -37,7 +39,8 @@ __construct(array $properties) -

    +

    +

    @@ -60,6 +63,16 @@

    Returns the property value given its name.

    + + + + AbstractData + + + set(string $property, mixed $value) +

    Sets the property value given its name.

    + + @@ -102,8 +115,10 @@ __construct(array $properties)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -111,7 +126,8 @@ array $properties - + + @@ -128,7 +144,8 @@

    Returns true if data has property.

    -

    +

    +

    Parameters

    @@ -136,7 +153,8 @@ string $property - + + @@ -146,7 +164,8 @@ - +
    Boolean +
    @@ -162,7 +181,8 @@

    Returns the property value given its name.

    -

    +

    +

    Parameters

    @@ -170,7 +190,8 @@ string $property - + + @@ -180,7 +201,8 @@ - +
    mixed +
    @@ -195,17 +217,61 @@ +
    +
    + +

    +
    at line 61
    + public AbstractData + set(string $property, mixed $value) +

    +
    +

    Sets the property value given its name.

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + +
    string$property +
    mixed$value +
    + + +

    Return Value

    + + + + + + +
    AbstractData +
    + + +

    -
    at line 58
    +
    at line 73
    public array keys()

    Returns all property names.

    -

    +

    +

    Return Value

    @@ -213,7 +279,8 @@ - +
    array +
    @@ -223,13 +290,14 @@

    -
    at line 68
    +
    at line 83
    public array all()

    Returns all properties and their values.

    -

    +

    +

    Return Value

    @@ -237,7 +305,8 @@ - +
    array +
    @@ -247,13 +316,14 @@

    -
    at line 76
    +
    at line 91
    public count()

    {@inheritdoc}

    -

    +

    +

    diff --git a/docs/source/API/API/FFMpeg/FFProbe/DataMapping/Format.html b/docs/source/API/API/FFMpeg/FFProbe/DataMapping/Format.html index 903e3e0..0483759 100644 --- a/docs/source/API/API/FFMpeg/FFProbe/DataMapping/Format.html +++ b/docs/source/API/API/FFMpeg/FFProbe/DataMapping/Format.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFProbe\DataMapping\Format

    -

    class Format extends AbstractData

    +

    class + Format extends AbstractData

    @@ -36,7 +38,8 @@ __construct(array $properties) -

    +

    +

    from AbstractData @@ -59,6 +62,16 @@

    Returns the property value given its name.

    from AbstractData + + + + AbstractData + + + set(string $property, mixed $value) +

    Sets the property value given its name.

    + + from AbstractData @@ -101,8 +114,10 @@ __construct(array $properties)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -110,7 +125,8 @@ array $properties - + + @@ -127,7 +143,8 @@

    Returns true if data has property.

    -

    +

    +

    Parameters

    @@ -135,7 +152,8 @@ string $property - + + @@ -145,7 +163,8 @@ - +
    Boolean +
    @@ -161,7 +180,8 @@

    Returns the property value given its name.

    -

    +

    +

    Parameters

    @@ -169,7 +189,8 @@ string $property - + + @@ -179,7 +200,8 @@ - +
    mixed +
    @@ -194,17 +216,61 @@ +
    +
    + +

    +
    in AbstractData at line 61
    + public AbstractData + set(string $property, mixed $value) +

    +
    +

    Sets the property value given its name.

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + +
    string$property +
    mixed$value +
    + + +

    Return Value

    + + + + + + +
    AbstractData +
    + + +

    -
    in AbstractData at line 58
    +
    in AbstractData at line 73
    public array keys()

    Returns all property names.

    -

    +

    +

    Return Value

    @@ -212,7 +278,8 @@ - +
    array +
    @@ -222,13 +289,14 @@

    -
    in AbstractData at line 68
    +
    in AbstractData at line 83
    public array all()

    Returns all properties and their values.

    -

    +

    +

    Return Value

    @@ -236,7 +304,8 @@ - +
    array +
    @@ -246,13 +315,14 @@

    -
    in AbstractData at line 76
    +
    in AbstractData at line 91
    public count()

    {@inheritdoc}

    -

    +

    +

    diff --git a/docs/source/API/API/FFMpeg/FFProbe/DataMapping/Stream.html b/docs/source/API/API/FFMpeg/FFProbe/DataMapping/Stream.html index 651ed7b..d7b5e52 100644 --- a/docs/source/API/API/FFMpeg/FFProbe/DataMapping/Stream.html +++ b/docs/source/API/API/FFMpeg/FFProbe/DataMapping/Stream.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFProbe\DataMapping\Stream

    -

    class Stream extends AbstractData

    +

    class + Stream extends AbstractData

    @@ -36,7 +38,8 @@ __construct(array $properties) -

    +

    +

    from AbstractData @@ -59,6 +62,16 @@

    Returns the property value given its name.

    from AbstractData + + + + AbstractData + + + set(string $property, mixed $value) +

    Sets the property value given its name.

    + + from AbstractData @@ -109,6 +122,16 @@

    Returns true if the stream is a video stream.

    + + + + Dimension + + + getDimensions() +

    Returns the dimension of the video stream.

    + + @@ -121,8 +144,10 @@ __construct(array $properties)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -130,7 +155,8 @@ array $properties - + + @@ -147,7 +173,8 @@

    Returns true if data has property.

    -

    +

    +

    Parameters

    @@ -155,7 +182,8 @@ string $property - + + @@ -165,7 +193,8 @@ - +
    Boolean +
    @@ -181,7 +210,8 @@

    Returns the property value given its name.

    -

    +

    +

    Parameters

    @@ -189,7 +219,8 @@ string $property - + + @@ -199,7 +230,8 @@ - +
    mixed +
    @@ -214,17 +246,61 @@ +
    +
    + +

    +
    in AbstractData at line 61
    + public AbstractData + set(string $property, mixed $value) +

    +
    +

    Sets the property value given its name.

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + +
    string$property +
    mixed$value +
    + + +

    Return Value

    + + + + + + +
    AbstractData +
    + + +

    -
    in AbstractData at line 58
    +
    in AbstractData at line 73
    public array keys()

    Returns all property names.

    -

    +

    +

    Return Value

    @@ -232,7 +308,8 @@ - +
    array +
    @@ -242,13 +319,14 @@

    -
    in AbstractData at line 68
    +
    in AbstractData at line 83
    public array all()

    Returns all properties and their values.

    -

    +

    +

    Return Value

    @@ -256,7 +334,8 @@ - +
    array +
    @@ -266,13 +345,14 @@

    -
    in AbstractData at line 76
    +
    in AbstractData at line 91
    public count()

    {@inheritdoc}

    -

    +

    +

    @@ -281,13 +361,14 @@

    -
    at line 21
    +
    at line 25
    public Boolean isAudio()

    Returns true if the stream is an audio stream.

    -

    +

    +

    Return Value

    @@ -295,7 +376,8 @@ - +
    Boolean +
    @@ -305,13 +387,14 @@

    -
    at line 31
    +
    at line 35
    public Boolean isVideo()

    Returns true if the stream is a video stream.

    -

    +

    +

    Return Value

    @@ -319,12 +402,52 @@ - +
    Boolean +
    +
    +
    + +

    +
    at line 48
    + public Dimension + getDimensions() +

    +
    +

    Returns the dimension of the video stream.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    Dimension +
    + + +

    Exceptions

    + + + + + + + + + + +
    LogicExceptionIn case the stream is not a video stream.
    RuntimeExceptionIn case the dimensions can not be extracted.
    + +
    diff --git a/docs/source/API/API/FFMpeg/FFProbe/DataMapping/StreamCollection.html b/docs/source/API/API/FFMpeg/FFProbe/DataMapping/StreamCollection.html index 84e220e..47fccb9 100644 --- a/docs/source/API/API/FFMpeg/FFProbe/DataMapping/StreamCollection.html +++ b/docs/source/API/API/FFMpeg/FFProbe/DataMapping/StreamCollection.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFProbe\DataMapping\StreamCollection

    -

    class StreamCollection implements +

    class + StreamCollection implements Countable, IteratorAggregate

    @@ -37,7 +39,8 @@ __construct(array $streams = array()) -

    +

    +

    @@ -122,8 +125,10 @@ __construct(array $streams = array())
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -131,7 +136,8 @@ array $streams - + + @@ -148,7 +154,8 @@

    Returns the first stream of the collection, null if the collection is empty.

    -

    +

    +

    Return Value

    @@ -156,7 +163,8 @@ - +
    null|Stream +
    @@ -172,7 +180,8 @@

    Adds a stream to the collection.

    -

    +

    +

    Parameters

    @@ -180,7 +189,8 @@ Stream $stream - + + @@ -190,7 +200,8 @@ - +
    StreamCollection +
    @@ -206,7 +217,8 @@

    Returns a new StreamCollection with only video streams.

    -

    +

    +

    Return Value

    @@ -214,7 +226,8 @@ - +
    StreamCollection +
    @@ -230,7 +243,8 @@

    Returns a new StreamCollection with only audio streams.

    -

    +

    +

    Return Value

    @@ -238,7 +252,8 @@ - +
    StreamCollection +
    @@ -254,7 +269,8 @@

    {@inheritdoc}

    -

    +

    +

    @@ -269,7 +285,8 @@

    Returns the array of contained streams.

    -

    +

    +

    Return Value

    @@ -277,7 +294,8 @@ - +
    array +
    @@ -293,7 +311,8 @@

    {@inheritdoc}

    -

    +

    +

    diff --git a/docs/source/API/API/FFMpeg/FFProbe/Mapper.html b/docs/source/API/API/FFMpeg/FFProbe/Mapper.html index 64cbe01..5140931 100644 --- a/docs/source/API/API/FFMpeg/FFProbe/Mapper.html +++ b/docs/source/API/API/FFMpeg/FFProbe/Mapper.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFProbe\Mapper

    -

    class Mapper implements +

    class + Mapper implements MapperInterface

    @@ -53,7 +55,8 @@

    Maps data given its type.

    -

    +

    +

    Parameters

    @@ -76,7 +79,8 @@ - +
    Format|Stream +
    diff --git a/docs/source/API/API/FFMpeg/FFProbe/MapperInterface.html b/docs/source/API/API/FFMpeg/FFProbe/MapperInterface.html index 07f1070..7bc428d 100644 --- a/docs/source/API/API/FFMpeg/FFProbe/MapperInterface.html +++ b/docs/source/API/API/FFMpeg/FFProbe/MapperInterface.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFProbe\MapperInterface

    -

    interface MapperInterface

    +

    interface + MapperInterface

    @@ -52,7 +54,8 @@

    Maps data given its type.

    -

    +

    +

    Parameters

    @@ -75,7 +78,8 @@ - +
    Format|Stream +
    diff --git a/docs/source/API/API/FFMpeg/FFProbe/OptionsTester.html b/docs/source/API/API/FFMpeg/FFProbe/OptionsTester.html index 591396b..63c5bd2 100644 --- a/docs/source/API/API/FFMpeg/FFProbe/OptionsTester.html +++ b/docs/source/API/API/FFMpeg/FFProbe/OptionsTester.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFProbe\OptionsTester

    -

    class OptionsTester implements +

    class + OptionsTester implements OptionsTesterInterface

    @@ -37,7 +39,8 @@ __construct(FFProbeDriver $ffprobe, Cache $cache) -

    +

    +

    @@ -57,13 +60,15 @@

    Details

    -
    at line 24
    +
    at line 26
    public __construct(FFProbeDriver $ffprobe, Cache $cache)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -71,12 +76,14 @@ FFProbeDriver $ffprobe - + + Cache $cache - + + @@ -87,13 +94,14 @@

    -
    at line 33
    +
    at line 35
    public Boolean has(string $name)

    Tells if the given option is supported by ffprobe.

    -

    +

    +

    Parameters

    @@ -101,7 +109,8 @@ string $name - + + @@ -111,7 +120,8 @@ - +
    Boolean +
    diff --git a/docs/source/API/API/FFMpeg/FFProbe/OptionsTesterInterface.html b/docs/source/API/API/FFMpeg/FFProbe/OptionsTesterInterface.html index e5f551c..05daf8f 100644 --- a/docs/source/API/API/FFMpeg/FFProbe/OptionsTesterInterface.html +++ b/docs/source/API/API/FFMpeg/FFProbe/OptionsTesterInterface.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFProbe\OptionsTesterInterface

    -

    interface OptionsTesterInterface

    +

    interface + OptionsTesterInterface

    @@ -52,7 +54,8 @@

    Tells if the given option is supported by ffprobe.

    -

    +

    +

    Parameters

    @@ -60,7 +63,8 @@ string $name - + + @@ -70,7 +74,8 @@ - +
    Boolean +
    diff --git a/docs/source/API/API/FFMpeg/FFProbe/OutputParser.html b/docs/source/API/API/FFMpeg/FFProbe/OutputParser.html index 0fbf3ed..bd52767 100644 --- a/docs/source/API/API/FFMpeg/FFProbe/OutputParser.html +++ b/docs/source/API/API/FFMpeg/FFProbe/OutputParser.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFProbe\OutputParser

    -

    class OutputParser implements +

    class + OutputParser implements OutputParserInterface

    @@ -53,7 +55,8 @@

    Parses ffprobe raw output.

    -

    +

    +

    Parameters

    @@ -76,7 +79,8 @@ - +
    array +
    diff --git a/docs/source/API/API/FFMpeg/FFProbe/OutputParserInterface.html b/docs/source/API/API/FFMpeg/FFProbe/OutputParserInterface.html index defa520..f7e9b0f 100644 --- a/docs/source/API/API/FFMpeg/FFProbe/OutputParserInterface.html +++ b/docs/source/API/API/FFMpeg/FFProbe/OutputParserInterface.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\FFProbe\OutputParserInterface

    -

    interface OutputParserInterface

    +

    interface + OutputParserInterface

    @@ -52,7 +54,8 @@

    Parses ffprobe raw output.

    -

    +

    +

    Parameters

    @@ -75,7 +78,8 @@ - +
    array +
    diff --git a/docs/source/API/API/FFMpeg/Filters.html b/docs/source/API/API/FFMpeg/Filters.html index 5181ffb..ef7e868 100644 --- a/docs/source/API/API/FFMpeg/Filters.html +++ b/docs/source/API/API/FFMpeg/Filters.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -25,7 +26,8 @@ - +
    FiltersCollection +
    @@ -33,7 +35,8 @@ - +
    FilterInterface +
    diff --git a/docs/source/API/API/FFMpeg/Filters/Audio.html b/docs/source/API/API/FFMpeg/Filters/Audio.html index f4a2745..cdd2c60 100644 --- a/docs/source/API/API/FFMpeg/Filters/Audio.html +++ b/docs/source/API/API/FFMpeg/Filters/Audio.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -25,15 +26,18 @@ - + - + - +
    AudioFilters +
    AudioResamplableFilter +
    SimpleFilter +
    @@ -41,7 +45,8 @@ - +
    AudioFilterInterface +
    diff --git a/docs/source/API/API/FFMpeg/Filters/Audio/AudioFilterInterface.html b/docs/source/API/API/FFMpeg/Filters/Audio/AudioFilterInterface.html index 55ef3c9..0914570 100644 --- a/docs/source/API/API/FFMpeg/Filters/Audio/AudioFilterInterface.html +++ b/docs/source/API/API/FFMpeg/Filters/Audio/AudioFilterInterface.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\Audio\AudioFilterInterface

    -

    interface AudioFilterInterface implements +

    interface + AudioFilterInterface implements FilterInterface

    @@ -63,7 +65,8 @@

    Returns the priority of the filter.

    -

    +

    +

    Return Value

    @@ -71,7 +74,8 @@ - +
    integer +
    @@ -87,7 +91,8 @@

    Applies the filter on the the Audio media given an format.

    -

    +

    +

    Parameters

    @@ -95,12 +100,14 @@ Audio $audio - + + AudioInterface $format - + + diff --git a/docs/source/API/API/FFMpeg/Filters/Audio/AudioFilters.html b/docs/source/API/API/FFMpeg/Filters/Audio/AudioFilters.html index 13a7974..fe079c2 100644 --- a/docs/source/API/API/FFMpeg/Filters/Audio/AudioFilters.html +++ b/docs/source/API/API/FFMpeg/Filters/Audio/AudioFilters.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\Audio\AudioFilters

    -

    class AudioFilters

    +

    class + AudioFilters

    @@ -36,7 +38,8 @@ __construct(Audio $media) -

    +

    +

    @@ -56,13 +59,15 @@

    Details

    -
    at line 12
    +
    at line 11
    public __construct(Audio $media)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -70,7 +75,8 @@ Audio $media - + + @@ -81,13 +87,14 @@

    -
    at line 24
    +
    at line 23
    public AudioFilters resample(Integer $rate)

    Resamples the audio file.

    -

    +

    +

    Parameters

    @@ -95,7 +102,8 @@ Integer $rate - + + @@ -105,7 +113,8 @@ - +
    AudioFilters +
    diff --git a/docs/source/API/API/FFMpeg/Filters/Audio/AudioResamplableFilter.html b/docs/source/API/API/FFMpeg/Filters/Audio/AudioResamplableFilter.html index 577e230..62589a2 100644 --- a/docs/source/API/API/FFMpeg/Filters/Audio/AudioResamplableFilter.html +++ b/docs/source/API/API/FFMpeg/Filters/Audio/AudioResamplableFilter.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\Audio\AudioResamplableFilter

    -

    class AudioResamplableFilter implements +

    class + AudioResamplableFilter implements AudioFilterInterface

    @@ -37,7 +39,8 @@ __construct($rate, $priority) -

    +

    +

    @@ -57,7 +60,8 @@ getRate() -

    +

    +

    @@ -82,8 +86,10 @@ __construct($rate, $priority)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -91,12 +97,14 @@ $rate - + + $priority - + + @@ -113,7 +121,8 @@

    Returns the priority of the filter.

    -

    +

    +

    Return Value

    @@ -121,7 +130,8 @@ - +
    integer +
    @@ -136,8 +146,10 @@ getRate()
    -

    -

    +

    +

    +

    +

    Return Value

    @@ -145,7 +157,8 @@ - +
    Integer +
    @@ -161,7 +174,8 @@

    Applies the filter on the the Audio media given an format.

    -

    +

    +

    Parameters

    @@ -169,12 +183,14 @@ Audio $audio - + + AudioInterface $format - + + diff --git a/docs/source/API/API/FFMpeg/Filters/Audio/SimpleFilter.html b/docs/source/API/API/FFMpeg/Filters/Audio/SimpleFilter.html index 781a9b8..03bf5c1 100644 --- a/docs/source/API/API/FFMpeg/Filters/Audio/SimpleFilter.html +++ b/docs/source/API/API/FFMpeg/Filters/Audio/SimpleFilter.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\Audio\SimpleFilter

    -

    class SimpleFilter implements +

    class + SimpleFilter implements AudioFilterInterface

    @@ -37,7 +39,8 @@ __construct(array $params, $priority) -

    +

    +

    @@ -72,8 +75,10 @@ __construct(array $params, $priority)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -81,12 +86,14 @@ array $params - + + $priority - + + @@ -103,7 +110,8 @@

    Returns the priority of the filter.

    -

    +

    +

    Return Value

    @@ -111,7 +119,8 @@ - +
    integer +
    @@ -127,7 +136,8 @@

    Applies the filter on the the Audio media given an format.

    -

    +

    +

    Parameters

    @@ -135,12 +145,14 @@ Audio $audio - + + AudioInterface $format - + + diff --git a/docs/source/API/API/FFMpeg/Filters/FilterInterface.html b/docs/source/API/API/FFMpeg/Filters/FilterInterface.html index 18b5efa..abc5eaa 100644 --- a/docs/source/API/API/FFMpeg/Filters/FilterInterface.html +++ b/docs/source/API/API/FFMpeg/Filters/FilterInterface.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\FilterInterface

    -

    interface FilterInterface

    +

    interface + FilterInterface

    @@ -52,7 +54,8 @@

    Returns the priority of the filter.

    -

    +

    +

    Return Value

    @@ -60,7 +63,8 @@ - +
    integer +
    diff --git a/docs/source/API/API/FFMpeg/Filters/FiltersCollection.html b/docs/source/API/API/FFMpeg/Filters/FiltersCollection.html index 38e140a..65e0739 100644 --- a/docs/source/API/API/FFMpeg/Filters/FiltersCollection.html +++ b/docs/source/API/API/FFMpeg/Filters/FiltersCollection.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\FiltersCollection

    -

    class FiltersCollection implements +

    class + FiltersCollection implements Countable, IteratorAggregate

    @@ -37,7 +39,8 @@ add(FilterInterface $filter) -

    +

    +

    @@ -72,8 +75,10 @@ add(FilterInterface $filter)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -81,7 +86,8 @@ FilterInterface $filter - + + @@ -91,7 +97,8 @@ - +
    FiltersCollection +
    @@ -107,7 +114,8 @@

    {@inheritdoc}

    -

    +

    +

    @@ -122,7 +130,8 @@

    {@inheritdoc}

    -

    +

    +

    diff --git a/docs/source/API/API/FFMpeg/Filters/Frame.html b/docs/source/API/API/FFMpeg/Filters/Frame.html index 80c074c..2c997c8 100644 --- a/docs/source/API/API/FFMpeg/Filters/Frame.html +++ b/docs/source/API/API/FFMpeg/Filters/Frame.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -24,8 +25,14 @@
    + + + + - +
    DisplayRatioFixerFilter +
    FrameFilters +
    @@ -33,7 +40,8 @@ - +
    FrameFilterInterface +
    diff --git a/docs/source/API/API/FFMpeg/Filters/Frame/DisplayRatioFixerFilter.html b/docs/source/API/API/FFMpeg/Filters/Frame/DisplayRatioFixerFilter.html new file mode 100644 index 0000000..7be0e1b --- /dev/null +++ b/docs/source/API/API/FFMpeg/Filters/Frame/DisplayRatioFixerFilter.html @@ -0,0 +1,161 @@ + + + + + + FFMpeg\Filters\Frame\DisplayRatioFixerFilter | PHP-FFMpeg API + + + +
    + + +
    PHP-FFMpeg API
    + +
    Class
    +

    FFMpeg\Filters\Frame\DisplayRatioFixerFilter

    +
    +
    +

    class + DisplayRatioFixerFilter implements + FrameFilterInterface

    + + + + +

    Methods

    + + + + + + + + + + + + + + + + + +
    + + + __construct($priority) +

    +

    +
    + integer + + getPriority() +

    Returns the priority of the filter.

    +
    + + + apply(Frame $frame) +

    +

    +
    + + +

    Details

    + +

    +
    at line 22
    + public + __construct($priority) +

    +
    +

    +

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    $priority +
    + + + + +
    +
    + +

    +
    at line 30
    + public integer + getPriority() +

    +
    +

    Returns the priority of the filter.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    at line 38
    + public + apply(Frame $frame) +

    +
    +

    +

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    Frame$frame +
    + + + + +
    +
    + + +
    + + + diff --git a/docs/source/API/API/FFMpeg/Filters/Frame/FrameFilterInterface.html b/docs/source/API/API/FFMpeg/Filters/Frame/FrameFilterInterface.html index b6a7fbc..6273615 100644 --- a/docs/source/API/API/FFMpeg/Filters/Frame/FrameFilterInterface.html +++ b/docs/source/API/API/FFMpeg/Filters/Frame/FrameFilterInterface.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\Frame\FrameFilterInterface

    -

    interface FrameFilterInterface implements +

    interface + FrameFilterInterface implements FilterInterface

    @@ -46,8 +48,9 @@ - apply(Frame $frame, FrameInterface $format) -

    + apply(Frame $frame) +

    +

    @@ -63,7 +66,8 @@

    Returns the priority of the filter.

    -

    +

    +

    Return Value

    @@ -71,7 +75,8 @@ - +
    integer +
    @@ -81,13 +86,15 @@

    -
    at line 20
    +
    at line 19
    public - apply(Frame $frame, FrameInterface $format) + apply(Frame $frame)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -95,12 +102,8 @@ Frame $frame - - - - FrameInterface - $format - + + diff --git a/docs/source/API/API/FFMpeg/Filters/Frame/FrameFilters.html b/docs/source/API/API/FFMpeg/Filters/Frame/FrameFilters.html index 88eeef9..41ea375 100644 --- a/docs/source/API/API/FFMpeg/Filters/Frame/FrameFilters.html +++ b/docs/source/API/API/FFMpeg/Filters/Frame/FrameFilters.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\Frame\FrameFilters

    -

    class FrameFilters

    +

    class + FrameFilters

    @@ -36,7 +38,18 @@ __construct(Frame $frame) -

    +

    +

    + + + + + + FrameFilters + + + fixDisplayRatio() +

    Fixes the display ratio of the output frame.

    @@ -51,8 +64,10 @@ __construct(Frame $frame)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -60,13 +75,40 @@ Frame $frame - + + +
    +
    + +

    +
    at line 33
    + public FrameFilters + fixDisplayRatio() +

    +
    +

    Fixes the display ratio of the output frame.

    +

    In case the sample ratio and display ratio are different, image may be +anamorphozed. This filter fixes this by specifying the output size.

    +
    + +

    Return Value

    + + + + + + +
    FrameFilters +
    + + +
    diff --git a/docs/source/API/API/FFMpeg/Filters/Video.html b/docs/source/API/API/FFMpeg/Filters/Video.html index 1fc49bb..c474efe 100644 --- a/docs/source/API/API/FFMpeg/Filters/Video.html +++ b/docs/source/API/API/FFMpeg/Filters/Video.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -24,12 +25,29 @@
    + + + + + + + + - + - + + + + + @@ -37,7 +55,13 @@ - + + + + +
    ClipFilter +
    CustomFilter +
    FrameRateFilter +
    ResizeFilter +
    RotateFilter +
    SynchronizeFilter
    VideoFilters +
    WatermarkFilter +
    @@ -45,7 +69,8 @@ - +
    VideoFilterInterface +
    diff --git a/docs/source/API/API/FFMpeg/Filters/Video/ClipFilter.html b/docs/source/API/API/FFMpeg/Filters/Video/ClipFilter.html new file mode 100644 index 0000000..ae86587 --- /dev/null +++ b/docs/source/API/API/FFMpeg/Filters/Video/ClipFilter.html @@ -0,0 +1,262 @@ + + + + + + FFMpeg\Filters\Video\ClipFilter | PHP-FFMpeg API + + + +
    + + +
    PHP-FFMpeg API
    + +
    Class
    +

    FFMpeg\Filters\Video\ClipFilter

    +
    +
    +

    class + ClipFilter implements + VideoFilterInterface

    + + + + +

    Methods

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + __construct(TimeCode $start, TimeCode $duration = null, $priority) +

    +

    +
    + integer + + getPriority() +

    Returns the priority of the filter.

    +
    + TimeCode + + getStart() +

    +

    +
    + TimeCode + + getDuration() +

    +

    +
    + array + + apply(Video $video, VideoInterface $format) +

    Applies the filter on the the Video media given an format.

    +
    + + +

    Details

    + +

    +
    at line 27
    + public + __construct(TimeCode $start, TimeCode $duration = null, $priority) +

    +
    +

    +

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    TimeCode$start +
    TimeCode$duration +
    $priority +
    + + + + +
    +
    + +

    +
    at line 37
    + public integer + getPriority() +

    +
    +

    Returns the priority of the filter.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    at line 45
    + public TimeCode + getStart() +

    +
    +

    +

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    TimeCode +
    + + + +
    +
    + +

    +
    at line 53
    + public TimeCode + getDuration() +

    +
    +

    +

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    TimeCode +
    + + + +
    +
    + +

    +
    at line 61
    + public array + apply(Video $video, VideoInterface $format) +

    +
    +

    Applies the filter on the the Video media given an format.

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + +
    Video$video +
    VideoInterface$format +
    + + +

    Return Value

    + + + + + + +
    arrayAn array of arguments
    + + + +
    +
    + + +
    + + + diff --git a/docs/source/API/API/FFMpeg/Filters/Video/CustomFilter.html b/docs/source/API/API/FFMpeg/Filters/Video/CustomFilter.html new file mode 100644 index 0000000..141c4ff --- /dev/null +++ b/docs/source/API/API/FFMpeg/Filters/Video/CustomFilter.html @@ -0,0 +1,178 @@ + + + + + + FFMpeg\Filters\Video\CustomFilter | PHP-FFMpeg API + + + +
    + + +
    PHP-FFMpeg API
    + +
    Class
    +

    FFMpeg\Filters\Video\CustomFilter

    +
    +
    +

    class + CustomFilter implements + VideoFilterInterface

    + + + + +

    Methods

    + + + + + + + + + + + + + + + + + +
    + + + __construct(string $filter, int $priority) +

    A custom filter, useful if you want to build complex filters

    +
    + integer + + getPriority() +

    Returns the priority of the filter.

    +
    + array + + apply(Video $video, VideoInterface $format) +

    Applies the filter on the the Video media given an format.

    +
    + + +

    Details

    + +

    +
    at line 29
    + public + __construct(string $filter, int $priority) +

    +
    +

    A custom filter, useful if you want to build complex filters

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + +
    string$filter +
    int$priority +
    + + + + +
    +
    + +

    +
    at line 38
    + public integer + getPriority() +

    +
    +

    Returns the priority of the filter.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    at line 46
    + public array + apply(Video $video, VideoInterface $format) +

    +
    +

    Applies the filter on the the Video media given an format.

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + +
    Video$video +
    VideoInterface$format +
    + + +

    Return Value

    + + + + + + +
    arrayAn array of arguments
    + + + +
    +
    + + +
    + + + diff --git a/docs/source/API/API/FFMpeg/Filters/Video/FrameRateFilter.html b/docs/source/API/API/FFMpeg/Filters/Video/FrameRateFilter.html index 846b8fc..fb9dcfc 100644 --- a/docs/source/API/API/FFMpeg/Filters/Video/FrameRateFilter.html +++ b/docs/source/API/API/FFMpeg/Filters/Video/FrameRateFilter.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\Video\FrameRateFilter

    -

    class FrameRateFilter implements +

    class + FrameRateFilter implements VideoFilterInterface

    @@ -37,7 +39,8 @@ __construct(FrameRate $rate, $gop, $priority) -

    +

    +

    @@ -92,8 +95,10 @@ __construct(FrameRate $rate, $gop, $priority)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -101,17 +106,20 @@ FrameRate $rate - + + $gop - + + $priority - + + @@ -128,7 +136,8 @@

    Returns the priority of the filter.

    -

    +

    +

    Return Value

    @@ -136,7 +145,8 @@ - +
    integer +
    @@ -152,7 +162,8 @@

    Returns the frame rate.

    -

    +

    +

    Return Value

    @@ -160,7 +171,8 @@ - +
    FrameRate +
    @@ -176,7 +188,8 @@

    Returns the GOP size.

    -

    +

    +

    Return Value

    @@ -184,7 +197,8 @@ - +
    Integer +
    @@ -209,7 +223,8 @@

    Applies the filter on the the Video media given an format.

    -

    +

    +

    Parameters

    @@ -217,12 +232,14 @@ Video $video - + + VideoInterface $format - + + diff --git a/docs/source/API/API/FFMpeg/Filters/Video/ResizeFilter.html b/docs/source/API/API/FFMpeg/Filters/Video/ResizeFilter.html index ca655d8..f57c541 100644 --- a/docs/source/API/API/FFMpeg/Filters/Video/ResizeFilter.html +++ b/docs/source/API/API/FFMpeg/Filters/Video/ResizeFilter.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\Video\ResizeFilter

    -

    class ResizeFilter implements +

    class + ResizeFilter implements VideoFilterInterface

    @@ -33,28 +35,32 @@ RESIZEMODE_FIT

    fits to the dimensions, might introduce anamorphosis

    -

    +

    +

    RESIZEMODE_INSET

    resizes the video inside the given dimension, no anamorphosis

    -

    +

    +

    RESIZEMODE_SCALE_WIDTH

    resizes the video to fit the dimension width, no anamorphosis

    -

    +

    +

    RESIZEMODE_SCALE_HEIGHT

    resizes the video to fit the dimension height, no anamorphosis

    -

    +

    +

    @@ -70,7 +76,8 @@ __construct(Dimension $dimension, $mode = self::RESIZEMODE_FIT, $forceStandards = true, $priority) -

    +

    +

    @@ -90,7 +97,8 @@ getDimension() -

    +

    +

    @@ -100,7 +108,8 @@ getMode() -

    +

    +

    @@ -110,7 +119,8 @@ areStandardsForced() -

    +

    +

    @@ -130,13 +140,15 @@

    Details

    -
    at line 38
    +
    at line 39
    public __construct(Dimension $dimension, $mode = self::RESIZEMODE_FIT, $forceStandards = true, $priority)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -144,22 +156,26 @@ Dimension $dimension - + + $mode - + + $forceStandards - + + $priority - + + @@ -170,13 +186,14 @@

    -
    at line 49
    +
    at line 50
    public integer getPriority()

    Returns the priority of the filter.

    -

    +

    +

    Return Value

    @@ -184,7 +201,8 @@ - +
    integer +
    @@ -194,13 +212,15 @@

    -
    at line 57
    +
    at line 58
    public Dimension getDimension()

    -

    -

    +

    +

    +

    +

    Return Value

    @@ -208,7 +228,8 @@ - +
    Dimension +
    @@ -218,13 +239,15 @@

    -
    at line 65
    +
    at line 66
    public string getMode()

    -

    -

    +

    +

    +

    +

    Return Value

    @@ -232,7 +255,8 @@ - +
    string +
    @@ -242,13 +266,15 @@

    -
    at line 73
    +
    at line 74
    public Boolean areStandardsForced()

    -

    -

    +

    +

    +

    +

    Return Value

    @@ -256,7 +282,8 @@ - +
    Boolean +
    @@ -266,13 +293,14 @@

    -
    at line 81
    +
    at line 82
    public array apply(Video $video, VideoInterface $format)

    Applies the filter on the the Video media given an format.

    -

    +

    +

    Parameters

    @@ -280,12 +308,14 @@ Video $video - + + VideoInterface $format - + + diff --git a/docs/source/API/API/FFMpeg/Filters/Video/RotateFilter.html b/docs/source/API/API/FFMpeg/Filters/Video/RotateFilter.html new file mode 100644 index 0000000..819e3ca --- /dev/null +++ b/docs/source/API/API/FFMpeg/Filters/Video/RotateFilter.html @@ -0,0 +1,250 @@ + + + + + + FFMpeg\Filters\Video\RotateFilter | PHP-FFMpeg API + + + +
    + + +
    PHP-FFMpeg API
    + +
    Class
    +

    FFMpeg\Filters\Video\RotateFilter

    +
    +
    +

    class + RotateFilter implements + VideoFilterInterface

    + + +

    Constants

    + + + + + + + + + + + + + + +
    ROTATE_90 +

    +

    +

    +

    +
    ROTATE_180 +

    +

    +

    +

    +
    ROTATE_270 +

    +

    +

    +

    +
    + + + +

    Methods

    + + + + + + + + + + + + + + + + + + + + + + +
    + + + __construct($angle, $priority) +

    +

    +
    + integer + + getPriority() +

    Returns the priority of the filter.

    +
    + Dimension + + getAngle() +

    +

    +
    + array + + apply(Video $video, VideoInterface $format) +

    Applies the filter on the the Video media given an format.

    +
    + + +

    Details

    + +

    +
    at line 30
    + public + __construct($angle, $priority) +

    +
    +

    +

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + +
    $angle +
    $priority +
    + + + + +
    +
    + +

    +
    at line 39
    + public integer + getPriority() +

    +
    +

    Returns the priority of the filter.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    at line 47
    + public Dimension + getAngle() +

    +
    +

    +

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    Dimension +
    + + + +
    +
    + +

    +
    at line 55
    + public array + apply(Video $video, VideoInterface $format) +

    +
    +

    Applies the filter on the the Video media given an format.

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + +
    Video$video +
    VideoInterface$format +
    + + +

    Return Value

    + + + + + + +
    arrayAn array of arguments
    + + + +
    +
    + + +
    + + + diff --git a/docs/source/API/API/FFMpeg/Filters/Video/SynchronizeFilter.html b/docs/source/API/API/FFMpeg/Filters/Video/SynchronizeFilter.html index 3e18c71..e6549e5 100644 --- a/docs/source/API/API/FFMpeg/Filters/Video/SynchronizeFilter.html +++ b/docs/source/API/API/FFMpeg/Filters/Video/SynchronizeFilter.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,12 +23,14 @@

    FFMpeg\Filters\Video\SynchronizeFilter

    -

    class SynchronizeFilter implements +

    class + SynchronizeFilter implements VideoFilterInterface

    Synchronizes audio and video in case of desynchronized movies.

    -

    +

    +

    @@ -41,7 +44,8 @@ __construct($priority = 12) -

    +

    +

    @@ -76,8 +80,10 @@ __construct($priority = 12)
    -

    -

    +

    +

    +

    +

    Parameters

    @@ -85,7 +91,8 @@ $priority - + + @@ -102,7 +109,8 @@

    Returns the priority of the filter.

    -

    +

    +

    Return Value

    @@ -110,7 +118,8 @@ - +
    integer +
    @@ -126,7 +135,8 @@

    Applies the filter on the the Video media given an format.

    -

    +

    +

    Parameters

    @@ -134,12 +144,14 @@ Video $video - + + VideoInterface $format - + + diff --git a/docs/source/API/API/FFMpeg/Filters/Video/VideoFilterInterface.html b/docs/source/API/API/FFMpeg/Filters/Video/VideoFilterInterface.html index f88d6e3..41bd0d4 100644 --- a/docs/source/API/API/FFMpeg/Filters/Video/VideoFilterInterface.html +++ b/docs/source/API/API/FFMpeg/Filters/Video/VideoFilterInterface.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\Video\VideoFilterInterface

    -

    interface VideoFilterInterface implements +

    interface + VideoFilterInterface implements FilterInterface

    @@ -63,7 +65,8 @@

    Returns the priority of the filter.

    -

    +

    +

    Return Value

    @@ -71,7 +74,8 @@ - +
    integer +
    @@ -87,7 +91,8 @@

    Applies the filter on the the Video media given an format.

    -

    +

    +

    Parameters

    @@ -95,12 +100,14 @@ Video $video - + + VideoInterface $format - + + diff --git a/docs/source/API/API/FFMpeg/Filters/Video/VideoFilters.html b/docs/source/API/API/FFMpeg/Filters/Video/VideoFilters.html index fa0b2b5..21b2669 100644 --- a/docs/source/API/API/FFMpeg/Filters/Video/VideoFilters.html +++ b/docs/source/API/API/FFMpeg/Filters/Video/VideoFilters.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Filters\Video\VideoFilters

    -

    class VideoFilters extends AudioFilters

    +

    class + VideoFilters extends AudioFilters

    @@ -36,7 +38,8 @@ __construct(Video $media) -

    +

    +

    @@ -79,6 +82,16 @@

    Synchronizes audio and video.

    + + + + VideoFilters + + + clip(TimeCode $start, TimeCode $duration = null) +

    Clips (cuts) the video.

    + + @@ -89,6 +102,28 @@

    Resamples the audio file.

    + + + + + + + rotate($angle) +

    +

    + + + + + + $this + + + watermark(string $imagePath, array $coordinates = array()) +

    +

    + + @@ -96,13 +131,15 @@

    Details

    -
    at line 22
    +
    at line 23
    public __construct(Video $media)

    -

    -

    +

    +

    +

    +

    Parameters

    @@ -110,7 +147,8 @@ Video $media - + + @@ -121,13 +159,14 @@

    -
    in AudioFilters at line 24
    +
    in AudioFilters at line 23
    public AudioFilters resample(Integer $rate)

    Resamples the audio file.

    -

    +

    +

    Parameters

    @@ -135,7 +174,8 @@ Integer $rate - + + @@ -145,7 +185,8 @@ - +
    AudioFilters +
    @@ -155,13 +196,14 @@

    -
    at line 36
    +
    at line 37
    public VideoFilters resize(Dimension $dimension, string $mode = ResizeFilter::RESIZEMODE_FIT, Boolean $forceStandards = true)

    Resizes a video to a given dimension.

    -

    +

    +

    Parameters

    @@ -169,17 +211,20 @@ Dimension $dimension - + + string $mode - + + Boolean $forceStandards - + + @@ -189,7 +234,8 @@ - +
    VideoFilters +
    @@ -199,13 +245,14 @@

    -
    at line 51
    +
    at line 52
    public VideoFilters framerate(FrameRate $framerate, type $gop)

    Changes the video framerate.

    -

    +

    +

    Parameters

    @@ -213,12 +260,14 @@ FrameRate $framerate - + + type $gop - + + @@ -228,7 +277,8 @@ - +
    VideoFilters +
    @@ -238,13 +288,14 @@

    -
    at line 63
    +
    at line 64
    public VideoFilters synchronize()

    Synchronizes audio and video.

    -

    +

    +

    Return Value

    @@ -252,7 +303,51 @@ - + + +
    VideoFilters +
    + + + +
    +
    + +

    +
    at line 79
    + public VideoFilters + clip(TimeCode $start, TimeCode $duration = null) +

    +
    +

    Clips (cuts) the video.

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + +
    TimeCode$start +
    TimeCode$duration +
    + + +

    Return Value

    + + + + +
    VideoFilters +
    @@ -262,13 +357,14 @@

    -
    at line 77
    +
    at line 93
    public AudioFilters audioResample(Integer $rate)

    Resamples the audio file.

    -

    +

    +

    Parameters

    @@ -276,7 +372,8 @@ Integer $rate - + + @@ -286,7 +383,80 @@ - + + +
    AudioFilters +
    + + + +
    +
    + +

    +
    at line 100
    + public + rotate($angle) +

    +
    +

    +

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    $angle +
    + + + + +
    +
    + +

    +
    at line 113
    + public $this + watermark(string $imagePath, array $coordinates = array()) +

    +
    +

    +

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + +
    string$imagePath +
    array$coordinates +
    + + +

    Return Value

    + + + + +
    $this +
    diff --git a/docs/source/API/API/FFMpeg/Filters/Video/WatermarkFilter.html b/docs/source/API/API/FFMpeg/Filters/Video/WatermarkFilter.html new file mode 100644 index 0000000..4f97f5c --- /dev/null +++ b/docs/source/API/API/FFMpeg/Filters/Video/WatermarkFilter.html @@ -0,0 +1,186 @@ + + + + + + FFMpeg\Filters\Video\WatermarkFilter | PHP-FFMpeg API + + + +
    + + +
    PHP-FFMpeg API
    + +
    Class
    +

    FFMpeg\Filters\Video\WatermarkFilter

    +
    +
    +

    class + WatermarkFilter implements + VideoFilterInterface

    + + + + +

    Methods

    + + + + + + + + + + + + + + + + + +
    + + + __construct($watermarkPath, array $coordinates = array(), $priority) +

    +

    +
    + integer + + getPriority() +

    Returns the priority of the filter.

    +
    + array + + apply(Video $video, VideoInterface $format) +

    Applies the filter on the the Video media given an format.

    +
    + + +

    Details

    + +

    +
    at line 26
    + public + __construct($watermarkPath, array $coordinates = array(), $priority) +

    +
    +

    +

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    $watermarkPath +
    array$coordinates +
    $priority +
    + + + + +
    +
    + +

    +
    at line 36
    + public integer + getPriority() +

    +
    +

    Returns the priority of the filter.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    at line 44
    + public array + apply(Video $video, VideoInterface $format) +

    +
    +

    Applies the filter on the the Video media given an format.

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + +
    Video$video +
    VideoInterface$format +
    + + +

    Return Value

    + + + + + + +
    arrayAn array of arguments
    + + + +
    +
    + + +
    + + + diff --git a/docs/source/API/API/FFMpeg/Format.html b/docs/source/API/API/FFMpeg/Format.html index a04cb0e..8198a1f 100644 --- a/docs/source/API/API/FFMpeg/Format.html +++ b/docs/source/API/API/FFMpeg/Format.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -27,23 +28,28 @@ - + - + - + - + - +
    AudioInterface +
    FormatInterface +
    FrameInterface +
    ProgressableInterface +
    VideoInterface +
    diff --git a/docs/source/API/API/FFMpeg/Format/Audio.html b/docs/source/API/API/FFMpeg/Format/Audio.html index 8b4c1f1..a9fa753 100644 --- a/docs/source/API/API/FFMpeg/Format/Audio.html +++ b/docs/source/API/API/FFMpeg/Format/Audio.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -24,8 +25,13 @@
    + + + + - + @@ -34,6 +40,14 @@ + + + + + + + +
    AacThe AAC audio format
    DefaultAudio +
    Flac
    Mp3 The MP3 audio format
    VorbisThe Vorbis audio format
    WavThe WAV audio format
    diff --git a/docs/source/API/API/FFMpeg/Format/Audio/Aac.html b/docs/source/API/API/FFMpeg/Format/Audio/Aac.html new file mode 100644 index 0000000..abe6b07 --- /dev/null +++ b/docs/source/API/API/FFMpeg/Format/Audio/Aac.html @@ -0,0 +1,498 @@ + + + + + + FFMpeg\Format\Audio\Aac | PHP-FFMpeg API + + + +
    + + +
    PHP-FFMpeg API
    + +
    Class
    +

    FFMpeg\Format\Audio\Aac

    +
    +
    +

    class + Aac extends DefaultAudio

    + +
    +

    The AAC audio format

    +

    +

    +
    + + + +

    Methods

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + array() + + getExtraParams() +

    Returns an array of extra parameters to add to ffmpeg commandline.

    +     		from DefaultAudio
    + string + + getAudioCodec() +

    Returns the audio codec.

    +     		from DefaultAudio
    + + + setAudioCodec(string $audioCodec) +

    Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.

    +     		from DefaultAudio
    + integer + + getAudioKiloBitrate() +

    Gets the audio kiloBitrate value.

    +     		from DefaultAudio
    + + + setAudioKiloBitrate(integer $kiloBitrate) +

    Sets the kiloBitrate value.

    +     		from DefaultAudio
    + integer + + getAudioChannels() +

    Gets the audio channels value.

    +     		from DefaultAudio
    + + + setAudioChannels(integer $channels) +

    Sets the channels value.

    +     		from DefaultAudio
    + array + + createProgressListener(MediaTypeInterface $media, FFProbe $ffprobe, Integer $pass, Integer $total) +

    Creates the progress listener.

    +     		from DefaultAudio
    + string + + getPasses() +

    Returns the number of passes.

    +     		from DefaultAudio
    + + + __construct() +

    +

    +
    + array + + getAvailableAudioCodecs() +

    Returns the list of available audio codecs for this format.

    +
    + + +

    Details

    + +

    +
    in DefaultAudio at line 36
    + public array() + getExtraParams() +

    +
    +

    Returns an array of extra parameters to add to ffmpeg commandline.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    array() +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 44
    + public string + getAudioCodec() +

    +
    +

    Returns the audio codec.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    string +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 57
    + public + setAudioCodec(string $audioCodec) +

    +
    +

    Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    string$audioCodec +
    + + + +

    Exceptions

    + + + + + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    in DefaultAudio at line 74
    + public integer + getAudioKiloBitrate() +

    +
    +

    Gets the audio kiloBitrate value.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 85
    + public + setAudioKiloBitrate(integer $kiloBitrate) +

    +
    +

    Sets the kiloBitrate value.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    integer$kiloBitrate +
    + + + +

    Exceptions

    + + + + + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    in DefaultAudio at line 99
    + public integer + getAudioChannels() +

    +
    +

    Gets the audio channels value.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 110
    + public + setAudioChannels(integer $channels) +

    +
    +

    Sets the channels value.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    integer$channels +
    + + + +

    Exceptions

    + + + + + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    in DefaultAudio at line 124
    + public array + createProgressListener(MediaTypeInterface $media, FFProbe $ffprobe, Integer $pass, Integer $total) +

    +
    +

    Creates the progress listener.

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + +
    MediaTypeInterface$media +
    FFProbe$ffprobe +
    Integer$passThe current pas snumber
    Integer$totalThe total pass number
    + + +

    Return Value

    + + + + + + +
    arrayAn array of listeners
    + + + +
    +
    + +

    +
    in DefaultAudio at line 138
    + public string + getPasses() +

    +
    +

    Returns the number of passes.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    string +
    + + + +
    +
    + +

    +
    at line 19
    + public + __construct() +

    +
    +

    +

    +

    +

    +
    + + + +
    +
    + +

    +
    at line 27
    + public array + getAvailableAudioCodecs() +

    +
    +

    Returns the list of available audio codecs for this format.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    array +
    + + + +
    +
    + + +
    + + + diff --git a/docs/source/API/API/FFMpeg/Format/Audio/DefaultAudio.html b/docs/source/API/API/FFMpeg/Format/Audio/DefaultAudio.html index 6969bb3..5cbc856 100644 --- a/docs/source/API/API/FFMpeg/Format/Audio/DefaultAudio.html +++ b/docs/source/API/API/FFMpeg/Format/Audio/DefaultAudio.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Format\Audio\DefaultAudio

    -

    abstract class DefaultAudio extends EventEmitter implements +

    abstract class + DefaultAudio extends EventEmitter implements AudioInterface, ProgressableInterface

    @@ -80,6 +82,26 @@

    Sets the kiloBitrate value.

    + + + + integer + + + getAudioChannels() +

    Gets the audio channels value.

    + + + + + + + + + setAudioChannels(integer $channels) +

    Sets the channels value.

    + + @@ -90,6 +112,16 @@

    Creates the progress listener.

    + + + + string + + + getPasses() +

    Returns the number of passes.

    + + @@ -97,13 +129,14 @@

    Details

    -
    at line 33
    +
    at line 36
    public array() getExtraParams()

    Returns an array of extra parameters to add to ffmpeg commandline.

    -

    +

    +

    Return Value

    @@ -111,7 +144,8 @@ - +
    array() +
    @@ -121,13 +155,14 @@

    -
    at line 41
    +
    at line 44
    public string getAudioCodec()

    Returns the audio codec.

    -

    +

    +

    Return Value

    @@ -135,7 +170,8 @@ - +
    string +
    @@ -145,13 +181,14 @@

    -
    at line 54
    +
    at line 57
    public setAudioCodec(string $audioCodec)

    Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.

    -

    +

    +

    Parameters

    @@ -159,7 +196,8 @@ string $audioCodec - + + @@ -170,7 +208,8 @@ - +
    InvalidArgumentException +
    @@ -179,13 +218,14 @@

    -
    at line 71
    +
    at line 74
    public integer getAudioKiloBitrate()

    Gets the audio kiloBitrate value.

    -

    +

    +

    Return Value

    @@ -193,7 +233,8 @@ - +
    integer +
    @@ -203,13 +244,14 @@

    -
    at line 82
    +
    at line 85
    public setAudioKiloBitrate(integer $kiloBitrate)

    Sets the kiloBitrate value.

    -

    +

    +

    Parameters

    @@ -217,7 +259,8 @@ integer $kiloBitrate - + + @@ -228,7 +271,71 @@ - + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    at line 99
    + public integer + getAudioChannels() +

    +
    +

    Gets the audio channels value.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    at line 110
    + public + setAudioChannels(integer $channels) +

    +
    +

    Sets the channels value.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    integer$channels +
    + + + +

    Exceptions

    + + + + +
    InvalidArgumentException +
    @@ -237,13 +344,14 @@

    -
    at line 96
    +
    at line 124
    public array createProgressListener(MediaTypeInterface $media, FFProbe $ffprobe, Integer $pass, Integer $total)

    Creates the progress listener.

    -

    +

    +

    Parameters

    @@ -251,12 +359,14 @@ MediaTypeInterface $media - + + FFProbe $ffprobe - + + Integer @@ -282,6 +392,32 @@ +
    +
    + +

    +
    at line 138
    + public string + getPasses() +

    +
    +

    Returns the number of passes.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    string +
    + + +
    diff --git a/docs/source/API/API/FFMpeg/Format/Audio/Flac.html b/docs/source/API/API/FFMpeg/Format/Audio/Flac.html index 01d00ff..51d67ee 100644 --- a/docs/source/API/API/FFMpeg/Format/Audio/Flac.html +++ b/docs/source/API/API/FFMpeg/Format/Audio/Flac.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,11 +23,13 @@

    FFMpeg\Format\Audio\Flac

    -

    class Flac extends DefaultAudio

    +

    class + Flac extends DefaultAudio

    The Flac audio format

    -

    +

    +

    @@ -83,6 +86,26 @@

    Sets the kiloBitrate value.

    from DefaultAudio + + + + integer + + + getAudioChannels() +

    Gets the audio channels value.

    + + from DefaultAudio + + + + + + + setAudioChannels(integer $channels) +

    Sets the channels value.

    + + from DefaultAudio @@ -96,11 +119,22 @@ + string + + + getPasses() +

    Returns the number of passes.

    + + from DefaultAudio + + + __construct() -

    +

    +

    @@ -120,13 +154,14 @@

    Details

    -
    in DefaultAudio at line 33
    +
    in DefaultAudio at line 36
    public array() getExtraParams()

    Returns an array of extra parameters to add to ffmpeg commandline.

    -

    +

    +

    Return Value

    @@ -134,7 +169,8 @@ - +
    array() +
    @@ -144,13 +180,14 @@

    -
    in DefaultAudio at line 41
    +
    in DefaultAudio at line 44
    public string getAudioCodec()

    Returns the audio codec.

    -

    +

    +

    Return Value

    @@ -158,7 +195,8 @@ - +
    string +
    @@ -168,13 +206,14 @@

    -
    in DefaultAudio at line 54
    +
    in DefaultAudio at line 57
    public setAudioCodec(string $audioCodec)

    Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.

    -

    +

    +

    Parameters

    @@ -182,7 +221,8 @@ string $audioCodec - + + @@ -193,7 +233,8 @@ - +
    InvalidArgumentException +
    @@ -202,13 +243,14 @@

    -
    in DefaultAudio at line 71
    +
    in DefaultAudio at line 74
    public integer getAudioKiloBitrate()

    Gets the audio kiloBitrate value.

    -

    +

    +

    Return Value

    @@ -216,7 +258,8 @@ - +
    integer +
    @@ -226,13 +269,14 @@

    -
    in DefaultAudio at line 82
    +
    in DefaultAudio at line 85
    public setAudioKiloBitrate(integer $kiloBitrate)

    Sets the kiloBitrate value.

    -

    +

    +

    Parameters

    @@ -240,7 +284,8 @@ integer $kiloBitrate - + + @@ -251,7 +296,71 @@ - + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    in DefaultAudio at line 99
    + public integer + getAudioChannels() +

    +
    +

    Gets the audio channels value.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 110
    + public + setAudioChannels(integer $channels) +

    +
    +

    Sets the channels value.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    integer$channels +
    + + + +

    Exceptions

    + + + + +
    InvalidArgumentException +
    @@ -260,13 +369,14 @@

    -
    in DefaultAudio at line 96
    +
    in DefaultAudio at line 124
    public array createProgressListener(MediaTypeInterface $media, FFProbe $ffprobe, Integer $pass, Integer $total)

    Creates the progress listener.

    -

    +

    +

    Parameters

    @@ -274,12 +384,14 @@ MediaTypeInterface $media - + + FFProbe $ffprobe - + + Integer @@ -305,6 +417,32 @@ +
    +
    + +

    +
    in DefaultAudio at line 138
    + public string + getPasses() +

    +
    +

    Returns the number of passes.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    string +
    + + +
    @@ -314,8 +452,10 @@ __construct()
    -

    -

    +

    +

    +

    +

    @@ -330,7 +470,8 @@

    Returns the list of available audio codecs for this format.

    -

    +

    +

    Return Value

    @@ -338,7 +479,8 @@ - +
    array +
    diff --git a/docs/source/API/API/FFMpeg/Format/Audio/Mp3.html b/docs/source/API/API/FFMpeg/Format/Audio/Mp3.html index 3948158..4a86cfc 100644 --- a/docs/source/API/API/FFMpeg/Format/Audio/Mp3.html +++ b/docs/source/API/API/FFMpeg/Format/Audio/Mp3.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,11 +23,13 @@

    FFMpeg\Format\Audio\Mp3

    -

    class Mp3 extends DefaultAudio

    +

    class + Mp3 extends DefaultAudio

    The MP3 audio format

    -

    +

    +

    @@ -83,6 +86,26 @@

    Sets the kiloBitrate value.

    from DefaultAudio + + + + integer + + + getAudioChannels() +

    Gets the audio channels value.

    + + from DefaultAudio + + + + + + + setAudioChannels(integer $channels) +

    Sets the channels value.

    + + from DefaultAudio @@ -96,11 +119,22 @@ + string + + + getPasses() +

    Returns the number of passes.

    + + from DefaultAudio + + + __construct() -

    +

    +

    @@ -120,13 +154,14 @@

    Details

    -
    in DefaultAudio at line 33
    +
    in DefaultAudio at line 36
    public array() getExtraParams()

    Returns an array of extra parameters to add to ffmpeg commandline.

    -

    +

    +

    Return Value

    @@ -134,7 +169,8 @@ - +
    array() +
    @@ -144,13 +180,14 @@

    -
    in DefaultAudio at line 41
    +
    in DefaultAudio at line 44
    public string getAudioCodec()

    Returns the audio codec.

    -

    +

    +

    Return Value

    @@ -158,7 +195,8 @@ - +
    string +
    @@ -168,13 +206,14 @@

    -
    in DefaultAudio at line 54
    +
    in DefaultAudio at line 57
    public setAudioCodec(string $audioCodec)

    Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.

    -

    +

    +

    Parameters

    @@ -182,7 +221,8 @@ string $audioCodec - + + @@ -193,7 +233,8 @@ - +
    InvalidArgumentException +
    @@ -202,13 +243,14 @@

    -
    in DefaultAudio at line 71
    +
    in DefaultAudio at line 74
    public integer getAudioKiloBitrate()

    Gets the audio kiloBitrate value.

    -

    +

    +

    Return Value

    @@ -216,7 +258,8 @@ - +
    integer +
    @@ -226,13 +269,14 @@

    -
    in DefaultAudio at line 82
    +
    in DefaultAudio at line 85
    public setAudioKiloBitrate(integer $kiloBitrate)

    Sets the kiloBitrate value.

    -

    +

    +

    Parameters

    @@ -240,7 +284,8 @@ integer $kiloBitrate - + + @@ -251,7 +296,71 @@ - + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    in DefaultAudio at line 99
    + public integer + getAudioChannels() +

    +
    +

    Gets the audio channels value.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 110
    + public + setAudioChannels(integer $channels) +

    +
    +

    Sets the channels value.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    integer$channels +
    + + + +

    Exceptions

    + + + + +
    InvalidArgumentException +
    @@ -260,13 +369,14 @@

    -
    in DefaultAudio at line 96
    +
    in DefaultAudio at line 124
    public array createProgressListener(MediaTypeInterface $media, FFProbe $ffprobe, Integer $pass, Integer $total)

    Creates the progress listener.

    -

    +

    +

    Parameters

    @@ -274,12 +384,14 @@ MediaTypeInterface $media - + + FFProbe $ffprobe - + + Integer @@ -305,6 +417,32 @@ +
    +
    + +

    +
    in DefaultAudio at line 138
    + public string + getPasses() +

    +
    +

    Returns the number of passes.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    string +
    + + +
    @@ -314,8 +452,10 @@ __construct()
    -

    -

    +

    +

    +

    +

    @@ -330,7 +470,8 @@

    Returns the list of available audio codecs for this format.

    -

    +

    +

    Return Value

    @@ -338,7 +479,8 @@ - +
    array +
    diff --git a/docs/source/API/API/FFMpeg/Format/Audio/Vorbis.html b/docs/source/API/API/FFMpeg/Format/Audio/Vorbis.html new file mode 100644 index 0000000..d9964ae --- /dev/null +++ b/docs/source/API/API/FFMpeg/Format/Audio/Vorbis.html @@ -0,0 +1,498 @@ + + + + + + FFMpeg\Format\Audio\Vorbis | PHP-FFMpeg API + + + +
    + + +
    PHP-FFMpeg API
    + +
    Class
    +

    FFMpeg\Format\Audio\Vorbis

    +
    +
    +

    class + Vorbis extends DefaultAudio

    + +
    +

    The Vorbis audio format

    +

    +

    +
    + + + +

    Methods

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + array() + + getExtraParams() +

    Returns an array of extra parameters to add to ffmpeg commandline.

    +
    + string + + getAudioCodec() +

    Returns the audio codec.

    +     		from DefaultAudio
    + + + setAudioCodec(string $audioCodec) +

    Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.

    +     		from DefaultAudio
    + integer + + getAudioKiloBitrate() +

    Gets the audio kiloBitrate value.

    +     		from DefaultAudio
    + + + setAudioKiloBitrate(integer $kiloBitrate) +

    Sets the kiloBitrate value.

    +     		from DefaultAudio
    + integer + + getAudioChannels() +

    Gets the audio channels value.

    +     		from DefaultAudio
    + + + setAudioChannels(integer $channels) +

    Sets the channels value.

    +     		from DefaultAudio
    + array + + createProgressListener(MediaTypeInterface $media, FFProbe $ffprobe, Integer $pass, Integer $total) +

    Creates the progress listener.

    +     		from DefaultAudio
    + string + + getPasses() +

    Returns the number of passes.

    +     		from DefaultAudio
    + + + __construct() +

    +

    +
    + array + + getAvailableAudioCodecs() +

    Returns the list of available audio codecs for this format.

    +
    + + +

    Details

    + +

    +
    at line 27
    + public array() + getExtraParams() +

    +
    +

    Returns an array of extra parameters to add to ffmpeg commandline.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    array() +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 44
    + public string + getAudioCodec() +

    +
    +

    Returns the audio codec.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    string +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 57
    + public + setAudioCodec(string $audioCodec) +

    +
    +

    Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    string$audioCodec +
    + + + +

    Exceptions

    + + + + + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    in DefaultAudio at line 74
    + public integer + getAudioKiloBitrate() +

    +
    +

    Gets the audio kiloBitrate value.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 85
    + public + setAudioKiloBitrate(integer $kiloBitrate) +

    +
    +

    Sets the kiloBitrate value.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    integer$kiloBitrate +
    + + + +

    Exceptions

    + + + + + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    in DefaultAudio at line 99
    + public integer + getAudioChannels() +

    +
    +

    Gets the audio channels value.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 110
    + public + setAudioChannels(integer $channels) +

    +
    +

    Sets the channels value.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    integer$channels +
    + + + +

    Exceptions

    + + + + + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    in DefaultAudio at line 124
    + public array + createProgressListener(MediaTypeInterface $media, FFProbe $ffprobe, Integer $pass, Integer $total) +

    +
    +

    Creates the progress listener.

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + +
    MediaTypeInterface$media +
    FFProbe$ffprobe +
    Integer$passThe current pas snumber
    Integer$totalThe total pass number
    + + +

    Return Value

    + + + + + + +
    arrayAn array of listeners
    + + + +
    +
    + +

    +
    in DefaultAudio at line 138
    + public string + getPasses() +

    +
    +

    Returns the number of passes.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    string +
    + + + +
    +
    + +

    +
    at line 19
    + public + __construct() +

    +
    +

    +

    +

    +

    +
    + + + +
    +
    + +

    +
    at line 35
    + public array + getAvailableAudioCodecs() +

    +
    +

    Returns the list of available audio codecs for this format.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    array +
    + + + +
    +
    + + +
    + + + diff --git a/docs/source/API/API/FFMpeg/Format/Audio/Wav.html b/docs/source/API/API/FFMpeg/Format/Audio/Wav.html new file mode 100644 index 0000000..01bcef3 --- /dev/null +++ b/docs/source/API/API/FFMpeg/Format/Audio/Wav.html @@ -0,0 +1,498 @@ + + + + + + FFMpeg\Format\Audio\Wav | PHP-FFMpeg API + + + +
    + + +
    PHP-FFMpeg API
    + +
    Class
    +

    FFMpeg\Format\Audio\Wav

    +
    +
    +

    class + Wav extends DefaultAudio

    + +
    +

    The WAV audio format

    +

    +

    +
    + + + +

    Methods

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + array() + + getExtraParams() +

    Returns an array of extra parameters to add to ffmpeg commandline.

    +     		from DefaultAudio
    + string + + getAudioCodec() +

    Returns the audio codec.

    +     		from DefaultAudio
    + + + setAudioCodec(string $audioCodec) +

    Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.

    +     		from DefaultAudio
    + integer + + getAudioKiloBitrate() +

    Gets the audio kiloBitrate value.

    +     		from DefaultAudio
    + + + setAudioKiloBitrate(integer $kiloBitrate) +

    Sets the kiloBitrate value.

    +     		from DefaultAudio
    + integer + + getAudioChannels() +

    Gets the audio channels value.

    +     		from DefaultAudio
    + + + setAudioChannels(integer $channels) +

    Sets the channels value.

    +     		from DefaultAudio
    + array + + createProgressListener(MediaTypeInterface $media, FFProbe $ffprobe, Integer $pass, Integer $total) +

    Creates the progress listener.

    +     		from DefaultAudio
    + string + + getPasses() +

    Returns the number of passes.

    +     		from DefaultAudio
    + + + __construct() +

    +

    +
    + array + + getAvailableAudioCodecs() +

    Returns the list of available audio codecs for this format.

    +
    + + +

    Details

    + +

    +
    in DefaultAudio at line 36
    + public array() + getExtraParams() +

    +
    +

    Returns an array of extra parameters to add to ffmpeg commandline.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    array() +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 44
    + public string + getAudioCodec() +

    +
    +

    Returns the audio codec.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    string +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 57
    + public + setAudioCodec(string $audioCodec) +

    +
    +

    Sets the audio codec, Should be in the available ones, otherwise an exception is thrown.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    string$audioCodec +
    + + + +

    Exceptions

    + + + + + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    in DefaultAudio at line 74
    + public integer + getAudioKiloBitrate() +

    +
    +

    Gets the audio kiloBitrate value.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 85
    + public + setAudioKiloBitrate(integer $kiloBitrate) +

    +
    +

    Sets the kiloBitrate value.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    integer$kiloBitrate +
    + + + +

    Exceptions

    + + + + + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    in DefaultAudio at line 99
    + public integer + getAudioChannels() +

    +
    +

    Gets the audio channels value.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    in DefaultAudio at line 110
    + public + setAudioChannels(integer $channels) +

    +
    +

    Sets the channels value.

    +

    +

    +
    +

    Parameters

    + + + + + + + +
    integer$channels +
    + + + +

    Exceptions

    + + + + + + +
    InvalidArgumentException +
    + + +
    +
    + +

    +
    in DefaultAudio at line 124
    + public array + createProgressListener(MediaTypeInterface $media, FFProbe $ffprobe, Integer $pass, Integer $total) +

    +
    +

    Creates the progress listener.

    +

    +

    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + +
    MediaTypeInterface$media +
    FFProbe$ffprobe +
    Integer$passThe current pas snumber
    Integer$totalThe total pass number
    + + +

    Return Value

    + + + + + + +
    arrayAn array of listeners
    + + + +
    +
    + +

    +
    in DefaultAudio at line 138
    + public string + getPasses() +

    +
    +

    Returns the number of passes.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    string +
    + + + +
    +
    + +

    +
    at line 19
    + public + __construct() +

    +
    +

    +

    +

    +

    +
    + + + +
    +
    + +

    +
    at line 27
    + public array + getAvailableAudioCodecs() +

    +
    +

    Returns the list of available audio codecs for this format.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    array +
    + + + +
    +
    + + +
    + + + diff --git a/docs/source/API/API/FFMpeg/Format/AudioInterface.html b/docs/source/API/API/FFMpeg/Format/AudioInterface.html index 775d2f4..2414fd0 100644 --- a/docs/source/API/API/FFMpeg/Format/AudioInterface.html +++ b/docs/source/API/API/FFMpeg/Format/AudioInterface.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,7 +23,8 @@

    FFMpeg\Format\AudioInterface

    -

    interface AudioInterface implements +

    interface + AudioInterface implements FormatInterface

    @@ -32,6 +34,26 @@ + + + + + + + + + + @@ -43,11 +65,11 @@ @@ -76,22 +98,24 @@

    Details

    -

    -
    at line 20
    - public integer - getAudioKiloBitrate() +

    +
    in FormatInterface at line 20
    + public string + getPasses()

    -

    Gets the audio kiloBitrate value.

    -

    +

    Returns the number of passes.

    +

    +

    Return Value

    + string + + getPasses() +

    Returns the number of passes.

    +     		from FormatInterface
    + array() + + getExtraParams() +

    Returns an array of extra parameters to add to ffmpeg commandline.

    +     		from FormatInterface
    integer
    - array() + integer - getExtraParams() -

    Returns an array of extra parameters to add to ffmpeg commandline.

    + getAudioChannels() +

    Gets the audio channels value.
    - - + +
    integerstring +
    @@ -101,13 +125,14 @@

    -
    at line 27
    +
    in FormatInterface at line 27
    public array() getExtraParams()

    Returns an array of extra parameters to add to ffmpeg commandline.

    -

    +

    +

    Return Value

    @@ -115,7 +140,60 @@ - + + +
    array() +
    + + + +
    +
    + +

    +
    at line 20
    + public integer + getAudioKiloBitrate() +

    +
    +

    Gets the audio kiloBitrate value.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    integer +
    + + + +
    +
    + +

    +
    at line 27
    + public integer + getAudioChannels() +

    +
    +

    Gets the audio channels value.

    +

    +

    +
    + +

    Return Value

    + + + + +
    integer +
    @@ -131,7 +209,8 @@

    Returns the audio codec.

    -

    +

    +

    Return Value

    @@ -139,7 +218,8 @@ - +
    string +
    @@ -155,7 +235,8 @@

    Returns the list of available audio codecs for this format.

    -

    +

    +

    Return Value

    @@ -163,7 +244,8 @@ - +
    array +
    diff --git a/docs/source/API/API/FFMpeg/Format/FormatInterface.html b/docs/source/API/API/FFMpeg/Format/FormatInterface.html index ffa6380..965ca38 100644 --- a/docs/source/API/API/FFMpeg/Format/FormatInterface.html +++ b/docs/source/API/API/FFMpeg/Format/FormatInterface.html @@ -12,6 +12,7 @@
  • Classes
  • Namespaces
  • Interfaces
    • +
  • Traits
  • Index
    • @@ -22,11 +23,93 @@

    FFMpeg\Format\FormatInterface

    -

    interface FormatInterface

    +

    interface + FormatInterface

    +

    Methods

    + + + + + + + + + + + + +
    + string + + getPasses() +

    Returns the number of passes.

    +
    + array() + + getExtraParams() +

    Returns an array of extra parameters to add to ffmpeg commandline.

    +
    + + +

    Details

    + +

    +
    at line 20
    + public string + getPasses() +

    +
    +

    Returns the number of passes.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    string +
    + + + +
    +
    + +

    +
    at line 27
    + public array() + getExtraParams() +

    +
    +

    Returns an array of extra parameters to add to ffmpeg commandline.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    array() +
    + + + +
    +
    + +
    -

    interface FrameInterface implements +

    interface + FrameInterface implements FormatInterface

    +

    Methods

    + + + + + + + + + + + + +
    + string + + getPasses() +

    Returns the number of passes.

    +     		from FormatInterface
    + array() + + getExtraParams() +

    Returns an array of extra parameters to add to ffmpeg commandline.

    +     		from FormatInterface
    + + +

    Details

    + +

    +
    in FormatInterface at line 20
    + public string + getPasses() +

    +
    +

    Returns the number of passes.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    string +
    + + + +
    +
    + +

    +
    in FormatInterface at line 27
    + public array() + getExtraParams() +

    +
    +

    Returns an array of extra parameters to add to ffmpeg commandline.

    +

    +

    +
    + +

    Return Value

    + + + + + + +
    array() +
    + + + +
    +
    + +