Mirrors/overte-Armored-Dragon
3
0
Fork 0
mirror of https://github.com/Armored-Dragon/overte.git synced 2025-03-11 16:13:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add missing JSDocs.

Browse source
This commit is contained in:
Kalila L 2021-02-24 00:58:50 -05:00
parent 0a6e220c74
commit 83c8b71fa5
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
interface/src/scripting/Audio.h
View file

@ -50,6 +50,11 @@ class Audio : public AudioScriptingInterface, protected ReadWriteLockable {
* @property {boolean} noiseReduction - <code>true</code> if noise reduction is enabled, otherwise <code>false</code>. When
* enabled, the input audio signal is blocked (fully attenuated) when it falls below an adaptive threshold set just
* above the noise floor.
* @property {boolean} noiseReductionAutomatic - <code>true</code> if audio input noise reduction automatic mode is enabled,
* <code>false</code> if in manual mode. Manual mode will allow you to use <code>Audio.noiseReductionAutomatic</code>
* to set a manual sensitivity for the noise gate.
* @property {number} noiseReductionThreshold - Sets the noise gate threshold before your mic audio is transmitted.
* (Applies only if <code>Audio.noiseReductionAutomatic</code> is <code>false</code>.)
* @property {number} inputVolume - Adjusts the volume of the input audio, range <code>0.0</code> &ndash; <code>1.0</code>.
* If set to a value, the resulting value depends on the input device: for example, the volume can't be changed on some
* devices, and others might only support values of <code>0.0</code> and <code>1.0</code>.