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

Add JSDoc comments

Browse source
This commit is contained in:
Clement 2018-11-06 11:59:15 -08:00
parent 37c69ebe62
commit 4e802b0f3f
2 changed files with 23 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -50,6 +50,8 @@ class Audio : public AudioScriptingInterface, protected ReadWriteLockable {
* <em>Read-only.</em> * <em>Read-only.</em>
* @property {object} devices <em>Read-only.</em> <strong>Deprecated:</strong> This property is deprecated and will be * @property {object} devices <em>Read-only.</em> <strong>Deprecated:</strong> This property is deprecated and will be
* removed. * removed.
* @property {boolean} isSoloing <em>Read-only.</em> <code>true</code> if any nodes are soloed.
* @property {QVector<QUuid>} soloList <em>Read-only.</em> Get the list of currently soloed node UUIDs.
*/ */
Q_PROPERTY(bool muted READ isMuted WRITE setMuted NOTIFY mutedChanged) Q_PROPERTY(bool muted READ isMuted WRITE setMuted NOTIFY mutedChanged)

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

@ -32,25 +32,43 @@ public:
virtual ~AudioScriptingInterface() = default; virtual ~AudioScriptingInterface() = default;
void setLocalAudioInterface(AbstractAudioInterface* audioInterface); void setLocalAudioInterface(AbstractAudioInterface* audioInterface);
protected:
AudioScriptingInterface() = default;
bool isSoloing() const { bool isSoloing() const {
return _localAudioInterface->getAudioSolo().isSoloing(); return _localAudioInterface->getAudioSolo().isSoloing();
} }
QVector<QUuid> getSoloList() const { QVector<QUuid> getSoloList() const {
return _localAudioInterface->getAudioSolo().getUUIDs(); return _localAudioInterface->getAudioSolo().getUUIDs();
} }
/**jsdoc
* Add nodes to the audio solo list
* @function Audio.addToSoloList
* @param {QVector<QUuid>} uuidList - List of node UUIDs to add to the solo list.
*/
Q_INVOKABLE void addToSoloList(QVector<QUuid> uuidList) { Q_INVOKABLE void addToSoloList(QVector<QUuid> uuidList) {
_localAudioInterface->getAudioSolo().addUUIDs(uuidList); _localAudioInterface->getAudioSolo().addUUIDs(uuidList);
} }
/**jsdoc
* Remove nodes from the audio solo list
* @function Audio.removeFromSoloList
* @param {QVector<QUuid>} uuidList - List of node UUIDs to remove from the solo list.
*/
Q_INVOKABLE void removeFromSoloList(QVector<QUuid> uuidList) { Q_INVOKABLE void removeFromSoloList(QVector<QUuid> uuidList) {
_localAudioInterface->getAudioSolo().removeUUIDs(uuidList); _localAudioInterface->getAudioSolo().removeUUIDs(uuidList);
} }
/**jsdoc
* Reset the list of soloed nodes.
* @function Audio.resetSoloList
*/
Q_INVOKABLE void resetSoloList() { Q_INVOKABLE void resetSoloList() {
_localAudioInterface->getAudioSolo().reset(); _localAudioInterface->getAudioSolo().reset();
} }
protected:
AudioScriptingInterface() = default;
// these methods are protected to stop C++ callers from calling, but invokable from script // these methods are protected to stop C++ callers from calling, but invokable from script
/**jsdoc /**jsdoc