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

Text improvements and typos

Browse source
This commit is contained in:
David Rowe 2019-03-30 10:09:48 +13:00
parent da45b4db38
commit dff013128e
2 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -70,8 +70,8 @@ class Audio : public AudioScriptingInterface, protected ReadWriteLockable {
* @comment The following properties are from AudioScriptingInterface.h. * @comment The following properties are from AudioScriptingInterface.h.
* @property {boolean} isStereoInput - <code>true</code> if the input audio is being used in stereo, otherwise * @property {boolean} isStereoInput - <code>true</code> if the input audio is being used in stereo, otherwise
* <code>false</code>. Some devices do not support stereo, in which case the value is always <code>false</code>. * <code>false</code>. Some devices do not support stereo, in which case the value is always <code>false</code>.
* @property {boolean} isSoloing - <code>true</code> if audio soloing, i.e., playing audio from only specific avatars. * @property {boolean} isSoloing - <code>true</code> if currently audio soloing, i.e., playing audio from only specific
* <em>Read-only.</em> * avatars. <em>Read-only.</em>
* @property {Uuid[]} soloList - The list of currently soloed avatar IDs. Empty list if not currently audio soloing. * @property {Uuid[]} soloList - The list of currently soloed avatar IDs. Empty list if not currently audio soloing.
* <em>Read-only.</em> * <em>Read-only.</em>
*/ */
@ -187,14 +187,14 @@ public:
Q_INVOKABLE void setReverbOptions(const AudioEffectOptions* options); Q_INVOKABLE void setReverbOptions(const AudioEffectOptions* options);
/**jsdoc /**jsdoc
* Sets the volume (gain) that avatar's voices are played at. This gain is used at the server. * Sets the gain (relative volume) that avatars' voices are played at. This gain is used at the server.
* @function Audio.setAvatarGain * @function Audio.setAvatarGain
* @param {number} Avatar gain (dB) at the server. * @param {number} Avatar gain (dB) at the server.
*/ */
Q_INVOKABLE void setAvatarGain(float gain); Q_INVOKABLE void setAvatarGain(float gain);
/**jsdoc /**jsdoc
* Gets the volume (gain) that avatar's voices are played at. This gain is used at the server. * Gets the gain (relative volume) that avatars' voices are played at. This gain is used at the server.
* @function Audio.getAvatarGain * @function Audio.getAvatarGain
* @returns {number} Avatar gain (dB) at the server. * @returns {number} Avatar gain (dB) at the server.
* @example <caption>Report current audio gain settings.</caption> * @example <caption>Report current audio gain settings.</caption>
@ -207,42 +207,42 @@ public:
Q_INVOKABLE float getAvatarGain(); Q_INVOKABLE float getAvatarGain();
/**jsdoc /**jsdoc
* Sets the volume (gain) that the environment is played at, for sounds from the server. * Sets the gain (relative volume) that the environment is played at, for sounds from the server.
* @function Audio.setInjectorGain * @function Audio.setInjectorGain
* @param {number} Injector gain (dB) at the server. * @param {number} Injector gain (dB) at the server.
*/ */
Q_INVOKABLE void setInjectorGain(float gain); Q_INVOKABLE void setInjectorGain(float gain);
/**jsdoc /**jsdoc
* Gets the volume (gain) that the environment is played at, for sounds from the server. * Gets the gain (relative volume) that the environment is played at, for sounds from the server.
* @function Audio.getInjectorGain * @function Audio.getInjectorGain
* @returns {number} Injector gain (dB) at the server. * @returns {number} Injector gain (dB) at the server.
*/ */
Q_INVOKABLE float getInjectorGain(); Q_INVOKABLE float getInjectorGain();
/**jsdoc /**jsdoc
* Sets the volume (gain) that the environment is played at, for sounds from the client. * Sets the gain (relative volume) that the environment is played at, for sounds from the client.
* @function Audio.setLocalInjectorGain * @function Audio.setLocalInjectorGain
* @param {number} Local injector gain (dB) in the client. * @param {number} Local injector gain (dB) in the client.
*/ */
Q_INVOKABLE void setLocalInjectorGain(float gain); Q_INVOKABLE void setLocalInjectorGain(float gain);
/**jsdoc /**jsdoc
* Gets the volume (gain) that the environment is played at, for sounds from the client. * Gets the gain (relative volume) that the environment is played at, for sounds from the client.
* @function Audio.getLocalInjectorGain * @function Audio.getLocalInjectorGain
* @returns {number} Local injector gain (dB) in the client. * @returns {number} Local injector gain (dB) in the client.
*/ */
Q_INVOKABLE float getLocalInjectorGain(); Q_INVOKABLE float getLocalInjectorGain();
/**jsdoc /**jsdoc
* Sets the volume (gain) that system sounds are played at. * Sets the gain (relative volume) that system sounds are played at.
* @function Audio.setSystemInjectorGain * @function Audio.setSystemInjectorGain
* @param {number} System injector gain (dB) in the client. * @param {number} System injector gain (dB) in the client.
*/ */
Q_INVOKABLE void setSystemInjectorGain(float gain); Q_INVOKABLE void setSystemInjectorGain(float gain);
/**jsdoc /**jsdoc
* Gets the volume (gain) that system sounds are played at. * Gets the gain (relative volume) that system sounds are played at.
* @function Audio.getSystemInjectorGain * @function Audio.getSystemInjectorGain
* @returns {number} System injector gain (dB) in the client. * @returns {number} System injector gain (dB) in the client.
*/ */
@ -405,7 +405,7 @@ signals:
void contextChanged(const QString& context); void contextChanged(const QString& context);
/**jsdoc /**jsdoc
* Triggered when push-to-talk changes. * Triggered when pushing-to-talk changes.
* @function Audio.pushingToTalkChanged * @function Audio.pushingToTalkChanged
* @param {boolean} talking - <code>true</code> if started pushing to talk, <code>false</code> if stopped pushing to talk. * @param {boolean} talking - <code>true</code> if started pushing to talk, <code>false</code> if stopped pushing to talk.
* @returns {Signal} * @returns {Signal}

14
libraries/script-engine/src/AudioScriptingInterface.h
View file

@ -41,7 +41,7 @@ public:
} }
/**jsdoc /**jsdoc
* Adds avatar to the audio solo list. If the audio solo list is non-empty, only audio from the avatars in the list is * Adds avatars to the audio solo list. If the audio solo list is non-empty, only audio from the avatars in the list is
* played. * played.
* @function Audio.addToSoloList * @function Audio.addToSoloList
* @param {Uuid[]} ids - Avatar IDs to add to the solo list. * @param {Uuid[]} ids - Avatar IDs to add to the solo list.
@ -96,7 +96,7 @@ public:
} }
/**jsdoc /**jsdoc
* Gets whether echoing microphone audio back to your from the server is enabled. When enabled, microphone audio is echoed * Gets whether echoing microphone audio back to you from the server is enabled. When enabled, microphone audio is echoed
* only if you're unmuted or are pushing-to-talk. * only if you're unmuted or are pushing-to-talk.
* @function Audio.getServerEcho * @function Audio.getServerEcho
* @returns {boolean} <code>true</code> if echoing microphone audio back to you from the server is enabled, * @returns {boolean} <code>true</code> if echoing microphone audio back to you from the server is enabled,
@ -105,7 +105,7 @@ public:
Q_INVOKABLE bool getServerEcho(); Q_INVOKABLE bool getServerEcho();
/**jsdoc /**jsdoc
* Sets whether echoiing microphone audio back to your from the server is enabled. When enabled, microphone audio is echoed * Sets whether echoing microphone audio back to you from the server is enabled. When enabled, microphone audio is echoed
* only if you're unmuted or are pushing-to-talk. * only if you're unmuted or are pushing-to-talk.
* @function Audio.setServerEcho * @function Audio.setServerEcho
* @parm {boolean} serverEcho - <code>true</code> to enable echoing microphone back to you from the server, * @parm {boolean} serverEcho - <code>true</code> to enable echoing microphone back to you from the server,
@ -121,8 +121,8 @@ public:
Q_INVOKABLE void toggleServerEcho(); Q_INVOKABLE void toggleServerEcho();
/**jsdoc /**jsdoc
* Gets whether echoing microphone audio back to your by the client is enabled. When enabled, microphone audio is even if * Gets whether echoing microphone audio back to you by the client is enabled. When enabled, microphone audio is echoed
* you're muted or not pushing-to-talk. * even if you're muted or not pushing-to-talk.
* @function Audio.getLocalEcho * @function Audio.getLocalEcho
* @returns {boolean} <code>true</code> if echoing microphone audio back to you from the client is enabled, * @returns {boolean} <code>true</code> if echoing microphone audio back to you from the client is enabled,
* <code>false</code> if it isn't. * <code>false</code> if it isn't.
@ -130,8 +130,8 @@ public:
Q_INVOKABLE bool getLocalEcho(); Q_INVOKABLE bool getLocalEcho();
/**jsdoc /**jsdoc
* Sets whether echoing microphone audio back to your by the client is enabled. When enabled, microphone audio is even if * Sets whether echoing microphone audio back to you by the client is enabled. When enabled, microphone audio is echoed
* you're muted or not pushing-to-talk. * even if you're muted or not pushing-to-talk.
* @function Audio.setLocalEcho * @function Audio.setLocalEcho
* @parm {boolean} localEcho - <code>true</code> to enable echoing microphone audio back to you from the client, * @parm {boolean} localEcho - <code>true</code> to enable echoing microphone audio back to you from the client,
* <code>false</code> to disable. * <code>false</code> to disable.