From 2ce9648d36d161dda1650c4a1863ba849fa825f9 Mon Sep 17 00:00:00 2001
From: David Trattnig <david.trattnig@o94.at>
Date: Tue, 23 Feb 2021 20:41:28 +0100
Subject: [PATCH] Added comments. #1

---
 config/sample-development.engine-core.ini | 8 ++++----
 config/sample-docker.engine-core.ini      | 8 ++++----
 config/sample-production.engine-core.ini  | 8 ++++----
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/config/sample-development.engine-core.ini b/config/sample-development.engine-core.ini
index 72740c0..812c976 100644
--- a/config/sample-development.engine-core.ini
+++ b/config/sample-development.engine-core.ini
@@ -53,13 +53,13 @@ output_device_2=""
 output_device_3=""
 output_device_4=""
 
-# If you are using ALSA, you might need to tweak these values if you're hearing jitter, cracklings or other artifacts
-
-# Set to 0 to use the ALSA default. If using hardware directly (hw:0) start with 8192. Higher Valus gives heigher latency and lower CPU usage.
+# ADVANCED ALSA SETTINGS
+# Defaults are recommended; you might need to tweak these values if you're hearing jitter, cracklings or other artifacts
+# Set to 0 to use the ALSA default. If using hardware directly (hw:0) start with 8192. Higher values give higher latency and lower CPU usage.
 alsa_buffer="0"
 # Only used for buffered ALSA I/O, and affects latency. Probably not wanted for live audio. Defaults to "1"
 alsa_buffer_length="0"
-# # Set to 0 to use the ALSA default. Defaults to "0"
+# Set to 0 to use the ALSA default. Defaults to "0"
 alsa_periods="0"
 # Frame Size ("frame.audio.size"); Unclear if that's still required as it's not documented in Liquidsoap anymore.
 frame_size=""
diff --git a/config/sample-docker.engine-core.ini b/config/sample-docker.engine-core.ini
index 24b9fe7..a651aa4 100644
--- a/config/sample-docker.engine-core.ini
+++ b/config/sample-docker.engine-core.ini
@@ -53,13 +53,13 @@ output_device_2=""
 output_device_3=""
 output_device_4=""
 
-# If you are using ALSA, you might need to tweak these values if you're hearing jitter, cracklings or other artifacts
-
-# Set to 0 to use the ALSA default. If using hardware directly (hw:0) start with 8192. Higher Valus gives heigher latency and lower CPU usage.
+# ADVANCED ALSA SETTINGS
+# Defaults are recommended; you might need to tweak these values if you're hearing jitter, cracklings or other artifacts
+# Set to 0 to use the ALSA default. If using hardware directly (hw:0) start with 8192. Higher values give higher latency and lower CPU usage.
 alsa_buffer="0"
 # Only used for buffered ALSA I/O, and affects latency. Probably not wanted for live audio. Defaults to "1"
 alsa_buffer_length="0"
-# # Set to 0 to use the ALSA default. Defaults to "0"
+# Set to 0 to use the ALSA default. Defaults to "0"
 alsa_periods="0"
 # Frame Size ("frame.audio.size"); Unclear if that's still required as it's not documented in Liquidsoap anymore.
 frame_size=""
diff --git a/config/sample-production.engine-core.ini b/config/sample-production.engine-core.ini
index 72740c0..812c976 100644
--- a/config/sample-production.engine-core.ini
+++ b/config/sample-production.engine-core.ini
@@ -53,13 +53,13 @@ output_device_2=""
 output_device_3=""
 output_device_4=""
 
-# If you are using ALSA, you might need to tweak these values if you're hearing jitter, cracklings or other artifacts
-
-# Set to 0 to use the ALSA default. If using hardware directly (hw:0) start with 8192. Higher Valus gives heigher latency and lower CPU usage.
+# ADVANCED ALSA SETTINGS
+# Defaults are recommended; you might need to tweak these values if you're hearing jitter, cracklings or other artifacts
+# Set to 0 to use the ALSA default. If using hardware directly (hw:0) start with 8192. Higher values give higher latency and lower CPU usage.
 alsa_buffer="0"
 # Only used for buffered ALSA I/O, and affects latency. Probably not wanted for live audio. Defaults to "1"
 alsa_buffer_length="0"
-# # Set to 0 to use the ALSA default. Defaults to "0"
+# Set to 0 to use the ALSA default. Defaults to "0"
 alsa_periods="0"
 # Frame Size ("frame.audio.size"); Unclear if that's still required as it's not documented in Liquidsoap anymore.
 frame_size=""
-- 
GitLab