twilio-video 2.21.3 → 2.22.2

package/lib/room.js

@@ -49,6 +49,8 @@ let nInstances = 0;
  * @emits Room#trackSwitchedOn
  * @emits Room#trackUnpublished
  * @emits Room#trackUnsubscribed
+ * @emits Room#trackWarning
+ * @emits Room#trackWarningsCleared
  */
 class Room extends EventEmitter {
   /**
@@ -125,6 +127,7 @@ class Room extends EventEmitter {
       }
     });
 
+    handleLocalParticipantEvents(this, localParticipant);
     handleRecordingEvents(this, signaling.recording);
     handleSignalingEvents(this, signaling);
 
@@ -455,6 +458,42 @@ function rewriteLocalTrackIds(room, trackStats) {
  * });
  */
 
+/**
+ * One of the {@link LocalParticipant}'s {@link LocalTrackPublication}s in the {@link Room} encountered a warning.
+ * This event is only raised if you enabled warnings using <code>notifyWarnings</code> in <code>ConnectOptions</code>.
+ * @param {string} name - The warning that was raised.
+ * @param {LocalTrackPublication} publication - The {@link LocalTrackPublication} that encountered the warning.
+ * @param {LocalParticipant} participant - The {@link LocalParticipant}
+ * @event Room#trackWarning
+ * @example
+ * room.on('trackWarning', (name, publication, participant) => {
+ *   if (name === 'recording-media-lost') {
+ *     log(`LocalTrack ${publication.track.name} is not recording media.`,
+ *       name, publication, participant);
+ *
+ *     // Wait a reasonable amount of time to clear the warning.
+ *     const timer = setTimeout(() => {
+ *       // If the warning is not cleared, you can manually
+ *       // reconnect to the room, or show a dialog to the user
+ *     }, 5000);
+ *
+ *     room.once('trackWarningsCleared', (publication, participant) => {
+ *       log('LocalTrack warnings have cleared!',
+ *         publication, participant);
+ *       clearTimeout(timer);
+ *     });
+ *   }
+});
+ */
+
+/**
+ * One of the {@link LocalParticipant}'s {@link LocalTrackPublication}s in the {@link Room} cleared all warnings.
+ * This event is only raised if you enabled warnings using <code>notifyWarnings</code> in <code>ConnectOptions</code>.
+ * @param {LocalTrackPublication} publication - The {@link LocalTrackPublication} that cleared all warnings.
+ * @param {LocalParticipant} participant - The {@link LocalParticipant}
+ * @event Room#trackWarningsCleared
+ */
+
 function connectParticipant(room, participantSignaling) {
   const { _log: log, _clientTrackSwitchOffControl: clientTrackSwitchOffControl, _contentPreferencesMode: contentPreferencesMode } = room;
   const participant = new RemoteParticipant(participantSignaling, { log, clientTrackSwitchOffControl, contentPreferencesMode });
@@ -509,6 +548,20 @@ function connectParticipant(room, participantSignaling) {
   });
 }
 
+function handleLocalParticipantEvents(room, localParticipant) {
+  const events = ['trackWarning', 'trackWarningsCleared'].map(event => ({
+    eventName: event,
+    handler: (...args) => room.emit(event, ...[...args, localParticipant]),
+  }));
+
+  events.forEach(({ eventName, handler }) =>
+    localParticipant.on(eventName, handler));
+
+  room.once('disconnected', () =>
+    events.forEach(({ eventName, handler }) =>
+      localParticipant.removeListener(eventName, handler)));
+}
+
 function handleRecordingEvents(room, recording) {
   recording.on('updated', function updated() {
     const started = recording.isEnabled;

package/lib/signaling/v2/cancelableroomsignalingpromise.js

@@ -68,6 +68,7 @@ function createCancelableRoomSignalingPromise(token, wsServer, localParticipant,
       name,
       networkMonitor,
       networkQuality,
+      notifyWarnings,
       realm,
       sdpSemantics,
     } = options;
@@ -89,6 +90,7 @@ function createCancelableRoomSignalingPromise(token, wsServer, localParticipant,
       logLevel,
       networkMonitor,
       networkQuality,
+      notifyWarnings,
       iceServers,
       onIced,
       realm,

package/lib/signaling/v2/localparticipant.js

@@ -165,6 +165,20 @@ class LocalParticipantV2 extends LocalParticipantSignaling {
     return this;
   }
 
+  updateMediaStates(mediaStates) {
+    if (!mediaStates || !mediaStates.tracks) {
+      return this;
+    }
+
+    Array.from(this.tracks.values()).forEach(publication => {
+      const states = mediaStates.tracks[publication.sid];
+      if (states) {
+        publication.updateMediaStates(states);
+      }
+    });
+    return this;
+  }
+
   /**
    * @protected
    * @param {DataTrackSender|MediaTrackSender} trackSender
@@ -173,7 +187,7 @@ class LocalParticipantV2 extends LocalParticipantSignaling {
    * @returns {LocalTrackPublicationV2}
    */
   _createLocalTrackPublicationSignaling(trackSender, name, priority) {
-    return new this._LocalTrackPublicationV2(trackSender, name, priority);
+    return new this._LocalTrackPublicationV2(trackSender, name, priority, { log: this._log });
   }
 
   /**

package/lib/signaling/v2/localtrackpublication.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const LocalTrackPublicationSignaling = require('../localtrackpublication');
+const TwilioWarning = require('../../util/twiliowarning');
 const createTwilioError = require('../../util/twilio-video-errors').createTwilioError;
 
 /**
@@ -12,9 +13,19 @@ class LocalTrackPublicationV2 extends LocalTrackPublicationSignaling {
    * @param {DataTrackSender|MediaTrackSender} trackSender
    * @param {string} name
    * @param {Track.Priority} priority
+   * @param {object} [options]
    */
-  constructor(trackSender, name, priority) {
+  constructor(trackSender, name, priority, options) {
     super(trackSender, name, priority);
+    Object.defineProperties(this, {
+      _log: {
+        value: options.log.createLog('default', this)
+      },
+      _mediaStates: {
+        value: { recordings: null },
+        writable: true
+      }
+    });
   }
 
   /**
@@ -31,6 +42,10 @@ class LocalTrackPublicationV2 extends LocalTrackPublicationSignaling {
     };
   }
 
+  toString() {
+    return `[LocalTrackPublicationV2: ${this.sid}]`;
+  }
+
   /**
    * Compare the {@link LocalTrackPublicationV2} to a {@link LocalTrackPublicationV2#Representation} of itself
    * and perform any updates necessary.
@@ -53,6 +68,28 @@ class LocalTrackPublicationV2 extends LocalTrackPublicationSignaling {
     }
     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;
+  }
 }
 
 /**

package/lib/signaling/v2/peerconnection.js

@@ -1851,13 +1851,28 @@ function updateEncodingParameters(pcv2) {
       setMaxBitrate(params, maxBitrate);
     }
 
-    if (!isFirefox && pcv2._enableDscp && params.encodings.length > 0) {
-      // NOTE(mmalavalli): "networkPriority" is a per-sender property and not
-      // a per-encoding-layer property. So, we set the value only on the first
-      // encoding layer. Any attempt to set the value on subsequent encoding
-      // layers (in the case of simulcast) will result in the Promise returned
-      // by RTCRtpSender.setParameters() being rejected.
-      params.encodings[0].networkPriority = 'high';
+    if (!isFirefox && params.encodings.length > 0) {
+      if (sender.track.kind === 'audio') {
+        // NOTE(mmalavalli): "priority" is a per-sender property and not
+        // a per-encoding-layer property. So, we set the value only on the first
+        // encoding layer. Any attempt to set the value on subsequent encoding
+        // layers (in the case of simulcast) will result in the Promise returned
+        // by RTCRtpSender.setParameters() being rejected. With this, audio encoding
+        // is prioritized the most.
+        params.encodings[0].priority = 'high';
+      } else if (pcv2._isChromeScreenShareTrack(sender.track)) {
+        // NOTE(mmalavalli): Screen share encodings are prioritized more than those
+        // of the camera.
+        params.encodings[0].priority = 'medium';
+      }
+      if (pcv2._enableDscp) {
+        // NOTE(mmalavalli): "networkPriority" is a per-sender property and not
+        // a per-encoding-layer property. So, we set the value only on the first
+        // encoding layer. Any attempt to set the value on subsequent encoding
+        // layers (in the case of simulcast) will result in the Promise returned
+        // by RTCRtpSender.setParameters() being rejected.
+        params.encodings[0].networkPriority = 'high';
+      }
     }
 
     // when a sender is reused, delete any active encodings set by server.

package/lib/signaling/v2/room.js

@@ -70,6 +70,10 @@ class RoomV2 extends RoomSignaling {
         value: localParticipant.bandwidthProfileRevision,
         writable: true
       },
+      _mediaStatesWarningsRevision: {
+        value: 0,
+        writable: true
+      },
       _networkQualityMonitor: {
         value: null,
         writable: true
@@ -442,6 +446,12 @@ class RoomV2 extends RoomSignaling {
       }
     });
 
+    if (roomState.type === 'warning' && roomState.states &&
+      roomState.states.revision > this._mediaStatesWarningsRevision) {
+      this._mediaStatesWarningsRevision = roomState.states.revision;
+      this.localParticipant.updateMediaStates(roomState.states);
+    }
+
     return this;
   }
 

package/lib/signaling/v2/twilioconnectiontransport.js

@@ -10,6 +10,7 @@ const { SDK_NAME, SDK_VERSION, SDP_FORMAT } = require('../../util/constants');
 const {
   createBandwidthProfilePayload,
   createMediaSignalingPayload,
+  createMediaWarningsPayload,
   createSubscribePayload,
   getUserAgent,
   isNonArrayObject
@@ -132,6 +133,9 @@ class TwilioConnectionTransport extends StateMachine {
       _networkQuality: {
         value: isNonArrayObject(options.networkQuality) || options.networkQuality
       },
+      _notifyWarnings: {
+        value: options.notifyWarnings
+      },
       _options: {
         value: options
       },
@@ -226,6 +230,11 @@ class TwilioConnectionTransport extends StateMachine {
           this._bandwidthProfile);
       }
 
+      if (this._notifyWarnings) {
+        message.participant.media_warnings = createMediaWarningsPayload(
+          this._notifyWarnings);
+      }
+
       message.media_signaling = createMediaSignalingPayload(
         this._dominantSpeaker,
         this._networkQuality,
@@ -524,6 +533,7 @@ function setupTransport(transport) {
           case 'connected':
           case 'synced':
           case 'update':
+          case 'warning':
             transport.emit('message', message);
             return;
           case 'disconnected':

package/lib/util/index.js

@@ -4,6 +4,7 @@ const constants = require('./constants');
 const { typeErrors: E, trackPriority } = constants;
 const util = require('../webrtc/util');
 const { sessionSID } = require('./sid');
+const TwilioWarning = require('./twiliowarning');
 
 /**
  * Return the given {@link LocalTrack} or a new {@link LocalTrack} for the
@@ -779,6 +780,15 @@ function createSubscribePayload(automaticSubscription) {
   };
 }
 
+function createMediaWarningsPayload(notifyWarnings) {
+  const mediaWarnings = {
+    [TwilioWarning.recordingMediaLost]: 'recordings'
+  };
+  return notifyWarnings
+    .map(twilioWarningName => mediaWarnings[twilioWarningName])
+    .filter(name => !!name);
+}
+
 /**
  * Add random jitter to a given value in the range [-jitter, jitter].
  * @private
@@ -852,6 +862,7 @@ function waitForEvent(eventTarget, event) {
 exports.constants = constants;
 exports.createBandwidthProfilePayload = createBandwidthProfilePayload;
 exports.createMediaSignalingPayload = createMediaSignalingPayload;
+exports.createMediaWarningsPayload = createMediaWarningsPayload;
 exports.createRoomConnectEventPayload = createRoomConnectEventPayload;
 exports.createSubscribePayload = createSubscribePayload;
 exports.asLocalTrack = asLocalTrack;

package/lib/util/support.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const { guessBrowser, support: isWebRTCSupported } = require('../webrtc/util');
+const { getSdpFormat } = require('../webrtc/util/sdp');
 const { isAndroid, isMobile, isNonChromiumEdge, rebrandedChromeBrowser, mobileWebKitBrowser } = require('./browserdetection');
 
 const SUPPORTED_CHROME_BASED_BROWSERS = [
@@ -41,6 +42,7 @@ function isSupported() {
 
   return !!browser
     && isWebRTCSupported()
+    && getSdpFormat() === 'unified'
     && (!rebrandedChrome || SUPPORTED_CHROME_BASED_BROWSERS.includes(rebrandedChrome))
     && !isNonChromiumEdge(browser)
     && (!mobileWebKit || SUPPORTED_MOBILE_WEBKIT_BASED_BROWSERS.includes(mobileWebKit))

package/lib/util/twiliowarning.js

@@ -0,0 +1,13 @@
+'use strict';
+
+/**
+ * @private
+ * Represents a warning encountered when
+ * interacting with one of Twilio's services.
+ */
+// eslint-disable-next-line
+const TwilioWarning = {
+  recordingMediaLost: 'recording-media-lost'
+};
+
+module.exports = TwilioWarning;

package/lib/webrtc/util/sdp.js

@@ -35,6 +35,13 @@ function checkIfSdpSemanticsIsSupported() {
 // instantiation of more than one RTCPeerConnection.
 var chromeSdpFormat = null;
 
+/**
+ * Clear cached Chrome's SDP format
+ */
+function clearChromeCachedSdpFormat() {
+  chromeSdpFormat = null;
+}
+
 /**
  * Get Chrome's default SDP format.
  * @returns {'planb'|'unified'}
@@ -43,12 +50,14 @@ function getChromeDefaultSdpFormat() {
   if (!chromeSdpFormat) {
     if (typeof RTCPeerConnection !== 'undefined'
       && 'addTransceiver' in RTCPeerConnection.prototype) {
+      const pc = new RTCPeerConnection();
       try {
-        new RTCPeerConnection().addTransceiver('audio');
+        pc.addTransceiver('audio');
         chromeSdpFormat = 'unified';
       } catch (e) {
         chromeSdpFormat = 'planb';
       }
+      pc.close();
     } else {
       chromeSdpFormat = 'planb';
     }
@@ -299,6 +308,7 @@ function updateUnifiedPlanTrackIdsToSSRCs(trackIdsToSSRCs, sdp) {
   return updateTrackIdsToSSRCs(getUnifiedPlanTrackIdsToSSRCs, trackIdsToSSRCs, sdp);
 }
 
+exports.clearChromeCachedSdpFormat = clearChromeCachedSdpFormat;
 exports.getSdpFormat = getSdpFormat;
 exports.getMediaSections = getMediaSections;
 exports.getPlanBTrackIds = getPlanBTrackIds;

package/package.json

@@ -2,7 +2,7 @@
   "name": "twilio-video",
   "title": "Twilio Video",
   "description": "Twilio Video JavaScript Library",
-  "version": "2.21.3",
+  "version": "2.22.2",
   "homepage": "https://twilio.com",
   "author": "Mark Andrus Roberts <mroberts@twilio.com>",
   "contributors": [
@@ -99,6 +99,7 @@
     "lint": "npm-run-all lint:js lint:ts",
     "printVersion": "node --version && npm --version",
     "test:unit": "npm-run-all printVersion build:es5 && nyc --report-dir=./coverage --include=lib/**/* --reporter=html --reporter=lcov --reporter=text mocha -r ts-node/register ./test/unit/*",
+    "test:unit:quick": "nyc --report-dir=./coverage --include=lib/**/* --reporter=html --reporter=lcov mocha -r ts-node/register",
     "test:serversiderender": "mocha ./test/serversiderender/index.js",
     "test:integration:adapter": "node ./scripts/karma.js karma/integration.adapter.conf.js",
     "test:integration": "npm run build:es5 && node ./scripts/karma.js karma/integration.conf.js",

package/tsdef/LocalParticipant.d.ts

@@ -31,5 +31,7 @@ export class LocalParticipant extends Participant {
   on(event: 'trackPublished', listener: (publication: LocalTrackPublication) => void): this;
   on(event: 'trackStarted', listener: (track: LocalTrack) => void): this;
   on(event: 'trackStopped', listener: (track: LocalTrack) => void): this;
+  on(event: 'trackWarning', listener: (name: string, publication: LocalTrackPublication) => void): this;
+  on(event: 'trackWarningsCleared', listener: (publication: LocalTrackPublication) => void): this;
   on(event: string, listener: (...args: any[]) => void): this;
 }

package/tsdef/LocalTrackPublication.d.ts

@@ -13,5 +13,7 @@ export class LocalTrackPublication extends TrackPublication {
 
   on(event: 'trackDisabled', listener: () => void): this;
   on(event: 'trackEnabled', listener: () => void): this;
+  on(event: 'warning', listener: (name: string) => void): this;
+  on(event: 'warningsCleared', listener: () => void): this;
   on(event: string, listener: (...args: any[]) => void): this;
 }

package/tsdef/Room.d.ts

@@ -1,6 +1,7 @@
-import { RemoteTrack, StatsReport } from './types';
+import { LocalTrack, RemoteTrack, StatsReport } from './types';
 import { EventEmitter } from 'events';
 import { LocalParticipant } from './LocalParticipant';
+import { LocalTrackPublication } from './LocalTrackPublication';
 import { Participant } from './Participant';
 import { RemoteDataTrack } from './RemoteDataTrack';
 import { RemoteParticipant } from './RemoteParticipant';
@@ -49,4 +50,6 @@ export class Room extends EventEmitter {
   on(event: 'trackSwitchedOn', listener: (track: RemoteTrack, publication: RemoteTrackPublication, participant: RemoteParticipant) => void): this;
   on(event: 'trackUnpublished', listener: (publication: RemoteTrackPublication, participant: RemoteParticipant) => void): this;
   on(event: 'trackUnsubscribed', listener: (track: RemoteTrack, publication: RemoteTrackPublication, participant: RemoteParticipant) => void): this;
+  on(event: 'trackWarning', listener: (name: string, publication: LocalTrackPublication, participant: LocalParticipant) => void): this;
+  on(event: 'trackWarningsCleared', listener: (publication: LocalTrackPublication, participant: LocalParticipant) => void): this;
 }

package/tsdef/twilio-video-tests.ts

@@ -392,6 +392,44 @@ function runPreflight() {
   preflight.stop();
 }
 
+async function mediaWarnings() {
+  let room = await Video.connect('$TOKEN', {
+    notifyWarnings: []
+  });
+  room = await Video.connect('$TOKEN', {
+    notifyWarnings: ['recording-media-lost']
+  });
+
+  room.localParticipant.tracks.forEach((publication: Video.LocalTrackPublication) => {
+    publication.on('warning', (name: string) => {
+      // eslint-disable-next-line no-console
+      console.log(name);
+    });
+    publication.on('warningsCleared', () => {
+      // eslint-disable-next-line no-console
+      console.log('warningsCleared');
+    });
+  });
+  room.localParticipant.on('trackWarning', (name: string, publication: Video.LocalTrackPublication) => {
+    // eslint-disable-next-line no-console
+    console.log(name, publication);
+  });
+  room.localParticipant.on('trackWarningsCleared', (publication: Video.LocalTrackPublication) => {
+    // eslint-disable-next-line no-console
+    console.log('warningsCleared', publication);
+  });
+
+  room.on('trackWarning', (name: string, publication: Video.LocalTrackPublication, participant: Video.LocalParticipant) => {
+    // eslint-disable-next-line no-console
+    console.log(name, publication, participant);
+  });
+  room.on('trackWarningsCleared', (publication: Video.LocalTrackPublication, participant: Video.LocalParticipant) => {
+    // eslint-disable-next-line no-console
+    console.log('warningsCleared', publication, participant);
+  });
+}
+
 initRoom();
 unpublishTracks();
 runPreflight();
+mediaWarnings();

package/tsdef/types.d.ts

@@ -98,6 +98,8 @@ export type BandwidthProfileMode = 'grid' | 'collaboration' | 'presentation';
 export type VideoContentPreferencesMode = 'auto' | 'manual';
 export type ClientTrackSwitchOffControl = 'auto' | 'manual';
 
+export type NotifyWarning = 'recording-media-lost';
+
 /**
 * @deprecated
 */
@@ -188,6 +190,7 @@ export interface ConnectOptions {
   maxVideoBitrate?: number | null;
   name?: string | null;
   networkQuality?: boolean | NetworkQualityConfiguration;
+  notifyWarnings?: Array<NotifyWarning>;
   region?: string;
   preferredAudioCodecs?: Array<AudioCodec | AudioCodecSettings | OpusCodecSettings>;
   preferredVideoCodecs?: Array<VideoCodec | VideoCodecSettings | VP8CodecSettings> | VideoEncodingMode;