twilio-video/lib/signaling/v2/localtrackpublication.js

Twilio Video JavaScript Library

'use strict';

const LocalTrackPublicationSignaling = require('../localtrackpublication');
const TwilioWarning = require('../../util/twiliowarning');
const createTwilioError = require('../../util/twilio-video-errors').createTwilioError;

/**
 * @extends LocalTrackPublicationSignaling
 */
class LocalTrackPublicationV2 extends LocalTrackPublicationSignaling {
  /**
   * Construct a {@link LocalTrackPublicationV2}.
   * @param {DataTrackSender|MediaTrackSender} trackSender
   * @param {string} name
   * @param {Track.Priority} priority
   * @param {?NoiseCancellationVendor} noiseCancellationVendor
   * @param {object} [options]
   */
  constructor(trackSender, name, priority, noiseCancellationVendor, options) {
    super(trackSender, name, priority);

    Object.defineProperties(this, {
      _log: {
        value: options.log.createLog('default', this)
      },
      _mediaStates: {
        value: { recordings: null },
        writable: true
      },
      _noiseCancellationVendor: {
        value: noiseCancellationVendor,
      }
    });
  }

  /**
   * Get the {@link LocalTrackPublicationV2#Representation} of a given {@link TrackSignaling}.
   * @returns {LocalTrackPublicationV2#Representation} - without the SID
   */
  getState() {
    const state = {
      enabled: this.isEnabled,
      id: this.id,
      kind: this.kind,
      name: this.name,
      priority: this.updatedPriority,
    };

    if (this._noiseCancellationVendor) {
      // eslint-disable-next-line camelcase
      state.audio_processor = this._noiseCancellationVendor;
    }
    return state;
  }

  toString() {
    return `[LocalTrackPublicationV2: ${this.sid}]`;
  }

  /**
   * Compare the {@link LocalTrackPublicationV2} to a {@link LocalTrackPublicationV2#Representation} of itself
   * and perform any updates necessary.
   * @param {PublishedTrack} track
   * @returns {this}
   * @fires TrackSignaling#updated
   */
  update(track) {
    switch (track.state) {
      case 'ready':
        this.setSid(track.sid);
        break;
      case 'failed': {
        const error = track.error;
        this.publishFailed(createTwilioError(error.code, error.message));
        break;
      }
      default: // 'created'
        break;
    }
    return this;
  }

  updateMediaStates(mediaStates) {
    if (!mediaStates || !mediaStates.recordings ||
      this._mediaStates.recordings === mediaStates.recordings) {
      return this;
    }
    this._mediaStates.recordings = mediaStates.recordings;
    switch (this._mediaStates.recordings) {
      case 'OK':
        this._log.info('Warnings have cleared.');
        this.emit('warningsCleared');
        break;
      case 'NO_MEDIA':
        this._log.warn('Recording media lost.');
        this.emit('warning', TwilioWarning.recordingMediaLost);
        break;
      default:
        this._log.warn(`Unknown media state detected: ${this._mediaStates.recordings}`);
        break;
    }
    return this;
  }
}

/**
 * The Room Signaling Protocol (RSP) representation of a {@link LocalTrackPublicationV2}.
 * @typedef {object} LocalTrackPublicationV2#Representation
 * @property {boolean} enabled
 * @property {Track.ID} id
 * @property {Track.Kind} kind
 * @property {string} name
 * @priority {Track.Priority} priority
 * @property {Track.SID} sid
 */

module.exports = LocalTrackPublicationV2;