twilio-video/lib/stats/networkqualitystats.js

Twilio Video JavaScript Library

'use strict';

const NetworkQualityAudioStats = require('./networkqualityaudiostats');
const NetworkQualityVideoStats = require('./networkqualityvideostats');

/**
 * Network quality statistics for a {@link Participant}.
 * @property {NetworkQualityLevel} level - {@link NetworkQualityLevel} of the {@link Participant}
 * @property {?NetworkQualityAudioStats} audio - {@link NetworkQualityMediaStats}
 *   for audio; <code>null</code> if {@link NetworkQualityVerbosity} is {@link NetworkQualityVerbosity}<code style="padding:0 0">#minimal</code>
 *   or below
 * @property {?NetworkQualityVideoStats} video - {@link NetworkQualityMediaStats}
 *   for video; <code>null</code> if {@link NetworkQualityVerbosity} is {@link NetworkQualityVerbosity}<code style="padding:0 0">#minimal</code>
 *   or below
 */
class NetworkQualityStats {
  /**
   * Construct a {@link NetworkQualityStats}.
   * @param {NetworkQualityLevels} networkQualityLevels
   */
  constructor({ level, audio, video }) {
    Object.defineProperties(this, {
      level: {
        value: level,
        enumerable: true
      },
      audio: {
        value: audio ? new NetworkQualityAudioStats(audio) : null,
        enumerable: true
      },
      video: {
        value: video ? new NetworkQualityVideoStats(video) : null,
        enumerable: true
      }
    });
  }
}

module.exports = NetworkQualityStats;