Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-05 04:10:11 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tidy Audio API's gain properties etc. JSDoc

Browse source
This commit is contained in:
David Rowe 2019-07-23 11:26:48 +12:00
parent 39ae575ef3
commit 6b80a27258
1 changed files with 19 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -66,12 +66,16 @@ class Audio : public AudioScriptingInterface, protected ReadWriteLockable {
* @property {boolean} pushToTalkHMD - <code>true</code> if HMD push-to-talk is enabled, otherwise <code>false</code>.
* @property {boolean} pushingToTalk - <code>true</code> if the user is currently pushing-to-talk, otherwise
* <code>false</code>.
* @property {number} avatarGain - The gain (relative volume) that avatars' voices are played at. This gain is used at the server.
* @property {number} localInjectorGain - The gain (relative volume) that local injectors (local environment sounds) are played at.
* @property {number} serverInjectorGain - The gain (relative volume) that server injectors (server environment sounds) are played at. This gain is used at the server.
* @property {number} systemInjectorGain - The gain (relative volume) that system sounds are played at.
* @property {number} pushingToTalkOutputGainDesktop - The gain (relative volume) that all sounds are played at when the user is holding
* the push-to-talk key in Desktop mode.
* @property {number} avatarGain - The gain (relative volume in dB) that avatars' voices are played at. This gain is used
* at the server.
* @property {number} localInjectorGain - The gain (relative volume in dB) that local injectors (local environment sounds)
* are played at.
* @property {number} serverInjectorGain - The gain (relative volume in dB) that server injectors (server environment
* sounds) are played at. This gain is used at the server.
* @property {number} systemInjectorGain - The gain (relative volume in dB) that system sounds are played at.
* @property {number} pushingToTalkOutputGainDesktop - The gain (relative volume in dB) that all sounds are played at when
* the user is holding the push-to-talk key in desktop mode.
*
* @comment The following properties are from AudioScriptingInterface.h.
* @property {boolean} isStereoInput - <code>true</code> if the input audio is being used in stereo, otherwise
@ -295,18 +299,18 @@ public:
Q_INVOKABLE bool getRecording();
/**jsdoc
* Sets the output volume gain that will be used when the user is holding the Push to Talk key.
* Sets the output volume gain that will be used when the user is holding the push-to-talk key.
* Should be negative.
* @function Audio.setPushingToTalkOutputGainDesktop
* @param {number} gain - The output volume gain (dB) while using PTT.
* @param {number} gain - The output volume gain (dB) while using push-to-talk.
*/
Q_INVOKABLE void setPushingToTalkOutputGainDesktop(float gain);
/**jsdoc
* Gets the output volume gain that is used when the user is holding the Push to Talk key.
* Gets the output volume gain that is used when the user is holding the push-to-talk key.
* Should be negative.
* @function Audio.getPushingToTalkOutputGainDesktop
* @returns {number} gain - The output volume gain (dB) while using PTT.
* @returns {number} gain - The output volume gain (dB) while using push-to-talk.
*/
Q_INVOKABLE float getPushingToTalkOutputGainDesktop();
@ -443,7 +447,7 @@ signals:
/**jsdoc
* Triggered when the avatar gain changes.
* @function Audio.avatarGainChanged
* @param {number} gain - The new avatar gain value.
* @param {number} gain - The new avatar gain value (dB).
* @returns {Signal}
*/
void avatarGainChanged(float gain);
@ -451,7 +455,7 @@ signals:
/**jsdoc
* Triggered when the local injector gain changes.
* @function Audio.localInjectorGainChanged
* @param {number} gain - The new local injector gain value.
* @param {number} gain - The new local injector gain value (dB).
* @returns {Signal}
*/
void localInjectorGainChanged(float gain);
@ -459,7 +463,7 @@ signals:
/**jsdoc
* Triggered when the server injector gain changes.
* @function Audio.serverInjectorGainChanged
* @param {float} gain - The new server injector gain value.
* @param {number} gain - The new server injector gain value (dB).
* @returns {Signal}
*/
void serverInjectorGainChanged(float gain);
@ -467,7 +471,7 @@ signals:
/**jsdoc
* Triggered when the system injector gain changes.
* @function Audio.systemInjectorGainChanged
* @param {number} gain - The new system injector gain value.
* @param {number} gain - The new system injector gain value (dB).
* @returns {Signal}
*/
void systemInjectorGainChanged(float gain);
@ -475,7 +479,7 @@ signals:
/**jsdoc
* Triggered when the push to talk gain changes.
* @function Audio.pushingToTalkOutputGainDesktopChanged
* @param {number} gain - The new output gain value.
* @param {number} gain - The new output gain value (dB).
* @returns {Signal}
*/
void pushingToTalkOutputGainDesktopChanged(float gain);