mirror of
https://github.com/AleziaKurdis/overte.git
synced 2025-04-08 23:12:16 +02:00
Docs to JSDoc review
This commit is contained in:
David Rowe
parent
2be40d487e
commit
08dc9b133f
23 changed files with 614 additions and 664 deletions
|
|
@ -16,7 +16,8 @@
|
|||
#include "Bookmarks.h"
|
||||
|
||||
/**jsdoc
|
||||
* This API helps manage adding and deleting Avatar bookmarks
|
||||
* This API helps manage adding and deleting avatar bookmarks.
|
||||
* @namespace AvatarBookmarks
|
||||
*/
|
||||
|
||||
class AvatarBookmarks: public Bookmarks, public Dependency {
|
||||
|
|
@ -27,16 +28,12 @@ public:
|
|||
AvatarBookmarks();
|
||||
void setupMenus(Menu* menubar, MenuWrapper* menu) override;
|
||||
|
||||
/**jsdoc
|
||||
* Add the current Avatar to your Avatar Bookmarks
|
||||
* @function AvatarBookmarks.addBookMark
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarBookmarks.deleteBookMark
|
||||
*/
|
||||
|
||||
public slots:
|
||||
/**jsdoc
|
||||
* Add the current Avatar to your avatar bookmarks.
|
||||
* @function AvatarBookmarks.addBookMark
|
||||
*/
|
||||
void addBookmark();
|
||||
|
||||
protected:
|
||||
|
|
|
|||
|
|
@ -49,7 +49,6 @@ protected:
|
|||
|
||||
protected slots:
|
||||
/**jsdoc
|
||||
* Delete
|
||||
* @function AvatarBookmarks.deleteBookmark
|
||||
*/
|
||||
void deleteBookmark();
|
||||
|
|
|
|||
|
|
@ -49,21 +49,18 @@ public:
|
|||
* @function LODManager.setAutomaticLODAdjust
|
||||
* @param {boolean} value
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void setAutomaticLODAdjust(bool value) { _automaticLODAdjust = value; }
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.getAutomaticLODAdjust
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE bool getAutomaticLODAdjust() const { return _automaticLODAdjust; }
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.setDesktopLODDecreaseFPS
|
||||
* @param {float} value
|
||||
* @param {number} value
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void setDesktopLODDecreaseFPS(float value);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -77,28 +74,25 @@ public:
|
|||
* @function LODManager.getDesktopLODIncreaseFPS
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE float getDesktopLODIncreaseFPS() const;
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.setHMDLODDecreaseFPS
|
||||
* @param {number} value
|
||||
*/
|
||||
|
||||
|
||||
Q_INVOKABLE void setHMDLODDecreaseFPS(float value);
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.getHMDLODDecreaseFPS
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE float getHMDLODDecreaseFPS() const;
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.getHMDLODIncreaseFPS
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE float getHMDLODIncreaseFPS() const;
|
||||
|
||||
// User Tweakable LOD Items
|
||||
|
|
@ -106,61 +100,54 @@ public:
|
|||
* @function LODManager.getLODFeedbackText
|
||||
* @returns {string}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE QString getLODFeedbackText();
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.setOctreeSizeScale
|
||||
* @param {number} sizeScale
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void setOctreeSizeScale(float sizeScale);
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.getOctreeSizeScale
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE float getOctreeSizeScale() const { return _octreeSizeScale; }
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.setBoundaryLevelAdjust
|
||||
* @param {number} boundaryLevelAdjust
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void setBoundaryLevelAdjust(int boundaryLevelAdjust);
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.getBoundaryLevelAdjust
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE int getBoundaryLevelAdjust() const { return _boundaryLevelAdjust; }
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.getLODDecreaseFPS
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE float getLODDecreaseFPS() const;
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.getLODIncreaseFPS
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE float getLODIncreaseFPS() const;
|
||||
|
||||
/**jsdoc
|
||||
* @namespace LODManager
|
||||
* @property presentTime {number}
|
||||
* @property engineRunTime {number}
|
||||
* @property gpuTime {number}
|
||||
* @property avgRenderTime {number}
|
||||
* @property fps {number}
|
||||
* @property lodLevel {number}
|
||||
* @property lodDecreaseFPS {number}
|
||||
* @property lodIncreaseFPS {number}
|
||||
* @property {number} presentTime <em>Read-only.</em>
|
||||
* @property {number} engineRunTime <em>Read-only.</em>
|
||||
* @property {number} gpuTime <em>Read-only.</em>
|
||||
* @property {number} avgRenderTime <em>Read-only.</em>
|
||||
* @property {number} fps <em>Read-only.</em>
|
||||
* @property {number} lodLevel <em>Read-only.</em>
|
||||
* @property {number} lodDecreaseFPS <em>Read-only.</em>
|
||||
* @property {number} lodIncreaseFPS <em>Read-only.</em>
|
||||
*/
|
||||
|
||||
Q_PROPERTY(float presentTime READ getPresentTime)
|
||||
|
|
@ -195,14 +182,12 @@ signals:
|
|||
* @function LODManager.LODIncreased
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void LODIncreased();
|
||||
|
||||
/**jsdoc
|
||||
* @function LODManager.LODDecreased
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void LODDecreased();
|
||||
|
||||
private:
|
||||
|
|
|
|||
|
|
@ -28,12 +28,12 @@ class AudioScope : public QObject, public Dependency {
|
|||
/**jsdoc
|
||||
* The AudioScope API helps control the Audio Scope features in Interface
|
||||
* @namespace AudioScope
|
||||
* @property {int} scopeInput
|
||||
* @property {int} scopeOutputLeft
|
||||
* @property {int} scopeOutputRight
|
||||
* @property {int} triggerInput
|
||||
* @property {int} triggerOutputLeft
|
||||
* @property {int} triggerOutputRight
|
||||
* @property {number} scopeInput <em>Read-only.</em>
|
||||
* @property {number} scopeOutputLeft <em>Read-only.</em>
|
||||
* @property {number} scopeOutputRight <em>Read-only.</em>
|
||||
* @property {number} triggerInput <em>Read-only.</em>
|
||||
* @property {number} triggerOutputLeft <em>Read-only.</em>
|
||||
* @property {number} triggerOutputRight <em>Read-only.</em>
|
||||
*/
|
||||
|
||||
Q_PROPERTY(QVector<int> scopeInput READ getScopeInput)
|
||||
|
|
@ -55,62 +55,52 @@ public slots:
|
|||
/**jsdoc
|
||||
* @function AudioScope.toggle
|
||||
*/
|
||||
|
||||
void toggle() { setVisible(!_isEnabled); }
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.setVisible
|
||||
* @param {boolean} visible
|
||||
*/
|
||||
|
||||
void setVisible(bool visible);
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getVisible
|
||||
* @param {boolean} visible
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
bool getVisible() const { return _isEnabled; }
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.togglePause
|
||||
*/
|
||||
|
||||
void togglePause() { setPause(!_isPaused); }
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.setPause
|
||||
* @param {boolean}
|
||||
* @param {boolean} paused
|
||||
*/
|
||||
|
||||
void setPause(bool paused) { _isPaused = paused; emit pauseChanged(); }
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getPause
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
bool getPause() { return _isPaused; }
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.toggleTrigger
|
||||
*/
|
||||
|
||||
void toggleTrigger() { _autoTrigger = !_autoTrigger; }
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getAutoTrigger
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
bool getAutoTrigger() { return _autoTrigger; }
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.setAutoTrigger
|
||||
* @param {boolean} autoTrigger
|
||||
*/
|
||||
|
||||
void setAutoTrigger(bool autoTrigger) { _isTriggered = false; _autoTrigger = autoTrigger; }
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -118,109 +108,93 @@ public slots:
|
|||
* @param {number} x
|
||||
* @param {number} y
|
||||
*/
|
||||
|
||||
void setTriggerValues(int x, int y) { _triggerValues.x = x; _triggerValues.y = y; }
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.setTriggered
|
||||
* @param {boolean} triggered
|
||||
*/
|
||||
|
||||
void setTriggered(bool triggered) { _isTriggered = triggered; }
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getTriggered
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
bool getTriggered() { return _isTriggered; }
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getFramesPerSecond
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
float getFramesPerSecond();
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getFramesPerScope
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
int getFramesPerScope() { return _framesPerScope; }
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.selectAudioScopeFiveFrames
|
||||
*/
|
||||
|
||||
void selectAudioScopeFiveFrames();
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.selectAudioScopeTwentyFrames
|
||||
*/
|
||||
|
||||
void selectAudioScopeTwentyFrames();
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.selectAudioScopeFiftyFrames
|
||||
*/
|
||||
|
||||
void selectAudioScopeFiftyFrames();
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getScopeInput
|
||||
* @returns {number}
|
||||
* @returns {number[]}
|
||||
*/
|
||||
|
||||
QVector<int> getScopeInput() { return _scopeInputData; };
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getScopeOutputLeft
|
||||
* @returns {number}
|
||||
* @returns {number[]}
|
||||
*/
|
||||
|
||||
QVector<int> getScopeOutputLeft() { return _scopeOutputLeftData; };
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getScopeOutputRight
|
||||
* @returns {number}
|
||||
* @returns {number[]}
|
||||
*/
|
||||
|
||||
QVector<int> getScopeOutputRight() { return _scopeOutputRightData; };
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getTriggerInput
|
||||
* @returns {number}
|
||||
* @returns {number[]}
|
||||
*/
|
||||
|
||||
QVector<int> getTriggerInput() { return _triggerInputData; };
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getTriggerOutputLeft
|
||||
* @returns {number}
|
||||
* @returns {number[]}
|
||||
*/
|
||||
|
||||
QVector<int> getTriggerOutputLeft() { return _triggerOutputLeftData; };
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.getTriggerOutputRight
|
||||
* @returns {number}
|
||||
* @returns {number[]}
|
||||
*/
|
||||
|
||||
QVector<int> getTriggerOutputRight() { return _triggerOutputRightData; };
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.setLocalEcho
|
||||
* @parm {boolean} serverEcho
|
||||
* @parm {boolean} localEcho
|
||||
*/
|
||||
|
||||
void setLocalEcho(bool serverEcho);
|
||||
void setLocalEcho(bool localEcho);
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.setServerEcho
|
||||
* @parm {boolean} serverEcho
|
||||
*/
|
||||
|
||||
void setServerEcho(bool serverEcho);
|
||||
|
||||
signals:
|
||||
|
|
@ -229,14 +203,12 @@ signals:
|
|||
* @function AudioScope.pauseChanged
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void pauseChanged();
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioScope.triggered
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void triggered();
|
||||
|
||||
protected:
|
||||
|
|
|
|||
|
|
@ -38,75 +38,6 @@ class AvatarManager : public AvatarHashMap {
|
|||
|
||||
public:
|
||||
|
||||
// JSDOCS Copied over from AvatarHashMap (see AvatarHashMap.h for reason)
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.getAvatarIdentifiers
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.getAvatarsInRange
|
||||
* @param {Vec3} position
|
||||
* @param {float} rangeMeters
|
||||
* @returns {string[]}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.getAvatar
|
||||
* @param {string} avatarID
|
||||
* @returns {ScriptAvatarData}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.avatarAddedEvent
|
||||
* @param {string} sessionUUID
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.avatarRemovedEvent
|
||||
* @param {string} sessionUUID
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.avatarSessionChangedEvent
|
||||
* @param {string} sessionUUID
|
||||
* @param {string} oldUUID
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.isAvatarInRange
|
||||
* @param {string} position
|
||||
* @param {string} range
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.sessionUUIDChanged
|
||||
* @param {string} sessionUUID
|
||||
* @param {string} oldUUID
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.processAvatarDataPacket
|
||||
* @param {} message
|
||||
* @param {} sendingNode
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.processAvatarIdentityPacket
|
||||
* @param {} message
|
||||
* @param {} sendingNode
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.processKillAvatar
|
||||
* @param {} message
|
||||
* @param {} sendingNode
|
||||
*/
|
||||
|
||||
/// Registers the script types associated with the avatar manager.
|
||||
static void registerMetaTypes(QScriptEngine* engine);
|
||||
|
||||
|
|
@ -119,10 +50,9 @@ public:
|
|||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.getAvatar
|
||||
* @param {string} avatarID
|
||||
* @returns {}
|
||||
* @param {Uuid} avatarID
|
||||
* @returns {AvatarData}
|
||||
*/
|
||||
|
||||
// Null/Default-constructed QUuids will return MyAvatar
|
||||
Q_INVOKABLE virtual ScriptAvatarData* getAvatar(QUuid avatarID) override { return new ScriptAvatar(getAvatarBySessionID(avatarID)); }
|
||||
|
||||
|
|
@ -148,16 +78,15 @@ public:
|
|||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.getAvatarDataRate
|
||||
* @param {string} sessionID
|
||||
* @param {Uuid} sessionID
|
||||
* @param {string} [rateName=""]
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE float getAvatarDataRate(const QUuid& sessionID, const QString& rateName = QString("")) const;
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.getAvatarUpdateRate
|
||||
* @param {string} sessionID
|
||||
* @param {Uuid} sessionID
|
||||
* @param {string} [rateName=""]
|
||||
* @returns {number}
|
||||
*/
|
||||
|
|
@ -166,51 +95,47 @@ public:
|
|||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.getAvatarSimulationRate
|
||||
* @param {string} sessionID
|
||||
* @param {Uuid} sessionID
|
||||
* @param {string} [rateName=""]
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
|
||||
Q_INVOKABLE float getAvatarSimulationRate(const QUuid& sessionID, const QString& rateName = QString("")) const;
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.findRayIntersection
|
||||
* @param {PickRay} ray
|
||||
* @param {} avatarIdsToInclude
|
||||
* @param {} avatarIdsToDiscard
|
||||
* @param {Uuid[]} [avatarsToInclude=[]]
|
||||
* @param {Uuid[]} [avatarsToDiscard=[]]
|
||||
* @returns {RayToAvatarIntersectionResult}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE RayToAvatarIntersectionResult findRayIntersection(const PickRay& ray,
|
||||
const QScriptValue& avatarIdsToInclude = QScriptValue(),
|
||||
const QScriptValue& avatarIdsToDiscard = QScriptValue());
|
||||
/**jsdoc
|
||||
* @function AvatarManager.findRayIntersectionVector
|
||||
* @param {PickRay} ray
|
||||
* @param {} avatarsToInclude
|
||||
* @param {} avatarIdsToDiscard
|
||||
* @param {Uuid[]} avatarsToInclude
|
||||
* @param {Uuid[]} avatarsToDiscard
|
||||
* @returns {RayToAvatarIntersectionResult}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE RayToAvatarIntersectionResult findRayIntersectionVector(const PickRay& ray,
|
||||
const QVector<EntityItemID>& avatarsToInclude,
|
||||
const QVector<EntityItemID>& avatarsToDiscard);
|
||||
|
||||
// TODO: remove this HACK once we settle on optimal default sort coefficients
|
||||
/**jsdoc
|
||||
* @function AvatarManager.getAvatarSortCoefficient
|
||||
* @param {string} name
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
// TODO: remove this HACK once we settle on optimal default sort coefficients
|
||||
Q_INVOKABLE float getAvatarSortCoefficient(const QString& name);
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarManager.setAvatarSortCoefficient
|
||||
* @param {string} name
|
||||
* @param {string} value
|
||||
* @param {number} value
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void setAvatarSortCoefficient(const QString& name, const QScriptValue& value);
|
||||
|
||||
float getMyAvatarSendRate() const { return _myAvatarSendRate.rate(); }
|
||||
|
|
@ -221,7 +146,6 @@ public slots:
|
|||
* @function AvatarManager.updateAvatarRenderStatus
|
||||
* @param {boolean} shouldRenderAvatars
|
||||
*/
|
||||
|
||||
void updateAvatarRenderStatus(bool shouldRenderAvatars);
|
||||
|
||||
private:
|
||||
|
|
|
|||
|
|
@ -67,13 +67,11 @@ public slots:
|
|||
* @function FaceTracker.setEnabled
|
||||
* @param {boolean} enabled
|
||||
*/
|
||||
|
||||
void setEnabled(bool enabled) override;
|
||||
|
||||
/**jsdoc
|
||||
* @function FaceTracker.calibrate
|
||||
*/
|
||||
|
||||
void calibrate();
|
||||
|
||||
private slots:
|
||||
|
|
|
|||
|
|
@ -39,10 +39,10 @@ class AccountServicesScriptingInterface : public QObject {
|
|||
* The AccountServices API contains helper functions related to user connectivity
|
||||
*
|
||||
* @namespace AccountServices
|
||||
* @property {string} username
|
||||
* @property {boolean} loggedIn
|
||||
* @property {string} username <em>Read-only.</em>
|
||||
* @property {boolean} loggedIn <em>Read-only.</em>
|
||||
* @property {string} findableBy
|
||||
* @property {string} metaverseServerURL
|
||||
* @property {string} metaverseServerURL <em>Read-only.</em>
|
||||
*/
|
||||
|
||||
Q_PROPERTY(QString username READ getUsername NOTIFY myUsernameChanged)
|
||||
|
|
@ -63,33 +63,28 @@ public slots:
|
|||
* @function AccountServices.getDownloadInfo
|
||||
* @returns {DownloadInfoResult}
|
||||
*/
|
||||
|
||||
DownloadInfoResult getDownloadInfo();
|
||||
|
||||
/**jsdoc
|
||||
* @function AccountServices.updateDownloadInfo
|
||||
*/
|
||||
|
||||
void updateDownloadInfo();
|
||||
|
||||
/**jsdoc
|
||||
* @function AccountServices.isLoggedIn
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
bool isLoggedIn();
|
||||
|
||||
/**jsdoc
|
||||
* @function AccountServices.checkAndSignalForAccessToken
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
bool checkAndSignalForAccessToken();
|
||||
|
||||
/**jsdoc
|
||||
* @function AccountServices.logOut
|
||||
*/
|
||||
|
||||
void logOut();
|
||||
|
||||
private slots:
|
||||
|
|
@ -108,47 +103,41 @@ signals:
|
|||
* @function AccountServices.connected
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void connected();
|
||||
|
||||
/**jsdoc
|
||||
* @function AccountServices.disconnected
|
||||
* @params {string} reason
|
||||
* @param {string} reason
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void disconnected(const QString& reason);
|
||||
|
||||
/**jsdoc
|
||||
* @function AccountServices.myUsernameChanged
|
||||
* @params {string} username
|
||||
* @param {string} username
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void myUsernameChanged(const QString& username);
|
||||
|
||||
/**jsdoc
|
||||
* @function AccountServices.downloadInfoChanged
|
||||
* @params {} info
|
||||
* @param {} info
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void downloadInfoChanged(DownloadInfoResult info);
|
||||
|
||||
/**jsdoc
|
||||
* @function AccountServices.findableByChanged
|
||||
* @params {string} discoverabilityMode
|
||||
* @param {string} discoverabilityMode
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void findableByChanged(const QString& discoverabilityMode);
|
||||
|
||||
/**jsdoc
|
||||
* @function AccountServices.loggedInChanged
|
||||
* @params {boolean} loggedIn
|
||||
* @param {boolean} loggedIn
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void loggedInChanged(bool loggedIn);
|
||||
|
||||
private:
|
||||
|
|
|
|||
|
|
@ -31,10 +31,10 @@ class Audio : public AudioScriptingInterface, protected ReadWriteLockable {
|
|||
* @namespace Audio
|
||||
* @property {boolean} muted
|
||||
* @property {boolean} noiseReduction
|
||||
* @property {boolean} inputVolume
|
||||
* @property {boolean} inputLevel
|
||||
* @property {string} context
|
||||
* @property {} devices
|
||||
* @property {number} inputVolume
|
||||
* @property {number} inputLevel <em>Read-only.</em>
|
||||
* @property {string} context <em>Read-only.</em>
|
||||
* @property {} devices <em>Read-only.</em>
|
||||
*/
|
||||
|
||||
Q_PROPERTY(bool muted READ isMuted WRITE setMuted NOTIFY mutedChanged)
|
||||
|
|
@ -66,7 +66,6 @@ public:
|
|||
* @param {} device
|
||||
* @param {boolean} isHMD
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void setInputDevice(const QAudioDeviceInfo& device, bool isHMD);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -74,40 +73,36 @@ public:
|
|||
* @param {} device
|
||||
* @param {boolean} isHMD
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void setOutputDevice(const QAudioDeviceInfo& device, bool isHMD);
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.setReverb
|
||||
* @param {boolean} enable
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void setReverb(bool enable);
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.setReverbOptions
|
||||
* @param {} options
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void setReverbOptions(const AudioEffectOptions* options);
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.setReverbOptions
|
||||
* @function Audio.startRecording
|
||||
* @param {string} filename
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE bool startRecording(const QString& filename);
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.stopRecording
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void stopRecording();
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.getRecording
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE bool getRecording();
|
||||
|
||||
signals:
|
||||
|
|
@ -116,39 +111,34 @@ signals:
|
|||
* @function Audio.nop
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void nop();
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.nop
|
||||
* @param {bool} isMuted
|
||||
* @function Audio.mutedChanged
|
||||
* @param {boolean} isMuted
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void mutedChanged(bool isMuted);
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.noiseReductionChanged
|
||||
* @param {bool} isEnabled
|
||||
* @param {boolean} isEnabled
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void noiseReductionChanged(bool isEnabled);
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.inputVolumeChanged
|
||||
* @param {float} volume
|
||||
* @param {number} volume
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void inputVolumeChanged(float volume);
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.inputLevelChanged
|
||||
* @param {float} level
|
||||
* @param {number} level
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void inputLevelChanged(float level);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -156,7 +146,6 @@ signals:
|
|||
* @param {string} context
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void contextChanged(const QString& context);
|
||||
|
||||
public slots:
|
||||
|
|
@ -165,7 +154,6 @@ public slots:
|
|||
* @function Audio.onContextChanged
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void onContextChanged();
|
||||
|
||||
private slots:
|
||||
|
|
|
|||
|
|
@ -32,7 +32,6 @@ public slots:
|
|||
* @function GooglePoly.setAPIKey
|
||||
* @param {string} key
|
||||
*/
|
||||
|
||||
void setAPIKey(const QString& key);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -42,7 +41,6 @@ public slots:
|
|||
* @param {string} format
|
||||
* @returns {string}
|
||||
*/
|
||||
|
||||
QString getAssetList(const QString& keyword, const QString& category, const QString& format);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -51,7 +49,6 @@ public slots:
|
|||
* @param {string} category
|
||||
* @returns {string}
|
||||
*/
|
||||
|
||||
QString getFBX(const QString& keyword, const QString& category);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -60,7 +57,6 @@ public slots:
|
|||
* @param {string} category
|
||||
* @returns {string}
|
||||
*/
|
||||
|
||||
QString getOBJ(const QString& keyword, const QString& category);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -69,7 +65,6 @@ public slots:
|
|||
* @param {string} category
|
||||
* @returns {string}
|
||||
*/
|
||||
|
||||
QString getBlocks(const QString& keyword, const QString& category);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -78,7 +73,6 @@ public slots:
|
|||
* @param {string} category
|
||||
* @returns {string}
|
||||
*/
|
||||
|
||||
QString getGLTF(const QString& keyword, const QString& category);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -87,7 +81,6 @@ public slots:
|
|||
* @param {string} category
|
||||
* @returns {string}
|
||||
*/
|
||||
|
||||
QString getGLTF2(const QString& keyword, const QString& category);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -96,7 +89,6 @@ public slots:
|
|||
* @param {string} category
|
||||
* @returns {string}
|
||||
*/
|
||||
|
||||
QString getTilt(const QString& keyword, const QString& category);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -104,7 +96,6 @@ public slots:
|
|||
* @param {string} input
|
||||
* @returns {string}
|
||||
*/
|
||||
|
||||
QString getModelInfo(const QString& input);
|
||||
|
||||
private:
|
||||
|
|
|
|||
|
|
@ -26,10 +26,10 @@ class AvatarInputs : public QObject {
|
|||
/**jsdoc
|
||||
* API to help manage your Avatar's input
|
||||
* @namespace AvatarInputs
|
||||
* @param {boolean} cameraEnabled
|
||||
* @param {boolean} cameraMuted
|
||||
* @param {boolean} isHMD
|
||||
* @param {boolean} showAudioTools
|
||||
* @property {boolean} cameraEnabled <em>Read-only.</em>
|
||||
* @property {boolean} cameraMuted <em>Read-only.</em>
|
||||
* @property {boolean} isHMD <em>Read-only.</em>
|
||||
* @property {boolean} showAudioTools
|
||||
*/
|
||||
|
||||
AI_PROPERTY(bool, cameraEnabled, false)
|
||||
|
|
@ -46,8 +46,8 @@ public:
|
|||
* @param {number} loudness
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE float loudnessToAudioLevel(float loudness);
|
||||
|
||||
AvatarInputs(QObject* parent = nullptr);
|
||||
void update();
|
||||
bool showAudioTools() const { return _showAudioTools; }
|
||||
|
|
@ -58,7 +58,6 @@ public slots:
|
|||
* @function AvatarInputs.setShowAudioTools
|
||||
* @param {boolean} showAudioTools
|
||||
*/
|
||||
|
||||
void setShowAudioTools(bool showAudioTools);
|
||||
|
||||
signals:
|
||||
|
|
@ -67,14 +66,12 @@ signals:
|
|||
* @function AvatarInputs.cameraEnabledChanged
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void cameraEnabledChanged();
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarInputs.cameraMutedChanged
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void cameraMutedChanged();
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -89,7 +86,6 @@ signals:
|
|||
* @param {boolean} show
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void showAudioToolsChanged(bool show);
|
||||
|
||||
protected:
|
||||
|
|
@ -97,13 +93,11 @@ protected:
|
|||
/**jsdoc
|
||||
* @function AvatarInputs.resetSensors
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void resetSensors();
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarInputs.toggleCameraMute
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void toggleCameraMute();
|
||||
|
||||
private:
|
||||
|
|
|
|||
|
|
@ -20,11 +20,6 @@
|
|||
#include <FBXReader.h>
|
||||
#include <ResourceCache.h>
|
||||
|
||||
/**jsdoc
|
||||
* API to manage Animation Cache resources
|
||||
* @namespace AnimationCache
|
||||
*/
|
||||
|
||||
class Animation;
|
||||
|
||||
typedef QSharedPointer<Animation> AnimationPointer;
|
||||
|
|
@ -35,79 +30,67 @@ class AnimationCache : public ResourceCache, public Dependency {
|
|||
SINGLETON_DEPENDENCY
|
||||
|
||||
public:
|
||||
// Copied over from ResourceCache (see ResourceCache.h for reason)
|
||||
|
||||
// Properties are copied over from ResourceCache (see ResourceCache.h for reason).
|
||||
|
||||
/**jsdoc
|
||||
* API to manage animation cache resources.
|
||||
* @namespace AnimationCache
|
||||
* @property numTotal {number} total number of total resources
|
||||
* @property numCached {number} total number of cached resource
|
||||
* @property sizeTotal {number} size in bytes of all resources
|
||||
* @property sizeCached {number} size in bytes of all cached resources
|
||||
*
|
||||
* @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
|
||||
* @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
|
||||
* @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>
|
||||
* @property {number} sizeCached - Size in bytes of all cached resources. <em>Read-only.</em>
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total number of resources
|
||||
* @function AnimationCache.getNumTotalResources
|
||||
* @returns {number}
|
||||
*/
|
||||
// Functions are copied over from ResourceCache (see ResourceCache.h for reason).
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total size in bytes of all resources
|
||||
* @function AnimationCache.getSizeTotalResources
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total number of cached resources
|
||||
* @function AnimationCache.getNumCachedResources
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total size in bytes of cached resources
|
||||
* @function AnimationCache.getSizeCachedResources
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns list of all resource urls
|
||||
/**jsdoc
|
||||
* Get the list of all resource URLs.
|
||||
* @function AnimationCache.getResourceList
|
||||
* @returns {string[]}
|
||||
* @return {string[]}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Asynchronously loads a resource from the spedified URL and returns it.
|
||||
* @param url {string} url of resource to load
|
||||
* @param fallback {string} fallback URL if load of the desired url fails
|
||||
* @function AnimationCache.getResource
|
||||
* @returns {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Prefetches a resource.
|
||||
* @param url {string} url of resource to load
|
||||
* @function AnimationCache.prefetch
|
||||
* @returns {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @param {number} deltaSize
|
||||
* @function AnimationCache.updateTotalSize
|
||||
* @returns {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
/**jsdoc
|
||||
* @function AnimationCache.dirty
|
||||
* @returns {Signal}
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AnimationCache.updateTotalSize
|
||||
* @param {number} deltaSize
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AnimationCache.prefetch
|
||||
* @param {string} url
|
||||
* @param {object} extra
|
||||
* @returns {object}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Asynchronously loads a resource from the specified URL and returns it.
|
||||
* @function AnimationCache.getResource
|
||||
* @param {string} url - URL of the resource to load.
|
||||
* @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
|
||||
* @param {} [extra=null]
|
||||
* @return {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Prefetches a resource.
|
||||
* @function AnimationCache.prefetch
|
||||
* @param {string} url - URL of the resource to prefetch.
|
||||
* @return {Resource}
|
||||
*/
|
||||
|
||||
|
||||
/**jsdoc
|
||||
* Returns animation resource for particular animation
|
||||
* Returns animation resource for particular animation.
|
||||
* @function AnimationCache.getAnimation
|
||||
* @param url {string} url to load
|
||||
* @param {string} url - URL to load.
|
||||
* @returns {Resource} animation
|
||||
*/
|
||||
|
||||
Q_INVOKABLE AnimationPointer getAnimation(const QString& url) { return getAnimation(QUrl(url)); }
|
||||
Q_INVOKABLE AnimationPointer getAnimation(const QUrl& url);
|
||||
|
||||
|
|
|
|||
|
|
@ -40,65 +40,135 @@ class AudioStreamStatsInterface : public QObject {
|
|||
Q_OBJECT
|
||||
|
||||
/**jsdoc
|
||||
* Audio stats from the Audio Mixer
|
||||
* @namespace AudioStats.mixerStream
|
||||
* @param {number} lossRate
|
||||
* @param {number} lossCount
|
||||
* @param {number} lossRateWindow
|
||||
* @param {number} lossCountWindow
|
||||
* @param {number} framesDesired
|
||||
* @param {number} framesAvailable
|
||||
* @param {number} framesAvailableAvg
|
||||
* @param {number} unplayedMsMax
|
||||
* @param {number} starveCount
|
||||
* @param {number} lastStarveDurationCount
|
||||
* @param {number} dropCount
|
||||
* @param {number} overflowCount
|
||||
* @param {number} timegapMsMax
|
||||
* @param {number} timegapMsAvg
|
||||
* @param {number} timegapMsMaxWindow
|
||||
* @param {number} timegapMsAvgWindow
|
||||
* @class AudioStats.AudioStreamStats
|
||||
* @property {number} lossRate <em>Read-only.</em>
|
||||
* @property {number} lossCount <em>Read-only.</em>
|
||||
* @property {number} lossRateWindow <em>Read-only.</em>
|
||||
* @property {number} lossCountWindow <em>Read-only.</em>
|
||||
* @property {number} framesDesired <em>Read-only.</em>
|
||||
* @property {number} framesAvailable <em>Read-only.</em>
|
||||
* @property {number} framesAvailableAvg <em>Read-only.</em>
|
||||
* @property {number} unplayedMsMax <em>Read-only.</em>
|
||||
* @property {number} starveCount <em>Read-only.</em>
|
||||
* @property {number} lastStarveDurationCount <em>Read-only.</em>
|
||||
* @property {number} dropCount <em>Read-only.</em>
|
||||
* @property {number} overflowCount <em>Read-only.</em>
|
||||
* @property {number} timegapMsMax <em>Read-only.</em>
|
||||
* @property {number} timegapMsAvg <em>Read-only.</em>
|
||||
* @property {number} timegapMsMaxWindow <em>Read-only.</em>
|
||||
* @property {number} timegapMsAvgWindow <em>Read-only.</em>
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Audio stats from the Client Mixer
|
||||
* @namespace AudioStats.clientMixer
|
||||
* @function AudioStats.AudioStreamStats.lossRateChanged
|
||||
* @param {number} lossRate
|
||||
* @param {number} lossCount
|
||||
* @param {number} lossRateWindow
|
||||
* @param {number} lossCountWindow
|
||||
* @param {number} framesDesired
|
||||
* @param {number} framesAvailable
|
||||
* @param {number} framesAvailableAvg
|
||||
* @param {number} unplayedMsMax
|
||||
* @param {number} starveCount
|
||||
* @param {number} lastStarveDurationCount
|
||||
* @param {number} dropCount
|
||||
* @param {number} overflowCount
|
||||
* @param {number} timegapMsMax
|
||||
* @param {number} timegapMsAvg
|
||||
* @param {number} timegapMsMaxWindow
|
||||
* @param {number} timegapMsAvgWindow
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
AUDIO_PROPERTY(float, lossRate)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.lossCountChanged
|
||||
* @param {number} lossCount
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(float, lossCount)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.lossRateWindowChanged
|
||||
* @param {number} lossRateWindow
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(float, lossRateWindow)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.lossCountWindowChanged
|
||||
* @param {number} lossCountWindow
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(float, lossCountWindow)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.framesDesiredChanged
|
||||
* @param {number} framesDesired
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(int, framesDesired)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.framesAvailableChanged
|
||||
* @param {number} framesAvailable
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(int, framesAvailable)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.framesAvailableAvgChanged
|
||||
* @param {number} framesAvailableAvg
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(int, framesAvailableAvg)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.unplayedMsMaxChanged
|
||||
* @param {number} unplayedMsMax
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(float, unplayedMsMax)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.starveCountChanged
|
||||
* @param {number} starveCount
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(int, starveCount)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.lastStarveDurationCountChanged
|
||||
* @param {number} lastStarveDurationCount
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(int, lastStarveDurationCount)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.dropCountChanged
|
||||
* @param {number} dropCount
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(int, dropCount)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.overflowCountChanged
|
||||
* @param {number} overflowCount
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(int, overflowCount)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.timegapMsMaxChanged
|
||||
* @param {number} timegapMsMax
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(quint64, timegapMsMax)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.timegapMsAvgChanged
|
||||
* @param {number} timegapMsAvg
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(quint64, timegapMsAvg)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.timegapMsMaxWindowChanged
|
||||
* @param {number} timegapMsMaxWindow
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(quint64, timegapMsMaxWindow)
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.AudioStreamStats.timegapMsAvgWindowChanged
|
||||
* @param {number} timegapMsAvgWindow
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(quint64, timegapMsAvgWindow)
|
||||
|
||||
public:
|
||||
|
|
@ -113,31 +183,82 @@ class AudioStatsInterface : public QObject {
|
|||
Q_OBJECT
|
||||
|
||||
/**jsdoc
|
||||
* Audio stats from the client
|
||||
* Audio stats from the client.
|
||||
* @namespace AudioStats
|
||||
* @param {number} pingMs
|
||||
* @param {number} inputReadMsMax
|
||||
* @param {number} inputUnplayedMsMax
|
||||
* @param {number} outputUnplayedMsMax
|
||||
* @param {number} sentTimegapMsMax
|
||||
* @param {number} sentTimegapMsAvg
|
||||
* @param {number} sentTimegapMsMaxWindow
|
||||
* @param {number} sentTimegapMsAvgWindow
|
||||
* @property {number} pingMs <em>Read-only.</em>
|
||||
* @property {number} inputReadMsMax <em>Read-only.</em>
|
||||
* @property {number} inputUnplayedMsMax <em>Read-only.</em>
|
||||
* @property {number} outputUnplayedMsMax <em>Read-only.</em>
|
||||
* @property {number} sentTimegapMsMax <em>Read-only.</em>
|
||||
* @property {number} sentTimegapMsAvg <em>Read-only.</em>
|
||||
* @property {number} sentTimegapMsMaxWindow <em>Read-only.</em>
|
||||
* @property {number} sentTimegapMsAvgWindow <em>Read-only.</em>
|
||||
* @property {AudioStats.AudioStreamStats} clientStream <em>Read-only.</em>
|
||||
* @property {AudioStats.AudioStreamStats} mixerStream <em>Read-only.</em>
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.pingMsChanged
|
||||
* @param {number} pingMs
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(float, pingMs);
|
||||
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.inputReadMsMaxChanged
|
||||
* @param {number} inputReadMsMax
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(float, inputReadMsMax);
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.inputUnplayedMsMaxChanged
|
||||
* @param {number} inputUnplayedMsMax
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(float, inputUnplayedMsMax);
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.outputUnplayedMsMaxChanged
|
||||
* @param {number} outputUnplayedMsMax
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(float, outputUnplayedMsMax);
|
||||
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.sentTimegapMsMaxChanged
|
||||
* @param {number} sentTimegapMsMax
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(quint64, sentTimegapMsMax);
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.sentTimegapMsAvgChanged
|
||||
* @param {number} sentTimegapMsAvg
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(quint64, sentTimegapMsAvg);
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.sentTimegapMsMaxWindowChanged
|
||||
* @param {number} sentTimegapMsMaxWindow
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(quint64, sentTimegapMsMaxWindow);
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.sentTimegapMsAvgWindowChanged
|
||||
* @param {number} sentTimegapMsAvgWindow
|
||||
* @returns {Signal}
|
||||
*/
|
||||
AUDIO_PROPERTY(quint64, sentTimegapMsAvgWindow);
|
||||
|
||||
Q_PROPERTY(AudioStreamStatsInterface* mixerStream READ getMixerStream NOTIFY mixerStreamChanged);
|
||||
Q_PROPERTY(AudioStreamStatsInterface* clientStream READ getClientStream NOTIFY clientStreamChanged);
|
||||
|
||||
// FIXME: The injectorStreams property isn't available in JavaScript but the notification signal is.
|
||||
Q_PROPERTY(QObject* injectorStreams READ getInjectorStreams NOTIFY injectorStreamsChanged);
|
||||
|
||||
public:
|
||||
|
|
@ -159,21 +280,18 @@ signals:
|
|||
* @function AudioStats.mixerStreamChanged
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void mixerStreamChanged();
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.clientStreamChanged
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void clientStreamChanged();
|
||||
|
||||
/**jsdoc
|
||||
* @function AudioStats.injectorStreamsChanged
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void injectorStreamsChanged();
|
||||
|
||||
private:
|
||||
|
|
|
|||
|
|
@ -16,84 +16,32 @@
|
|||
|
||||
#include "Sound.h"
|
||||
|
||||
/**jsdoc
|
||||
* API to manage Sound Cache resources
|
||||
* @namespace SoundCache
|
||||
*/
|
||||
|
||||
|
||||
/// Scriptable interface for sound loading.
|
||||
class SoundCache : public ResourceCache, public Dependency {
|
||||
Q_OBJECT
|
||||
SINGLETON_DEPENDENCY
|
||||
|
||||
public:
|
||||
// Copied over from ResourceCache (see ResourceCache.h for reason)
|
||||
|
||||
// Properties are copied over from ResourceCache (see ResourceCache.h for reason).
|
||||
|
||||
/**jsdoc
|
||||
* API to manage sound cache resources.
|
||||
* @namespace SoundCache
|
||||
* @property numTotal {number} total number of total resources
|
||||
* @property numCached {number} total number of cached resource
|
||||
* @property sizeTotal {number} size in bytes of all resources
|
||||
* @property sizeCached {number} size in bytes of all cached resources
|
||||
*
|
||||
* @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
|
||||
* @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
|
||||
* @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>
|
||||
* @property {number} sizeCached - Size in bytes of all cached resources. <em>Read-only.</em>
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total number of resources
|
||||
* @function SoundCache.getNumTotalResources
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
// Functions are copied over from ResourceCache (see ResourceCache.h for reason).
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total size in bytes of all resources
|
||||
* @function SoundCache.getSizeTotalResources
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total number of cached resources
|
||||
* @function SoundCache.getNumCachedResources
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total size in bytes of cached resources
|
||||
* @function SoundCache.getSizeCachedResources
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns list of all resource urls
|
||||
* Get the list of all resource URLs.
|
||||
* @function SoundCache.getResourceList
|
||||
* @returns {string[]}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns animation resource for particular animation
|
||||
* @function SoundCache.getAnimation
|
||||
* @param url {string} url to load
|
||||
* @returns {Resource} animation
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Asynchronously loads a resource from the spedified URL and returns it.
|
||||
* @param url {string} url of resource to load
|
||||
* @param fallback {string} fallback URL if load of the desired url fails
|
||||
* @function SoundCache.getResource
|
||||
* @returns {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Prefetches a resource.
|
||||
* @param url {string} url of resource to load
|
||||
* @function SoundCache.prefetch
|
||||
* @returns {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @param {number} deltaSize
|
||||
* @function SoundCache.updateTotalSize
|
||||
* @returns {Resource}
|
||||
* @return {string[]}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -101,12 +49,40 @@ public:
|
|||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function SoundCache.updateTotalSize
|
||||
* @param {number} deltaSize
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function SoundCache.prefetch
|
||||
* @param {string} url
|
||||
* @param {object} extra
|
||||
* @returns {object}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Asynchronously loads a resource from the specified URL and returns it.
|
||||
* @function SoundCache.getResource
|
||||
* @param {string} url - URL of the resource to load.
|
||||
* @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
|
||||
* @param {} [extra=null]
|
||||
* @return {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Prefetches a resource.
|
||||
* @function SoundCache.prefetch
|
||||
* @param {string} url - URL of the resource to prefetch.
|
||||
* @return {Resource}
|
||||
*/
|
||||
|
||||
|
||||
/**jsdoc
|
||||
* @function SoundCache.getSound
|
||||
* @param {string} url
|
||||
* @returns {}
|
||||
* @returns {object}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE SharedSoundPointer getSound(const QUrl& url);
|
||||
protected:
|
||||
virtual QSharedPointer<Resource> createResource(const QUrl& url, const QSharedPointer<Resource>& fallback,
|
||||
|
|
|
|||
|
|
@ -30,15 +30,6 @@
|
|||
|
||||
#include "AvatarData.h"
|
||||
|
||||
/**jsdoc
|
||||
* The AvatarHashMap API deals with functionality related to Avatar information and connectivity
|
||||
* @namespace AvatarHashMap
|
||||
*/
|
||||
|
||||
// JSDoc 3.5.5 doesn't augment @property definitions.
|
||||
// These functions are being copied into Avatar classes which inherit the AvatarHashMap
|
||||
|
||||
|
||||
class AvatarHashMap : public QObject, public Dependency {
|
||||
Q_OBJECT
|
||||
SINGLETON_DEPENDENCY
|
||||
|
|
@ -51,26 +42,20 @@ public:
|
|||
// Currently, your own avatar will be included as the null avatar id.
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarHashMap.getAvatarIdentifiers
|
||||
* @function AvatarManager.getAvatarIdentifiers
|
||||
* @returns {Uuid[]}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE QVector<QUuid> getAvatarIdentifiers();
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarHashMap.getAvatarsInRange
|
||||
* @function AvatarManager.getAvatarsInRange
|
||||
* @param {Vec3} position
|
||||
* @param {float} rangeMeters
|
||||
* @returns {string[]}
|
||||
* @param {number} range
|
||||
* @returns {Uuid[]}
|
||||
*/
|
||||
|
||||
Q_INVOKABLE QVector<QUuid> getAvatarsInRange(const glm::vec3& position, float rangeMeters) const;
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarHashMap.getAvatar
|
||||
* @param {string} avatarID
|
||||
* @returns {ScriptAvatarData}
|
||||
*/
|
||||
|
||||
// No JSDod because it's documwented in AvatarManager.
|
||||
// Null/Default-constructed QUuids will return MyAvatar
|
||||
Q_INVOKABLE virtual ScriptAvatarData* getAvatar(QUuid avatarID) { return new ScriptAvatarData(getAvatarBySessionID(avatarID)); }
|
||||
|
||||
|
|
@ -80,73 +65,65 @@ public:
|
|||
signals:
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarHashMap.avatarAddedEvent
|
||||
* @param {string} sessionUUID
|
||||
* @function AvatarManager.avatarAddedEvent
|
||||
* @param {Uuid} sessionUUID
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void avatarAddedEvent(const QUuid& sessionUUID);
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarHashMap.avatarRemovedEvent
|
||||
* @param {string} sessionUUID
|
||||
* @function AvatarManager.avatarRemovedEvent
|
||||
* @param {Uuid} sessionUUID
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void avatarRemovedEvent(const QUuid& sessionUUID);
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarHashMap.avatarSessionChangedEvent
|
||||
* @param {string} sessionUUID
|
||||
* @param {string} oldUUID
|
||||
* @function AvatarManager.avatarSessionChangedEvent
|
||||
* @param {Uuid} sessionUUID
|
||||
* @param {Uuid} oldSessionUUID
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void avatarSessionChangedEvent(const QUuid& sessionUUID,const QUuid& oldUUID);
|
||||
|
||||
public slots:
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarHashMap.isAvatarInRange
|
||||
* @function AvatarManager.isAvatarInRange
|
||||
* @param {string} position
|
||||
* @param {string} range
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
bool isAvatarInRange(const glm::vec3 & position, const float range);
|
||||
|
||||
protected slots:
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarHashMap.sessionUUIDChanged
|
||||
* @param {string} sessionUUID
|
||||
* @param {string} oldUUID
|
||||
* @function AvatarManager.sessionUUIDChanged
|
||||
* @param {Uuid} sessionUUID
|
||||
* @param {Uuid} oldSessionUUID
|
||||
*/
|
||||
|
||||
void sessionUUIDChanged(const QUuid& sessionUUID, const QUuid& oldUUID);
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarHashMap.processAvatarDataPacket
|
||||
* @function AvatarManager.processAvatarDataPacket
|
||||
* @param {} message
|
||||
* @param {} sendingNode
|
||||
*/
|
||||
|
||||
void processAvatarDataPacket(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode);
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarHashMap.processAvatarIdentityPacket
|
||||
* @function AvatarManager.processAvatarIdentityPacket
|
||||
* @param {} message
|
||||
* @param {} sendingNode
|
||||
*/
|
||||
|
||||
void processAvatarIdentityPacket(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode);
|
||||
|
||||
/**jsdoc
|
||||
* @function AvatarHashMap.processKillAvatar
|
||||
* @function AvatarManager.processKillAvatar
|
||||
* @param {} message
|
||||
* @param {} sendingNode
|
||||
*/
|
||||
|
||||
void processKillAvatar(QSharedPointer<ReceivedMessage> message, SharedNodePointer sendingNode);
|
||||
|
||||
protected:
|
||||
|
|
|
|||
|
|
@ -393,7 +393,7 @@ public slots:
|
|||
* @param {Entities.EntityType} entityName - The name of the entity to search for.
|
||||
* @param {Vec3} center - The point about which to search.
|
||||
* @param {number} radius - The radius within which to search.
|
||||
* @param {bool} caseSensitiveSearch - Choose whether to to return case sensitive results back.
|
||||
* @param {boolean} caseSensitiveSearch - Choose whether to to return case sensitive results back.
|
||||
* @returns {Uuid[]} An array of entity IDs of the specified type that intersect the search sphere. The array is empty if
|
||||
* no entities could be found.
|
||||
* @example <caption>Get back a list of entities</caption>
|
||||
|
|
|
|||
|
|
@ -21,11 +21,6 @@
|
|||
#include "FBXReader.h"
|
||||
#include "TextureCache.h"
|
||||
|
||||
/**jsdoc
|
||||
* API to manage Model Cache resources
|
||||
* @namespace ModelCache
|
||||
*/
|
||||
|
||||
// Alias instead of derive to avoid copying
|
||||
|
||||
class NetworkTexture;
|
||||
|
|
@ -141,72 +136,62 @@ class ModelCache : public ResourceCache, public Dependency {
|
|||
Q_OBJECT
|
||||
SINGLETON_DEPENDENCY
|
||||
|
||||
|
||||
public:
|
||||
|
||||
/**jsdoc
|
||||
* @namespace ModelCache
|
||||
* @property numTotal {number} total number of total resources
|
||||
* @property numCached {number} total number of cached resource
|
||||
* @property sizeTotal {number} size in bytes of all resources
|
||||
* @property sizeCached {number} size in bytes of all cached resources
|
||||
*/
|
||||
// Properties are copied over from ResourceCache (see ResourceCache.h for reason).
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total number of resources
|
||||
* @function ModelCache.getNumTotalResources
|
||||
* @returns {number}
|
||||
*/
|
||||
* API to manage model cache resources.
|
||||
* @namespace ModelCache
|
||||
*
|
||||
* @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
|
||||
* @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
|
||||
* @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>
|
||||
* @property {number} sizeCached - Size in bytes of all cached resources. <em>Read-only.</em>
|
||||
*/
|
||||
|
||||
|
||||
// Functions are copied over from ResourceCache (see ResourceCache.h for reason).
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total size in bytes of all resources
|
||||
* @function ModelCache.getSizeTotalResources
|
||||
* @returns {number}
|
||||
*/
|
||||
* Get the list of all resource URLs.
|
||||
* @function ModelCache.getResourceList
|
||||
* @return {string[]}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total number of cached resources
|
||||
* @function ModelCache.getNumCachedResources
|
||||
* @returns {number}
|
||||
*/
|
||||
* @function ModelCache.dirty
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total size in bytes of cached resources
|
||||
* @function ModelCache.getSizeCachedResources
|
||||
* @returns {number}
|
||||
*/
|
||||
* @function ModelCache.updateTotalSize
|
||||
* @param {number} deltaSize
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns list of all resource urls
|
||||
* @function ModelCache.getResourceList
|
||||
* @returns {string[]}
|
||||
*/
|
||||
* @function ModelCache.prefetch
|
||||
* @param {string} url
|
||||
* @param {object} extra
|
||||
* @returns {object}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Asynchronously loads a resource from the spedified URL and returns it.
|
||||
* @param url {string} url of resource to load
|
||||
* @param fallback {string} fallback URL if load of the desired url fails
|
||||
* @function ModelCache.getResource
|
||||
* @returns {Resource}
|
||||
*/
|
||||
* Asynchronously loads a resource from the specified URL and returns it.
|
||||
* @function ModelCache.getResource
|
||||
* @param {string} url - URL of the resource to load.
|
||||
* @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
|
||||
* @param {} [extra=null]
|
||||
* @return {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Prefetches a resource.
|
||||
* @param url {string} url of resource to load
|
||||
* @function ModelCache.prefetch
|
||||
* @returns {Resource}
|
||||
*/
|
||||
* Prefetches a resource.
|
||||
* @function ModelCache.prefetch
|
||||
* @param {string} url - URL of the resource to prefetch.
|
||||
* @return {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @param {number} deltaSize
|
||||
* @function ModelCache.updateTotalSize
|
||||
* @returns {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function ModelCache.dirty
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
GeometryResource::Pointer getGeometryResource(const QUrl& url,
|
||||
const QVariantHash& mapping = QVariantHash(),
|
||||
|
|
|
|||
|
|
@ -137,10 +137,6 @@ using NetworkTexturePointer = QSharedPointer<NetworkTexture>;
|
|||
|
||||
Q_DECLARE_METATYPE(QWeakPointer<NetworkTexture>)
|
||||
|
||||
/**jsdoc
|
||||
* API to manage Texture Cache resources
|
||||
* @namespace TextureCache
|
||||
*/
|
||||
|
||||
/// Stores cached textures, including render-to-texture targets.
|
||||
class TextureCache : public ResourceCache, public Dependency {
|
||||
|
|
@ -148,78 +144,61 @@ class TextureCache : public ResourceCache, public Dependency {
|
|||
SINGLETON_DEPENDENCY
|
||||
|
||||
public:
|
||||
// Copied over from ResourceCache (see ResourceCache.h for reason)
|
||||
|
||||
// Properties are copied over from ResourceCache (see ResourceCache.h for reason).
|
||||
|
||||
/**jsdoc
|
||||
* @namespace TextureCache
|
||||
* @property numTotal {number} total number of total resources
|
||||
* @property numCached {number} total number of cached resource
|
||||
* @property sizeTotal {number} size in bytes of all resources
|
||||
* @property sizeCached {number} size in bytes of all cached resources
|
||||
*/
|
||||
* API to manage texture cache resources.
|
||||
* @namespace TextureCache
|
||||
*
|
||||
* @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
|
||||
* @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
|
||||
* @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>
|
||||
* @property {number} sizeCached - Size in bytes of all cached resources. <em>Read-only.</em>
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total number of resources
|
||||
* @function TextureCache.getNumTotalResources
|
||||
* @returns {number}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total size in bytes of all resources
|
||||
* @function TextureCache.getSizeTotalResources
|
||||
* @returns {number}
|
||||
*/
|
||||
// Functions are copied over from ResourceCache (see ResourceCache.h for reason).
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total number of cached resources
|
||||
* @function TextureCache.getNumCachedResources
|
||||
* @returns {number}
|
||||
*/
|
||||
/**jsdoc
|
||||
* Get the list of all resource URLs.
|
||||
* @function TextureCache.getResourceList
|
||||
* @return {string[]}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total size in bytes of cached resources
|
||||
* @function TextureCache.getSizeCachedResources
|
||||
* @returns {number}
|
||||
*/
|
||||
/**jsdoc
|
||||
* @function TextureCache.dirty
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns list of all resource urls
|
||||
* @function TextureCache.getResourceList
|
||||
* @returns {string[]}
|
||||
*/
|
||||
/**jsdoc
|
||||
* @function TextureCache.updateTotalSize
|
||||
* @param {number} deltaSize
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Returns animation resource for particular animation
|
||||
* @function TextureCache.getAnimation
|
||||
* @param url {string} url to load
|
||||
* @returns {Resource} animation
|
||||
*/
|
||||
/**jsdoc
|
||||
* @function TextureCache.prefetch
|
||||
* @param {string} url
|
||||
* @param {object} extra
|
||||
* @returns {object}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Asynchronously loads a resource from the spedified URL and returns it.
|
||||
* @param url {string} url of resource to load
|
||||
* @param fallback {string} fallback URL if load of the desired url fails
|
||||
* @function TextureCache.getResource
|
||||
* @returns {Resource}
|
||||
*/
|
||||
/**jsdoc
|
||||
* Asynchronously loads a resource from the specified URL and returns it.
|
||||
* @function TextureCache.getResource
|
||||
* @param {string} url - URL of the resource to load.
|
||||
* @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
|
||||
* @param {} [extra=null]
|
||||
* @return {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Prefetches a resource.
|
||||
* @param url {string} url of resource to load
|
||||
* @function TextureCache.prefetch
|
||||
* @returns {Resource}
|
||||
*/
|
||||
/**jsdoc
|
||||
* Prefetches a resource.
|
||||
* @function TextureCache.prefetch
|
||||
* @param {string} url - URL of the resource to prefetch.
|
||||
* @return {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @param {number} deltaSize
|
||||
* @function TextureCache.updateTotalSize
|
||||
* @returns {Resource}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* @function TextureCache.dirty
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
/// Returns the ID of the permutation/normal texture used for Perlin noise shader programs. This texture
|
||||
/// has two lines: the first, a set of random numbers in [0, 255] to be used as permutation offsets, and
|
||||
|
|
@ -265,6 +244,13 @@ signals:
|
|||
void spectatorCameraFramebufferReset();
|
||||
|
||||
protected:
|
||||
|
||||
/**jsdoc
|
||||
* @function TextureCache.prefect
|
||||
* @param {string} url
|
||||
* @param {number} type
|
||||
* @param {number} [maxNumPixels=67108864]
|
||||
*/
|
||||
// Overload ResourceCache::prefetch to allow specifying texture type for loads
|
||||
Q_INVOKABLE ScriptableResource* prefetch(const QUrl& url, int type, int maxNumPixels = ABSOLUTE_MAX_TEXTURE_NUM_PIXELS);
|
||||
|
||||
|
|
|
|||
|
|
@ -31,12 +31,54 @@ public:
|
|||
BaseAssetScriptingInterface(QObject* parent = nullptr);
|
||||
|
||||
public slots:
|
||||
|
||||
/**jsdoc
|
||||
* @function Assets.isValidPath
|
||||
* @param {string} input
|
||||
* @returns {boolean}
|
||||
*/
|
||||
bool isValidPath(QString input) { return AssetUtils::isValidPath(input); }
|
||||
|
||||
/**jsdoc
|
||||
* @function Assets.isValidFilePath
|
||||
* @param {string} input
|
||||
* @returns {boolean}
|
||||
*/
|
||||
bool isValidFilePath(QString input) { return AssetUtils::isValidFilePath(input); }
|
||||
|
||||
/**jsdoc
|
||||
* @function Assets.getATPUrl
|
||||
* @param {string} input
|
||||
* @returns {string}
|
||||
*/
|
||||
QUrl getATPUrl(QString input) { return AssetUtils::getATPUrl(input); }
|
||||
|
||||
/**jsdoc
|
||||
* @function Assets.extractAssetHash
|
||||
* @param {string} input
|
||||
* @returns {string}
|
||||
*/
|
||||
QString extractAssetHash(QString input) { return AssetUtils::extractAssetHash(input); }
|
||||
|
||||
/**jsdoc
|
||||
* @function Assets.isValidHash
|
||||
* @param {string} input
|
||||
* @returns {boolean}
|
||||
*/
|
||||
bool isValidHash(QString input) { return AssetUtils::isValidHash(input); }
|
||||
|
||||
/**jsdoc
|
||||
* @function Assets.hashData
|
||||
* @param {} data
|
||||
* @returns {object}
|
||||
*/
|
||||
QByteArray hashData(const QByteArray& data) { return AssetUtils::hashData(data); }
|
||||
|
||||
/**jsdoc
|
||||
* @function Assets.hashDataHex
|
||||
* @param {} data
|
||||
* @returns {string}
|
||||
*/
|
||||
QString hashDataHex(const QByteArray& data) { return hashData(data).toHex(); }
|
||||
|
||||
protected:
|
||||
|
|
|
|||
|
|
@ -89,14 +89,13 @@ class ScriptableResource : public QObject {
|
|||
|
||||
/**jsdoc
|
||||
* @constructor Resource
|
||||
* @property url {string} url of this resource
|
||||
* @property state {Resource.State} current loading state
|
||||
* @property {string} url - URL of this resource.
|
||||
* @property {Resource.State} state - Current loading state.
|
||||
*/
|
||||
|
||||
Q_OBJECT
|
||||
Q_PROPERTY(QUrl url READ getURL)
|
||||
Q_PROPERTY(int state READ getState NOTIFY stateChanged)
|
||||
|
||||
|
||||
|
||||
public:
|
||||
|
|
@ -104,11 +103,11 @@ public:
|
|||
/**jsdoc
|
||||
* @name Resource.State
|
||||
* @static
|
||||
* @property QUEUED {int} The resource is queued up, waiting to be loaded.
|
||||
* @property LOADING {int} The resource is downloading
|
||||
* @property LOADED {int} The resource has finished downloaded by is not complete
|
||||
* @property FINISHED {int} The resource has completly finished loading and is ready.
|
||||
* @property FAILED {int} Downloading the resource has failed.
|
||||
* @property {number} QUEUED - The resource is queued up, waiting to be loaded.
|
||||
* @property {number} LOADING - The resource is downloading.
|
||||
* @property {number} LOADED - The resource has finished downloaded by is not complete.
|
||||
* @property {number} FINISHED - The resource has completely finished loading and is ready.
|
||||
* @property {number} FAILED - Downloading the resource has failed.
|
||||
*/
|
||||
|
||||
enum State {
|
||||
|
|
@ -124,7 +123,7 @@ public:
|
|||
virtual ~ScriptableResource() = default;
|
||||
|
||||
/**jsdoc
|
||||
* Release this resource
|
||||
* Release this resource.
|
||||
* @function Resource#release
|
||||
*/
|
||||
Q_INVOKABLE void release();
|
||||
|
|
@ -139,18 +138,18 @@ public:
|
|||
signals:
|
||||
|
||||
/**jsdoc
|
||||
* Signaled when download progress for this resource has changed
|
||||
* Triggered when download progress for this resource has changed.
|
||||
* @function Resource#progressChanged
|
||||
* @param bytesReceived {int} bytes downloaded so far
|
||||
* @param bytesTotal {int} total number of bytes in the resource
|
||||
* @param {number} bytesReceived - Byytes downloaded so far.
|
||||
* @param {number} bytesTotal - Total number of bytes in the resource.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void progressChanged(uint64_t bytesReceived, uint64_t bytesTotal);
|
||||
|
||||
/**jsdoc
|
||||
* Signaled when resource loading state has changed
|
||||
* Triggered when resource loading state has changed.
|
||||
* @function Resource#stateChanged
|
||||
* @param bytesReceived {Resource.State} new state
|
||||
* @param {Resource.State} state - New state.
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void stateChanged(int state);
|
||||
|
|
@ -185,14 +184,15 @@ Q_DECLARE_METATYPE(ScriptableResource*);
|
|||
/// Base class for resource caches.
|
||||
class ResourceCache : public QObject {
|
||||
Q_OBJECT
|
||||
// JSDoc 3.5.5 doesn't augment @property definitions.
|
||||
// These functions are being copied into the different exposed cache classes
|
||||
|
||||
// JSDoc 3.5.5 doesn't augment namespaces with @property or @function definitions.
|
||||
// The ResourceCache properties and functions are copied to the different exposed cache classes.
|
||||
|
||||
/**jsdoc
|
||||
* @namespace ResourceCache
|
||||
* @property numTotal {number} total number of total resources
|
||||
* @property numCached {number} total number of cached resource
|
||||
* @property sizeTotal {number} size in bytes of all resources
|
||||
* @property sizeCached {number} size in bytes of all cached resources
|
||||
* @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
|
||||
* @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
|
||||
* @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>
|
||||
* @property {number} sizeCached - Size in bytes of all cached resources. <em>Read-only.</em>
|
||||
*/
|
||||
Q_PROPERTY(size_t numTotal READ getNumTotalResources NOTIFY dirty)
|
||||
Q_PROPERTY(size_t numCached READ getNumCachedResources NOTIFY dirty)
|
||||
|
|
@ -200,36 +200,14 @@ class ResourceCache : public QObject {
|
|||
Q_PROPERTY(size_t sizeCached READ getSizeCachedResources NOTIFY dirty)
|
||||
|
||||
public:
|
||||
/**jsdoc
|
||||
* Returns the total number of resources
|
||||
* @function ResourceCache.getNumTotalResources
|
||||
* @return {number}
|
||||
*/
|
||||
|
||||
size_t getNumTotalResources() const { return _numTotalResources; }
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total size in bytes of all resources
|
||||
* @function ResourceCache.getSizeTotalResources
|
||||
* @return {number}
|
||||
*/
|
||||
size_t getSizeTotalResources() const { return _totalResourcesSize; }
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total number of cached resources
|
||||
* @function ResourceCache.getNumCachedResources
|
||||
* @return {number}
|
||||
*/
|
||||
size_t getNumCachedResources() const { return _numUnusedResources; }
|
||||
|
||||
/**jsdoc
|
||||
* Returns the total size in bytes of cached resources
|
||||
* @function ResourceCache.getSizeCachedResources
|
||||
* @return {number}
|
||||
*/
|
||||
size_t getSizeCachedResources() const { return _unusedResourcesSize; }
|
||||
|
||||
/**jsdoc
|
||||
* Returns list of all resource urls
|
||||
* Get the list of all resource URLs.
|
||||
* @function ResourceCache.getResourceList
|
||||
* @return {string[]}
|
||||
*/
|
||||
|
|
@ -257,28 +235,45 @@ public:
|
|||
void clearUnusedResources();
|
||||
|
||||
signals:
|
||||
|
||||
/**jsdoc
|
||||
* @function ResourceCache.dirty
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void dirty();
|
||||
|
||||
protected slots:
|
||||
|
||||
/**jsdoc
|
||||
* @function ResourceCache.updateTotalSize
|
||||
* @param {number} deltaSize
|
||||
*/
|
||||
void updateTotalSize(const qint64& deltaSize);
|
||||
|
||||
/**jsdoc
|
||||
* @function ResourceCache.prefetch
|
||||
* @param {string} url
|
||||
* @param {object} extra
|
||||
* @returns {object}
|
||||
*/
|
||||
// Prefetches a resource to be held by the QScriptEngine.
|
||||
// Left as a protected member so subclasses can overload prefetch
|
||||
// and delegate to it (see TextureCache::prefetch(const QUrl&, int).
|
||||
ScriptableResource* prefetch(const QUrl& url, void* extra);
|
||||
|
||||
/**jsdoc
|
||||
* Asynchronously loads a resource from the specified URL and returns it.
|
||||
* @function ResourceCache.getResource
|
||||
* @param {string} url - URL of the resource to load.
|
||||
* @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
|
||||
* @param {} [extra=null]
|
||||
* @return {Resource}
|
||||
*/
|
||||
/// Loads a resource from the specified URL and returns it.
|
||||
/// If the caller is on a different thread than the ResourceCache,
|
||||
/// returns an empty smart pointer and loads its asynchronously.
|
||||
/// \param fallback a fallback URL to load if the desired one is unavailable
|
||||
/// \param extra extra data to pass to the creator, if appropriate
|
||||
/**jsdoc
|
||||
* Asynchronously loads a resource from the spedified URL and returns it.
|
||||
* @param url {string} url of resource to load
|
||||
* @param fallback {string} fallback URL if load of the desired url fails
|
||||
* @function ResourceCache.getResource
|
||||
* @return {Resource}
|
||||
*/
|
||||
QSharedPointer<Resource> getResource(const QUrl& url, const QUrl& fallback = QUrl(),
|
||||
void* extra = NULL);
|
||||
|
||||
|
|
@ -292,8 +287,8 @@ protected:
|
|||
// the QScriptEngine will delete the pointer when it is garbage collected.
|
||||
/**jsdoc
|
||||
* Prefetches a resource.
|
||||
* @param url {string} url of resource to load
|
||||
* @function ResourceCache.prefetch
|
||||
* @param {string} url - URL of the resource to prefetch.
|
||||
* @return {Resource}
|
||||
*/
|
||||
Q_INVOKABLE ScriptableResource* prefetch(const QUrl& url) { return prefetch(url, nullptr); }
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@
|
|||
#include <QtNetwork/QNetworkDiskCache>
|
||||
|
||||
/**jsdoc
|
||||
* The Assets API allows you to communicate with the Asset Browser
|
||||
* The Assets API allows you to communicate with the Asset Browser.
|
||||
* @namespace Assets
|
||||
*/
|
||||
class AssetScriptingInterface : public BaseAssetScriptingInterface, QScriptable {
|
||||
|
|
@ -41,14 +41,12 @@ public:
|
|||
* @param data {string} content to upload
|
||||
* @param callback {Assets~uploadDataCallback} called when upload is complete
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Called when uploadData is complete
|
||||
* @callback Assets~uploadDataCallback
|
||||
* @param {string} url
|
||||
* @param {string} hash
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void uploadData(QString data, QScriptValue callback);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -57,13 +55,11 @@ public:
|
|||
* @param url {string} URL of asset to download, must be ATP scheme URL.
|
||||
* @param callback {Assets~downloadDataCallback}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Called when downloadData is complete
|
||||
* @callback Assets~downloadDataCallback
|
||||
* @param data {string} content that was downloaded
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void downloadData(QString url, QScriptValue downloadComplete);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -73,13 +69,11 @@ public:
|
|||
* @param hash {string}
|
||||
* @param callback {Assets~setMappingCallback}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Called when setMapping is complete
|
||||
* @callback Assets~setMappingCallback
|
||||
* @param {string} error
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void setMapping(QString path, QString hash, QScriptValue callback);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -88,21 +82,12 @@ public:
|
|||
* @param path {string}
|
||||
* @param callback {Assets~getMappingCallback}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Called when getMapping is complete.
|
||||
* @callback Assets~getMappingCallback
|
||||
* @param assetID {string} hash value if found, else an empty string
|
||||
* @param error {string} error description if the path could not be resolved; otherwise a null value.
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Called when getMapping is complete.
|
||||
* @callback Assets~getMappingCallback
|
||||
* @param assetID {string} hash value if found, else an empty string
|
||||
* @param error {string} error description if the path could not be resolved; otherwise a null value.
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void getMapping(QString path, QScriptValue callback);
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -111,7 +96,10 @@ public:
|
|||
* @param enabled {boolean}
|
||||
* @param callback {}
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* Called when setBakingEnabled is complete.
|
||||
* @callback Assets~setBakingEnabledCallback
|
||||
*/
|
||||
Q_INVOKABLE void setBakingEnabled(QString path, bool enabled, QScriptValue callback);
|
||||
|
||||
#if (PR_BUILD || DEV_BUILD)
|
||||
|
|
@ -122,13 +110,14 @@ public:
|
|||
* Request Asset data from the ATP Server
|
||||
* @function Assets.getAsset
|
||||
* @param {URL|Assets.GetOptions} options An atp: style URL, hash, or relative mapped path; or an {@link Assets.GetOptions} object with request parameters
|
||||
* @param {Assets~getAssetCallback} scope[callback] A scope callback function to receive (error, results) values
|
||||
* @param {Assets~getAssetCallback} scope A scope callback function to receive (error, results) values
|
||||
* @param {function} [callback=undefined]
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
* A set of properties that can be passed to {@link Assets.getAsset}.
|
||||
* @typedef {Object} Assets.GetOptions
|
||||
* @property {URL} [url] an "atp:" style URL, hash, or relative mapped path to fetch
|
||||
* @property {string} [url] an "atp:" style URL, hash, or relative mapped path to fetch
|
||||
* @property {string} [responseType=text] the desired reponse type (text | arraybuffer | json)
|
||||
* @property {boolean} [decompress=false] whether to attempt gunzip decompression on the fetched data
|
||||
* See: {@link Assets.putAsset} and its .compress=true option
|
||||
|
|
@ -144,7 +133,7 @@ public:
|
|||
/**jsdoc
|
||||
* Result value returned by {@link Assets.getAsset}.
|
||||
* @typedef {Object} Assets~getAssetResult
|
||||
* @property {url} [url] the resolved "atp:" style URL for the fetched asset
|
||||
* @property {string} [url] the resolved "atp:" style URL for the fetched asset
|
||||
* @property {string} [hash] the resolved hash for the fetched asset
|
||||
* @property {string|ArrayBuffer|Object} [response] response data (possibly converted per .responseType value)
|
||||
* @property {string} [responseType] response type (text | arraybuffer | json)
|
||||
|
|
@ -160,6 +149,7 @@ public:
|
|||
* @function Assets.putAsset
|
||||
* @param {Assets.PutOptions} options A PutOptions object with upload parameters
|
||||
* @param {Assets~putAssetCallback} scope[callback] A scoped callback function invoked with (error, results)
|
||||
* @param {function} [callback=undefined]
|
||||
*/
|
||||
|
||||
/**jsdoc
|
||||
|
|
@ -180,7 +170,7 @@ public:
|
|||
/**jsdoc
|
||||
* Result value returned by {@link Assets.putAsset}.
|
||||
* @typedef {Object} Assets~putAssetResult
|
||||
* @property {url} [url] the resolved "atp:" style URL for the uploaded asset (based on .path if specified, otherwise on the resulting ATP hash)
|
||||
* @property {string} [url] the resolved "atp:" style URL for the uploaded asset (based on .path if specified, otherwise on the resulting ATP hash)
|
||||
* @property {string} [path] the uploaded asset's resulting ATP path (or undefined if no path mapping was assigned)
|
||||
* @property {string} [hash] the uploaded asset's resulting ATP hash
|
||||
* @property {boolean} [compressed] flag indicating whether the data was compressed before upload
|
||||
|
|
@ -243,7 +233,7 @@ public:
|
|||
/**jsdoc
|
||||
* @function Assets.getCacheStatus
|
||||
* @property {} scope
|
||||
* @property {} [callback = ""]
|
||||
* @property {} [callback=undefined]
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void getCacheStatus(QScriptValue scope, QScriptValue callback = QScriptValue()) {
|
||||
|
|
@ -254,7 +244,7 @@ public:
|
|||
* @function Assets.queryCacheMeta
|
||||
* @property {} options
|
||||
* @property {} scope
|
||||
* @property {} [callback = ""]
|
||||
* @property {} [callback=undefined]
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void queryCacheMeta(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
|
||||
|
|
@ -263,7 +253,7 @@ public:
|
|||
* @function Assets.loadFromCache
|
||||
* @property {} options
|
||||
* @property {} scope
|
||||
* @property {} [callback = ""]
|
||||
* @property {} [callback=undefined]
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void loadFromCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
|
||||
|
|
@ -272,7 +262,7 @@ public:
|
|||
* @function Assets.saveToCache
|
||||
* @property {} options
|
||||
* @property {} scope
|
||||
* @property {} [callback = ""]
|
||||
* @property {} [callback=undefined]
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void saveToCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
|
||||
|
|
@ -283,7 +273,7 @@ public:
|
|||
* @property {} data
|
||||
* @property {} metadata
|
||||
* @property {} scope
|
||||
* @property {} [callback = ""]
|
||||
* @property {} [callback=undefined]
|
||||
*/
|
||||
|
||||
Q_INVOKABLE void saveToCache(const QUrl& url, const QByteArray& data, const QVariantMap& metadata,
|
||||
|
|
|
|||
|
|
@ -31,21 +31,88 @@ protected:
|
|||
AudioScriptingInterface() {}
|
||||
|
||||
// these methods are protected to stop C++ callers from calling, but invokable from script
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.playSound
|
||||
* @param {} sound
|
||||
* @param {} [injectorOptions=null]
|
||||
* @returns {object}
|
||||
*/
|
||||
Q_INVOKABLE ScriptAudioInjector* playSound(SharedSoundPointer sound, const AudioInjectorOptions& injectorOptions = AudioInjectorOptions());
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.playSystemSound
|
||||
* @param {} sound
|
||||
* @param {} position
|
||||
* @returns {object}
|
||||
*/
|
||||
// FIXME: there is no way to play a positionless sound
|
||||
Q_INVOKABLE ScriptAudioInjector* playSystemSound(SharedSoundPointer sound, const QVector3D& position);
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.setStereoInput
|
||||
* @param {boolean} stereo
|
||||
* @returns {boolean}
|
||||
*/
|
||||
Q_INVOKABLE bool setStereoInput(bool stereo);
|
||||
|
||||
/**jsdoc
|
||||
* @function Audio.isStereoInput
|
||||
* @returns {boolean}
|
||||
*/
|
||||
Q_INVOKABLE bool isStereoInput();
|
||||
|
||||
signals:
|
||||
void mutedByMixer(); /// the client has been muted by the mixer
|
||||
void environmentMuted(); /// the entire environment has been muted by the mixer
|
||||
void receivedFirstPacket(); /// the client has received its first packet from the audio mixer
|
||||
void disconnected(); /// the client has been disconnected from the audio mixer
|
||||
void noiseGateOpened(); /// the noise gate has opened
|
||||
void noiseGateClosed(); /// the noise gate has closed
|
||||
void inputReceived(const QByteArray& inputSamples); /// a frame of mic input audio has been received and processed
|
||||
|
||||
/**jsdoc
|
||||
* The client has been muted by the mixer.
|
||||
* @function Audio.mutedByMixer
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void mutedByMixer();
|
||||
|
||||
/**jsdoc
|
||||
* The entire environment has been muted by the mixer.
|
||||
* @function Audio.environmentMuted
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void environmentMuted();
|
||||
|
||||
/**jsdoc
|
||||
* The client has received its first packet from the audio mixer.
|
||||
* @function Audio.receivedFirstPacket
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void receivedFirstPacket();
|
||||
|
||||
/**jsdoc
|
||||
* The client has been disconnected from the audio mixer.
|
||||
* @function Audio.disconnected
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void disconnected();
|
||||
|
||||
/**jsdoc
|
||||
* The noise gate has opened.
|
||||
* @function Audio.noiseGateOpened
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void noiseGateOpened();
|
||||
|
||||
/**jsdoc
|
||||
* The noise gate has closed.
|
||||
* @function Audio.noiseGateClosed
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void noiseGateClosed();
|
||||
|
||||
/**jsdoc
|
||||
* A frame of mic input audio has been received and processed.
|
||||
* @function Audio.inputReceived
|
||||
* @param {} inputSamples
|
||||
* @returns {Signal}
|
||||
*/
|
||||
void inputReceived(const QByteArray& inputSamples);
|
||||
|
||||
private:
|
||||
AbstractAudioInterface* _localAudioInterface { nullptr };
|
||||
|
|
|
|||
|
|
@ -64,29 +64,22 @@ signals:
|
|||
* @function FaceTracker.muteToggled
|
||||
* @returns {Signal}
|
||||
*/
|
||||
|
||||
void muteToggled();
|
||||
|
||||
public slots:
|
||||
|
||||
/**jsdoc
|
||||
* @function FaceTracker.setEnabled
|
||||
* @param {boolean} enabled
|
||||
*/
|
||||
|
||||
// No JSDoc here because it's overridden in DdeFaceTracker.
|
||||
virtual void setEnabled(bool enabled) = 0;
|
||||
|
||||
/**jsdoc
|
||||
* @function FaceTracker.toggleMute
|
||||
*/
|
||||
|
||||
void toggleMute();
|
||||
|
||||
/**jsdoc
|
||||
* @function FaceTracker.getMuted
|
||||
* @returns {boolean}
|
||||
*/
|
||||
|
||||
bool getMuted() { return _isMuted; }
|
||||
|
||||
protected:
|
||||
|
|
|
|||
|
|
@ -47,6 +47,7 @@ exports.handlers = {
|
|||
'../../libraries/script-engine/src',
|
||||
'../../libraries/shared/src',
|
||||
'../../libraries/shared/src/shared',
|
||||
'../../libraries/trackers/src/trackers',
|
||||
'../../libraries/ui/src/ui',
|
||||
'../../plugins/oculus/src',
|
||||
'../../plugins/openvr/src',
|
||||
|
|
|
|||
Loading…
Reference in a new issue