path: root/audio/vocoder/README
diff options
Diffstat (limited to 'audio/vocoder/README')
1 files changed, 14 insertions, 0 deletions
diff --git a/audio/vocoder/README b/audio/vocoder/README
new file mode 100644
index 0000000000..245b1d2675
--- /dev/null
+++ b/audio/vocoder/README
@@ -0,0 +1,14 @@
+vocoder (standalone JACK vocoder effect)
+A vocoder is a sound effect that can make a human voice sound
+synthetic. It is often used to speak like a robot, with a metallic and
+monotonous voice.
+This is a standalone JACK application. For a LADSPA version of the same
+effect, see vocoder-ladspa.
+This package uses POSIX filesystem capabilities to execute with
+elevated privileges (required for realtime audio processing). This
+may be considered a security/stability risk. Please read
+ for more information. To disable
+capabilities, pass SETCAP=no to the script.