From ebc2097ebeef7f268e86d5b23a1f0774a69bd4dd Mon Sep 17 00:00:00 2001 From: iLLiCiTiT Date: Mon, 26 Apr 2021 14:28:01 +0200 Subject: [PATCH] brief explanation of output definitions --- website/docs/admin_settings_project.md | 33 ++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/website/docs/admin_settings_project.md b/website/docs/admin_settings_project.md index bd30b7fa6c..a3dbea9676 100644 --- a/website/docs/admin_settings_project.md +++ b/website/docs/admin_settings_project.md @@ -36,3 +36,36 @@ All context filters are lists which may contain strings or Regular expressions ( Filters are optional and may not be set. In case when multiple profiles match current context, profile with filters has higher priority that profile without filters. ::: +![global_extract_review_profiles](assets/settings/global_extract_review_profiles.png) + +**Output Definitions** + + +Profile may have multiple outputs from one input. Each output must have defined unique name and output extension (use extension without dot e.g. **mp4**). All other settings of output definition are optional. + +![global_extract_review_output_defs](assets/settings/global_extract_review_output_defs.png) +- **Tags** + Define what will happen to output. + +- **FFmpeg arguments** + These arguments are appended to ffmpeg arguments auto generated by publish plugin. Some of arguments are handled automatically like rescaling or letterboxes. + - **Video filters** additional FFmpeg filters that would be defined in `-filter:v` or `-vf` command line arguments + - **Audio filters** additional FFmpeg filters that would be defined in `-filter:a` or `-af` command line arguments + - **Input arguments** input definition arguments of video or image sequence - this setting has limitations as you have to know what is input + - **Output arguments** other FFmpeg output arguments like codec definition + +- **Output width** and **Output height** + - it is possible to rescale output to specified resolution and keep aspect ratio + - both values must have value higher than 0 + +- **Letter Box** + - **Enabled** - Enable letter boxes + - **Ratio** - Ratio of letter boxes + - **Type** - **Letterbox** or **Pillarbox** + - **Fill color** - Fill color of boxes (RGBA: 0-255) + - **Line Thickness** - Line thickness on the edge of box (set to `0` to turn off) + - **Fill color** - Line color on the edge of box (RGBA: 0-255) + - **Example** + + ![gobal_extract_review_letter_box_settings](assets/settings/gobal_extract_review_letter_box_settings.png) + ![gobal_extract_review_letter_box](assets/settings/gobal_extract_review_letter_box.png)