From c6bbc4737657c10ea919dd12348032c4633c652a Mon Sep 17 00:00:00 2001 From: jb-alvarado Date: Sat, 19 Dec 2020 22:35:18 +0100 Subject: [PATCH] spelling and add docstring --- ffplayout/filter/README.md | 4 ++-- ffplayout/filter/v_drawtext.py | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/ffplayout/filter/README.md b/ffplayout/filter/README.md index df3c2bde..339603c4 100644 --- a/ffplayout/filter/README.md +++ b/ffplayout/filter/README.md @@ -1,9 +1,9 @@ # Custom Filters -Sdd your one filters here. They must have the correct file naming: +Add your one filters here. They must have the correct file naming: - for audio filter: a_[filter name].py - for video filter: v_[filter name].py -The file it self should contain only one filter in a function named `def filter(prope):` +The file itself should contain only one filter in a function named `def filter(prope, type):` Check **v_addtext.py** for example. diff --git a/ffplayout/filter/v_drawtext.py b/ffplayout/filter/v_drawtext.py index b6b01a14..fd921e82 100644 --- a/ffplayout/filter/v_drawtext.py +++ b/ffplayout/filter/v_drawtext.py @@ -5,6 +5,9 @@ from ffplayout.utils import _text def filter(probe): + """ + extract title from file name and overlay it + """ font = '' source = os.path.basename(probe.src) match = re.match(_text.regex, source)