From 8289562499647d50985a5c3e042e5d0576d78c71 Mon Sep 17 00:00:00 2001
From: Martin Klampfer <martin.klampfer@fairkom.eu>
Date: Tue, 6 Jul 2021 10:52:37 +0200
Subject: [PATCH] added documentation for speech detection threshold and
 original volume settings

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 9c299029f2..873760a01c 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,19 @@ You can install on a Ubuntu 18.04 64-bit server.  We provide [bbb-install.sh](ht
 
 For full technical documentation BigBlueButton -- including architecture, features, API, and GreenLight (the default front-end) -- see [https://docs.bigbluebutton.org/](https://docs.bigbluebutton.org/).
 
+Translation Feature Settings
+============================
+
+When using the translation feature, the system will periodically check if the interpreter is speaking (determined by the setting 'speech detection threshold') and then lower the volume of the original voice channel ('original volume') to make the interpreter more audible.
+
+### Speech detection threshold
+
+Speech input volume at which the system will detect that the interpreter is speaking. Change this setting from -100 (most sensitive / always on) to 0 (least sensitive / disabled). 
+
+### Original Volume
+
+The volume to which the original voice channel is attenuated to whenever an interpreter is speaking. Lower numbers mean lower volume. This is saved per-session for each channel separately.
+
 Working with a custom HTML 5 client
 ==========================================================
 
-- 
GitLab