From c642746d85077a1f76a9106af0257046ff75f97b Mon Sep 17 00:00:00 2001 From: Romain Neutron Date: Sun, 21 Apr 2013 17:52:19 +0200 Subject: [PATCH] Add timeout documentation --- docs/source/index.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index d976670..0432ae0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -82,6 +82,34 @@ Basic Usage ->extractImage(12, 'second-screenshot.jpg') ->close(); +Process Timeout +--------------- + +PHP-FFMpeg runs ffmpeg commands to processs your medias. A default timeout of +60 seconds is set, but you can override this by passing a second argument load : + +.. code-block:: php + + getTimeOut(); + +You can also set and get the timeout with the appropriate getter and setter : + +.. code-block:: php + + setTimeout(200); + + // 200 + echo $ffmpeg->getTimeOut(); + +.. note:: + + To disable timeout, set its value to 0. + Recipes -------