From a3cc6ba3ce98c79f6b61cd6bfd338a8a3a541a0f Mon Sep 17 00:00:00 2001
From: jb-alvarado <jb@pixelcrusher.de>
Date: Thu, 4 Feb 2021 12:57:20 +0100
Subject: [PATCH] add user define configs

---
 ffplayout/config/README.md           | 15 +++++++++++++++
 ffplayout/config/argparse_volume.yml |  3 +++
 2 files changed, 18 insertions(+)
 create mode 100644 ffplayout/config/README.md
 create mode 100644 ffplayout/config/argparse_volume.yml

diff --git a/ffplayout/config/README.md b/ffplayout/config/README.md
new file mode 100644
index 00000000..a78f5971
--- /dev/null
+++ b/ffplayout/config/README.md
@@ -0,0 +1,15 @@
+# Custom Configuration
+
+Extend your arguments for using them in your custom extensions.
+
+The file name must have the **argparse_** prefix. The content should look like:
+
+```YAML
+short: -v
+long: --volume
+help: set audio volume
+```
+
+At least **short** or **long** have to exist, all other parameters are optional. You can also extend the config, with keys which are exist in **ArgumentParser.add_argument()**.
+
+**Every argument must have its own yaml file!**
diff --git a/ffplayout/config/argparse_volume.yml b/ffplayout/config/argparse_volume.yml
new file mode 100644
index 00000000..a015200e
--- /dev/null
+++ b/ffplayout/config/argparse_volume.yml
@@ -0,0 +1,3 @@
+short: -v
+long: --volume
+help: set audio volume