diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/module-parameters.txt | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/module-parameters.txt b/doc/module-parameters.txt new file mode 100644 index 0000000..893e2ca --- /dev/null +++ b/doc/module-parameters.txt @@ -0,0 +1,44 @@ + === Parameters for Zaptel modules === + +(Note: this list is woefully incomplete, but is a starting point and +will be improved as time permits.) + + --- VPMADT032 Parameters --- + +The wctdm24xxp and wcte12xp drivers support cards which can have an +optional VPMADT032 hardware echo canceler module. If that module is +present, the following module parameters are available for these +drivers: + +vpmsupport - 0 or 1, defaults to 1 + + Enables or disables use of the VPM. + +vpmdtmfsupport - 0 or 1, defaults to 0 + + Enables or disables DTMF tone detection on the VPM + (currently defaults to 'disabled' due to performance issues + when this functionality is enabled). + +vpmnlptype - 0 through 4, defaults to 1 + + Selects the type of non-linear processor that should be + applied when echo is detected and removed by the VPM. There + are five choices: + + 0 - None (not recommended) + 1 - Mute (mutes the echo) + 2 - Random Noise (replaces the echo with random noise) + 3 - Hoth Noise (replaces the echo with Hoth noise) + 4 - Suppress (suppresses the echo to a specified level) + +vpmnlpthresh - 0 through 40, in decibels (dB), defaults to 24 + + Relative signal level of echo to transmitted audio at which + NLP will be used to remove echo. + +vpmnlpmaxsupp - 0 through 90, in decibels (dB), defaults to 0 + + When vpmnlptype is 'Suppress', this value indicates the + relative energy level decrease that should be applied to the + echo signal). |