From dc288b4173c306f6bfc0ae4b04ba8884c4df9771 Mon Sep 17 00:00:00 2001 From: Adrien Beudin Date: Thu, 19 May 2016 10:41:29 +0200 Subject: [PATCH] [doc] update doc about video support --- docs/configuration.rst | 29 +++++++++++++++++++++++------ docs/sections.rst | 16 +++++++--------- 2 files changed, 30 insertions(+), 15 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index ff436cf..f1fdc5e 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -80,12 +80,29 @@ Prosopopée can use ffmpeg or libav and if you want you can customize the settin settings: ffmpeg: - binary: "ffmpeg" - loglevel: "error" - format: "webm" - resolution: "1280x720" - bitrate: "3900k" - preselect: "libvpx-720p" + binary: "ffmpeg", + loglevel: "error", + format: "webm", + resolution: "1280x720", + vbitrate: "3900k", + abitrate: "100k", + audio: "libvorbis", + video: "libvpx", + other: "-qmin 10 -qmax 42 -maxrate 500k -bufsize 1500k" + +The meaning of the currently supported FFMEG or LIBAV's settings is as follows : + + * `binary` the binary you will use for convert the video (ffmpeg or avconv) + * `loglevel` Set the logging level used by the library + * `format` Force input or output file format + * `resolution` Set frame size + * `vbitrate` Set video bitrate + * `abitrate` Set audio bitrate + * `audio` Set the audio codec + * `video` Set the video codec + * `other` Set different options if you need more + + Themes ~~~~~~ diff --git a/docs/sections.rst b/docs/sections.rst index 90a7879..e219b99 100644 --- a/docs/sections.rst +++ b/docs/sections.rst @@ -208,28 +208,26 @@ Exemple for pictures-group:: - type: pictures-group images: - - - name: VID_20160312_174602.mp4 + - name: video.mp4 type: video - - snapseed-06-02.jpeg - - name: snapseed-04.jpeg - text: plop2 - - snapseed-05.jpeg - - snapseed-07.jpeg + - image1.jpeg + - image2.jpeg - - - snapseed-01.jpeg + - image3.jpeg + - image4.jpeg Exemple for bordered-picture:: - type: bordered-picture image: - name: VID_20160312_174602.mp4 + name: video.mp4 type: video And for full-picture:: - type: full-picture image: - name: VID_20160312_174602.mp4 + name: video.mp4 type: video text: title: Title Text