@webex/plugin-meetings 3.0.0-beta.1 → 3.0.0-beta.104

package/src/media/index.js

@@ -1,593 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-/* globals navigator */
-
-import LoggerProxy from '../common/logs/logger-proxy';
-import {
-  AUDIO_INPUT,
-  VIDEO_INPUT,
-  PEER_CONNECTION_STATE,
-  MEDIA_TRACK_CONSTRAINT
-} from '../constants';
-import Config from '../config';
-import PeerConnectionManager from '../peer-connection-manager';
-import ReconnectionError from '../common/errors/reconnection';
-import MediaError from '../common/errors/media';
-import BrowserDetection from '../common/browser-detection';
-
-const {isBrowser} = BrowserDetection();
-
-/**
- * MediaDirection
- * @typedef {Object} MediaDirection
- * @property {boolean} sendAudio
- * @property {boolean} receiveAudio
- * @property {boolean} sendVideo
- * @property {boolean} receiveVideo
- * @property {boolean} sendShare
- * @property {boolean} receiveShare
- */
-
-/**
- * SendOptions
- * @typedef {Object} SendOptions
- * @property sendAudio
- * @property sendVideo
- * @property sendShare
- * @property isSharing
- * @property {Object} sharePreferences
- */
-/**
- *
- * @public
- * @export
- * Mimic browser APIs as "the ultimate browser".
- * Handles the quirks of each browser.
- * Extends and enhances adapter.js, i.e., the "media" file from the web client.
- */
-const Media = {};
-
-/**
- * @param {boolean} enabled
- * @param {MediaStreamTrack} track
- * @returns {Boolean}
- * @public
- */
-Media.setLocalTrack = (enabled, track) => {
-  if (track) {
-    track.enabled = enabled;
-
-    return true;
-  }
-
-  return false;
-};
-
-/**
- * @param {RTCPeerConnection} peerConnection
- * @param {Object} meetingProperties
- * @param {string} meetingProperties.meetingId
- * @param {string} meetingProperties.remoteQualityLevel LOW|MEDIUM|HIGH
- * @returns {Promise}
- */
-Media.reconnectMedia = (peerConnection, {
-  meetingId,
-  remoteQualityLevel,
-  enableRtx,
-  enableExtmap
-}) => {
-  if (peerConnection.connectionState === PEER_CONNECTION_STATE.CLOSED ||
-    peerConnection.connectionState === PEER_CONNECTION_STATE.FAILED) {
-    return Promise.reject(new ReconnectionError('Reinitiate peerconnection'));
-  }
-
-  return PeerConnectionManager.createOffer(peerConnection, {
-    meetingId,
-    remoteQualityLevel,
-    enableRtx,
-    enableExtmap
-  });
-};
-
-/**
- * format the media array for send
- * @param {String} mediaId
- * @param {Boolean} audioMuted
- * @param {Boolean} videoMuted
- * @returns {Array} medias
- */
-Media.generateLocalMedias = (mediaId, audioMuted, videoMuted) => {
-  if (mediaId) {
-    return [
-      {
-        localSdp: JSON.stringify({
-          audioMuted,
-          videoMuted
-        }),
-        mediaId
-      }
-    ];
-  }
-
-  return [];
-};
-
-/**
- * make a browser call to get the media
- * @param {SendOptions} options
- * @param {Object} config SDK Configuration for meetings plugin
- * @returns {Promise}
- */
-Media.getLocalMedia = (options, config) => {
-  const {
-    sendAudio, sendVideo, sendShare, sharePreferences, isSharing
-  } = options;
-
-  if (sendAudio || sendVideo) {
-    return Media.getMedia(sendAudio, sendVideo, config);
-  }
-
-  if (sendShare && !isSharing) {
-    return Media.getDisplayMedia(
-      {
-        sendAudio: false,
-        sendShare: true,
-        sharePreferences
-      },
-      config
-    );
-  }
-
-  return Promise.resolve(undefined);
-};
-/**
- * Returns the direction and tracks
- * @param {string} trackType type of track (audio/video)
- * @param {object}  track  tracks passed
- * @param {boolean} receiveTracks do you want to receive tracks from the remote side
- * @returns {Object} returns direction tracks to be added in transceiver
- */
-Media.checkTracks = (trackType, track, receiveTracks) => {
-  const getDirection = (sendTracks, receiveTracks) => {
-    if (sendTracks && receiveTracks) {
-      return 'sendrecv';
-    } if (sendTracks && !receiveTracks) {
-      return 'sendonly';
-    } if (!sendTracks && receiveTracks) {
-      return 'recvonly';
-    }
-
-    return 'inactive';
-  };
-
-  if (track) {
-    return {track, direction: getDirection(!!track, receiveTracks)};
-  }
-
-  return {track: trackType, direction: getDirection(!!track, receiveTracks)};
-};
-/**
- * creates peerconnection and attaches streams
- * @param {MediaDirection} mediaProperties
- * @param {Object} meetingProperties
- * @param {string} meetingProperties.meetingId
- * @param {string} meetingProperties.remoteQualityLevel LOW|MEDIUM|HIGH
- * @returns {Array} [peerConnection, ]
- */
-Media.attachMedia = (mediaProperties, {
-  meetingId,
-  remoteQualityLevel,
-  enableRtx,
-  enableExtmap
-}) => {
-  const {
-    mediaDirection,
-    audioTrack,
-    videoTrack,
-    shareTrack,
-    peerConnection
-  } = mediaProperties;
-
-  let result = null;
-
-  // Add Transceiver for audio
-  result = Media.checkTracks('audio', mediaDirection.sendAudio && audioTrack, mediaDirection.receiveAudio);
-  peerConnection.audioTransceiver = peerConnection.addTransceiver(result.track, {direction: result.direction});
-
-  // Add Transceiver for video
-  result = Media.checkTracks('video', mediaDirection.sendVideo && videoTrack, mediaDirection.receiveVideo);
-  peerConnection.videoTransceiver = peerConnection.addTransceiver(result.track, {direction: result.direction});
-
-  // Add Transceiver for share
-  result = Media.checkTracks('video', mediaDirection.sendShare && shareTrack, mediaDirection.receiveShare);
-  peerConnection.shareTransceiver = peerConnection.addTransceiver(result.track, {direction: result.direction});
-
-  peerConnection.onnegotiationneeded = (event) => {
-    LoggerProxy.logger.info(`Media:index#attachMedia --> onnegotiationneeded#PeerConnection: ${event}`);
-  };
-
-  return PeerConnectionManager.createOffer(peerConnection, {
-    meetingId,
-    remoteQualityLevel,
-    enableRtx,
-    enableExtmap
-  });
-};
-
-/**
- * updates all the media streams and creates a new media offer
- * @param {MediaDirection} mediaProperties
- * @param {Object} meetingProperties
- * @param {string} meetingProperties.meetingId
- * @param {string} meetingProperties.remoteQualityLevel LOW|MEDIUM|HIGH
- * @returns {Promise}
- */
-Media.updateMedia = (mediaProperties, {
-  meetingId,
-  remoteQualityLevel,
-  enableRtx,
-  enableExtmap
-}) => {
-  const {
-    mediaDirection,
-    audioTrack,
-    videoTrack,
-    shareTrack,
-    peerConnection
-  } = mediaProperties;
-
-  // update audio transceiver
-  Media.setTrackOnTransceiver(peerConnection.audioTransceiver, {
-    type: 'audio',
-    track: audioTrack,
-    sendTrack: mediaDirection.sendAudio && audioTrack,
-    receiveTrack: mediaDirection.receiveAudio
-  });
-
-  // update video transceiver
-  Media.setTrackOnTransceiver(peerConnection.videoTransceiver, {
-    type: 'video',
-    track: videoTrack,
-    sendTrack: mediaDirection.sendVideo && videoTrack,
-    receiveTrack: mediaDirection.receiveVideo
-  });
-
-  // update content transceiver
-  Media.setTrackOnTransceiver(peerConnection.shareTransceiver, {
-    type: 'video',
-    track: shareTrack,
-    sendTrack: mediaDirection.sendShare && shareTrack,
-    receiveTrack: mediaDirection.receiveShare
-  });
-  peerConnection.onnegotiationneeded = (event) => {
-    LoggerProxy.logger.info(`Media:index#updateMedia --> onnegotiationneeded#PeerConnection: ${event}`);
-  };
-
-  return PeerConnectionManager.createOffer(peerConnection, {
-    meetingId,
-    remoteQualityLevel,
-    enableRtx,
-    enableExtmap
-  });
-};
-
-/**
- * @param {RTCRtpTransceiver} transceiver
- * @param {Object} options
- * @param {MediaStreamTrack} options.track
- * @returns {undefined}
- */
-Media.setTrackOnTransceiver = (transceiver, options) => {
-  const {
-    type, track, sendTrack, receiveTrack
-  } = options;
-
-  try {
-    const result = Media.checkTracks(type, sendTrack && track, receiveTrack);
-
-    transceiver.direction = result.direction;
-    if (options.track) {
-      transceiver.sender.replaceTrack(track);
-    }
-  }
-  catch (e) {
-    LoggerProxy.logger.error(`Media:index#setTrackOnTransceiver --> ${e}`);
-    throw e;
-  }
-};
-
-/**
- * creates a new offer
- * @param {Object} meetingProperties
- * @param {string} meetingProperties.meetingId
- * @param {string} meetingProperties.remoteQualityLevel LOW|MEDIUM|HIGH
- * @param {RTCPeerConnection} peerConnection
- * @param {RTCRtpTransceiver} transceiver
- * @param {Object} options see #Media.setTrackOnTransceiver
- * @returns {Promise}
- */
-Media.updateTransceiver = ({
-  meetingId,
-  remoteQualityLevel,
-  enableRtx,
-  enableExtmap
-}, peerConnection, transceiver, options) => {
-  Media.setTrackOnTransceiver(transceiver, options);
-
-  return PeerConnectionManager.createOffer(peerConnection, {
-    meetingId,
-    remoteQualityLevel,
-    enableRtx,
-    enableExtmap
-  });
-};
-
-/**
- * generates share streams
- * @param {Object} options parameter
- * @param {Boolean} options.sendAudio send audio from the display share
- * @param {Boolean} options.sendShare send video from the display share
- * @param {Object} options.sharePreferences
- * @param {MediaTrackConstraints} options.sharePreferences.shareConstraints constraints to apply to video
- *   @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints}
- * @param {Boolean} options.sharePreferences.highFrameRate if shareConstraints isn't provided, set default values based off of this boolean
- * @param {Object} config SDK Configuration for meetings plugin
- * @returns {Promise.<MediaStream>}
- */
-Media.getDisplayMedia = (options, config = {}) => {
-  // SDK screen share resolution settings from Webex.init
-  const customResolution = config.screenResolution || {};
-  // user defined screen share frame rate
-  const customShareFrameRate = config.screenFrameRate || null;
-  // user defined share preferences
-  const hasSharePreferences = options.sharePreferences;
-  const hasCustomConstraints = hasSharePreferences && hasSharePreferences.shareConstraints;
-  const hasHighFrameRate = hasSharePreferences && hasSharePreferences.highFrameRate;
-  const {
-    screenResolution,
-    resolution,
-    videoShareFrameRate,
-    screenFrameRate,
-    aspectRatio
-  } = Config.meetings;
-
-  let shareConstraints = {
-    cursor: MEDIA_TRACK_CONSTRAINT.CURSOR.AWLAYS,
-    aspectRatio
-  };
-
-  if (hasCustomConstraints) {
-    shareConstraints = hasSharePreferences.shareConstraints;
-  }
-  else if (hasHighFrameRate) {
-    shareConstraints = {
-      ...shareConstraints,
-      frameRate: videoShareFrameRate,
-      height: resolution.idealHeight,
-      width: resolution.idealWidth,
-      ...config.resolution
-    };
-  }
-  else {
-    shareConstraints = {
-      ...shareConstraints,
-      frameRate: customShareFrameRate || screenFrameRate,
-      height: customResolution.idealHeight || screenResolution.idealHeight,
-      width: customResolution.idealWidth || screenResolution.idealWidth,
-      ...config.screenResolution
-    };
-  }
-
-  // chrome and webkit based browsers (edge, safari) automatically adjust everything
-  // and we have noticed higher quality with those browser types
-  // firefox specifically has some issues with resolution and frame rate decision making
-  // so we are making it optional and configurable (with defaults) for firefox
-  // to have higher quality, and for developers to control the values
-  // eventually we may have to add the same functionality to chrome, OR conversely, get to with firefox
-
-
-  if (isBrowser('firefox')) {
-    const mediaConfig = {
-      audio: options.sendAudio,
-      video: options.sendShare
-    };
-
-
-    return navigator.mediaDevices.getDisplayMedia({audio: options.sendAudio, video: mediaConfig})
-      .then((stream) => {
-        if (options.sendShare && stream.getVideoTracks().length > 0) {
-          // Firefox has a bug with the spec where changing in the height and width only happens
-          // after we get the inital tracks
-          // https://bugzilla.mozilla.org/show_bug.cgi?id=1321221
-          stream.getVideoTracks()[0].applyConstraints(shareConstraints);
-        }
-
-
-        return stream;
-      });
-  }
-
-  const getDisplayMediaParams = {video: options.sendShare ? shareConstraints : false};
-
-  // safari doesn't support sending screen share audio
-  // https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia
-  if (options.sendAudio && isBrowser('safari')) {
-    getDisplayMediaParams.audio = options.sendAudio;
-  }
-
-  return navigator.mediaDevices.getDisplayMedia(getDisplayMediaParams);
-};
-
-/**
- * generates audio and video using constraints (often called after getSupportedDevices)
- * @param {Object|Boolean} audio gum constraints
- * @param {Object|Boolean} video gum constraints
- * @param {Object} config SDK Configuration for meetings plugin
- * @returns {Object} {streams}
- */
-Media.getMedia = (audio, video, config) => {
-  const defaultWidth = {ideal: config.resolution.idealWidth, max: config.resolution.maxWidth};
-  const defaultHeight = {ideal: config.resolution.idealHeight, max: config.resolution.maxHeight};
-  const mediaConfig = {
-    audio,
-    // TODO: Remove temporary workaround once Firefox fixes low constraint issues
-    // eslint-disable-next-line no-nested-ternary
-    video: video ?
-      isBrowser('firefox') && video.width && video.width.max === 320 ?
-        {
-          deviceId: video.deviceId ? video.deviceId : undefined,
-          width: 320,
-          height: 180
-        } :
-        {
-          deviceId: video.deviceId ? video.deviceId : undefined,
-          width: video.width ? video.width : defaultWidth,
-          height: video.height ? video.height : defaultHeight
-        } :
-      false,
-    fake: process.env.NODE_ENV === 'test' // Special case to get fake media for Firefox browser for testing
-  };
-
-  return navigator.mediaDevices
-    .getUserMedia(mediaConfig)
-    .catch((err) => {
-      const logPath = 'Media:index#getMedia --> navigator.mediaDevices.getUserMedia';
-
-      LoggerProxy.logger.error(`${logPath} failed - ${err} (${err.constraint})`);
-      throw err;
-    });
-};
-
-/**
- * Checks if the machine has at least one audio or video device (Dont use this for screen share)
- * @param {object} [options]
- * {
- *    sendAudio: true/false,
- *    sendVideo: true/false
- * }
- * @returns {Object} {
- *    sendAudio: true/false,
- *    sendVideo: true/false
- *}
- */
-Media.getSupportedDevice = ({sendAudio, sendVideo}) =>
-  Promise.resolve().then(() => {
-    if (!navigator.mediaDevices || navigator.mediaDevices.enumerateDevices === undefined) {
-      return {
-        sendAudio: false,
-        sendVideo: false
-      };
-    }
-
-    return navigator.mediaDevices.enumerateDevices().then((devices) => {
-      const supported = {
-        audio: devices.filter((device) => device.kind === AUDIO_INPUT).length > 0,
-        video: devices.filter((device) => device.kind === VIDEO_INPUT).length > 0
-      };
-
-      return {
-        sendAudio: supported.audio && sendAudio,
-        sendVideo: supported.video && sendVideo
-      };
-    });
-  });
-
-/**
- * proxy to browser navigator.mediaDevices.enumerateDevices()
- * @returns {Promise}
- */
-Media.getDevices = () => {
-  if (navigator && navigator.mediaDevices && navigator.mediaDevices.enumerateDevices) {
-    return navigator.mediaDevices.enumerateDevices();
-  }
-
-  return Promise.reject(new MediaError('enumerateDevices not supported.'));
-};
-
-/**
- *
- * Toggle a specific stream
- * noop as of now, does nothing
- * @returns {null}
- */
-Media.toggleStream = () => {};
-
-/**
- * Stop input stream
- * @param {MediaTrack} track A media stream
- * @returns {null}
- */
-Media.stopTracks = (track) => {
-  if (!track) {
-    return Promise.resolve();
-  }
-
-  return Promise.resolve().then(() => {
-    if (track && track.stop) {
-      try {
-        track.stop();
-      }
-      catch (e) {
-        LoggerProxy.logger.error(`Media:index#stopTracks --> Unable to stop the track with state ${track.readyState}, error: ${e}`);
-      }
-    }
-  });
-};
-
-/**
- *
- * Stop input stream
- * @param {Stream} stream A media stream
- * @returns {null}
- * @deprecated after v1.89.3
- */
-Media.stopStream = (stream) => {
-  LoggerProxy.logger.warn('Media:index#stopStream --> [DEPRECATION WARNING]: stopStream has been deprecated after v1.89.3');
-  if (!stream) {
-    return Promise.resolve();
-  }
-
-  /*
-   * To release local media
-   * 1) Chrome requires all tracks to be stopped (stream.stop got deprecated)
-   * 2) Firefox requires the stream to be stopped
-   */
-  return Promise.resolve().then(() => {
-    if (stream.getTracks) {
-      stream.getTracks().forEach((track) => {
-        track.stop();
-      });
-    }
-    else if (stream.stop) {
-      stream.stop();
-    }
-  });
-};
-
-/**
- * generates streams for audio video and share
- * @param {object} mediaSetting parameter
- * @param {Object} mediaSetting.sendAudio sendAudio: {Boolean} sendAudio constraints
- * @param {Object} mediaSetting.sendVideo sendVideo: {Boolean} sendVideo constraints
- * @param {Object} mediaSetting.sendShare sendShare: {Boolean} sendShare constraints
- * @param {Object} mediaSetting.isSharing isSharing: {Boolean} isSharing constraints
- * @param {Object} audioVideo parameter
- * @param {Object} audioVideo.audio {deviceId: {String}}
- * @param {Object} audioVideo.video {deviceId: {String}}
- * @param {Object} sharePreferences parameter
- * @param {Object} sharePreferences.shareConstraints parameter
- * @param {Boolean} sharePreferences.highFrameRate parameter
- * @param {Object} config SDK Config
- * @returns {Array} [localStream, shareStream]
- */
-Media.getUserMedia = (mediaSetting, audioVideo, sharePreferences, config) => Media.getLocalMedia({
-  sendAudio: mediaSetting.sendAudio ? audioVideo.audio || mediaSetting.sendAudio : false,
-  sendVideo: mediaSetting.sendVideo ? audioVideo.video || mediaSetting.sendVideo : false
-}, config).then((localStream) => Media.getLocalMedia({
-  sendShare: mediaSetting.sendShare,
-  isSharing: mediaSetting.isSharing,
-  sharePreferences
-}, config).then((shareStream) => [localStream, shareStream]));
-
-export default Media;

package/src/media/util.js

@@ -1,38 +0,0 @@
-/* globals MediaStream */
-import window from 'global/window';
-
-import BrowserDetection from '../common/browser-detection';
-import LoggerProxy from '../common/logs/logger-proxy';
-
-const {isBrowser} = BrowserDetection();
-
-const MediaUtil = {};
-
-MediaUtil.createPeerConnection = (turnServerInfo) => {
-  const config = {iceServers: []};
-
-  if (turnServerInfo) {
-    config.iceServers.push({
-      urls: turnServerInfo.url,
-      username: turnServerInfo.username || '',
-      credential: turnServerInfo.password || ''
-    });
-  }
-  if (isBrowser('firefox')) {
-    config.bundlePolicy = 'max-compat';
-  }
-
-  return new window.RTCPeerConnection(config);
-};
-
-
-MediaUtil.createMediaStream = (tracks) => {
-  if (!tracks) {
-    LoggerProxy.logger.error('Media:util#createMediaStream --> Tracks don\'t exist');
-  }
-  const filtredTracks = tracks.filter((element) => !!element);
-
-  return new MediaStream(filtredTracks);
-};
-
-export default MediaUtil;