選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

RTC.js 30KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957
  1. /* global __filename */
  2. import { getLogger } from 'jitsi-meet-logger';
  3. import * as JitsiConferenceEvents from '../../JitsiConferenceEvents';
  4. import * as MediaType from '../../service/RTC/MediaType';
  5. import RTCEvents from '../../service/RTC/RTCEvents';
  6. import VideoType from '../../service/RTC/VideoType';
  7. import browser from '../browser';
  8. import Statistics from '../statistics/statistics';
  9. import GlobalOnErrorHandler from '../util/GlobalOnErrorHandler';
  10. import Listenable from '../util/Listenable';
  11. import { safeCounterIncrement } from '../util/MathUtil';
  12. import BridgeChannel from './BridgeChannel';
  13. import JitsiLocalTrack from './JitsiLocalTrack';
  14. import RTCUtils from './RTCUtils';
  15. import TraceablePeerConnection from './TraceablePeerConnection';
  16. const logger = getLogger(__filename);
  17. /**
  18. * The counter used to generated id numbers assigned to peer connections
  19. * @type {number}
  20. */
  21. let peerConnectionIdCounter = 0;
  22. /**
  23. * The counter used to generate id number for the local
  24. * <code>MediaStreamTrack</code>s.
  25. * @type {number}
  26. */
  27. let rtcTrackIdCounter = 0;
  28. /**
  29. *
  30. * @param tracksInfo
  31. * @param options
  32. */
  33. function createLocalTracks(tracksInfo, options) {
  34. const newTracks = [];
  35. let deviceId = null;
  36. tracksInfo.forEach(trackInfo => {
  37. if (trackInfo.mediaType === MediaType.AUDIO) {
  38. deviceId = options.micDeviceId;
  39. } else if (trackInfo.videoType === VideoType.CAMERA) {
  40. deviceId = options.cameraDeviceId;
  41. }
  42. rtcTrackIdCounter = safeCounterIncrement(rtcTrackIdCounter);
  43. const localTrack = new JitsiLocalTrack({
  44. ...trackInfo,
  45. deviceId,
  46. facingMode: options.facingMode,
  47. rtcId: rtcTrackIdCounter,
  48. effects: options.effects
  49. });
  50. newTracks.push(localTrack);
  51. });
  52. return newTracks;
  53. }
  54. /**
  55. * Creates {@code JitsiLocalTrack} instances from the passed in meta information
  56. * about MedieaTracks.
  57. *
  58. * @param {Object[]} mediaStreamMetaData - An array of meta information with
  59. * MediaTrack instances. Each can look like:
  60. * {{
  61. * stream: MediaStream instance that holds a track with audio or video,
  62. * track: MediaTrack within the MediaStream,
  63. * videoType: "camera" or "desktop" or falsy,
  64. * sourceId: ID of the desktopsharing source,
  65. * sourceType: The desktopsharing source type,
  66. * effects: Array of effect types
  67. * }}
  68. */
  69. function _newCreateLocalTracks(mediaStreamMetaData = []) {
  70. return mediaStreamMetaData.map(metaData => {
  71. const {
  72. sourceId,
  73. sourceType,
  74. stream,
  75. track,
  76. videoType,
  77. effects
  78. } = metaData;
  79. const { deviceId, facingMode } = track.getSettings();
  80. // FIXME Move rtcTrackIdCounter to a static method in JitsiLocalTrack
  81. // so RTC does not need to handle ID management. This move would be
  82. // safer to do once the old createLocalTracks is removed.
  83. rtcTrackIdCounter = safeCounterIncrement(rtcTrackIdCounter);
  84. return new JitsiLocalTrack({
  85. deviceId,
  86. facingMode,
  87. mediaType: track.kind,
  88. rtcId: rtcTrackIdCounter,
  89. sourceId,
  90. sourceType,
  91. stream,
  92. track,
  93. videoType: videoType || null,
  94. effects
  95. });
  96. });
  97. }
  98. /**
  99. *
  100. */
  101. export default class RTC extends Listenable {
  102. /**
  103. *
  104. * @param conference
  105. * @param options
  106. */
  107. constructor(conference, options = {}) {
  108. super();
  109. this.conference = conference;
  110. /**
  111. * A map of active <tt>TraceablePeerConnection</tt>.
  112. * @type {Map.<number, TraceablePeerConnection>}
  113. */
  114. this.peerConnections = new Map();
  115. this.localTracks = [];
  116. this.options = options;
  117. // BridgeChannel instance.
  118. // @private
  119. // @type {BridgeChannel}
  120. this._channel = null;
  121. /**
  122. * The value specified to the last invocation of setLastN before the
  123. * channel completed opening. If non-null, the value will be sent
  124. * through a channel (once) as soon as it opens and will then be
  125. * discarded.
  126. * @private
  127. * @type {number}
  128. */
  129. this._lastN = -1;
  130. /**
  131. * Defines the last N endpoints list. It can be null or an array once
  132. * initialised with a channel last N event.
  133. * @type {Array<string>|null}
  134. * @private
  135. */
  136. this._lastNEndpoints = null;
  137. /*
  138. * Holds the sender video constraints signaled from the bridge.
  139. */
  140. this._senderVideoConstraints = {};
  141. /**
  142. * The number representing the maximum video height the local client
  143. * should receive from the bridge.
  144. *
  145. * @type {number|undefined}
  146. * @private
  147. */
  148. this._maxFrameHeight = undefined;
  149. /**
  150. * The endpoint IDs of currently selected participants.
  151. *
  152. * @type {Array}
  153. * @private
  154. */
  155. this._selectedEndpoints = [];
  156. // The last N change listener.
  157. this._lastNChangeListener = this._onLastNChanged.bind(this);
  158. this._onDeviceListChanged = this._onDeviceListChanged.bind(this);
  159. this._updateAudioOutputForAudioTracks
  160. = this._updateAudioOutputForAudioTracks.bind(this);
  161. // Switch audio output device on all remote audio tracks. Local audio
  162. // tracks handle this event by themselves.
  163. if (RTCUtils.isDeviceChangeAvailable('output')) {
  164. RTCUtils.addListener(
  165. RTCEvents.AUDIO_OUTPUT_DEVICE_CHANGED,
  166. this._updateAudioOutputForAudioTracks
  167. );
  168. RTCUtils.addListener(
  169. RTCEvents.DEVICE_LIST_CHANGED,
  170. this._onDeviceListChanged
  171. );
  172. }
  173. }
  174. /**
  175. * Removes any listeners and stored state from this {@code RTC} instance.
  176. *
  177. * @returns {void}
  178. */
  179. destroy() {
  180. RTCUtils.removeListener(
  181. RTCEvents.AUDIO_OUTPUT_DEVICE_CHANGED,
  182. this._updateAudioOutputForAudioTracks
  183. );
  184. RTCUtils.removeListener(
  185. RTCEvents.DEVICE_LIST_CHANGED,
  186. this._onDeviceListChanged
  187. );
  188. this.removeListener(
  189. RTCEvents.LASTN_ENDPOINT_CHANGED,
  190. this._lastNChangeListener
  191. );
  192. if (this._channelOpenListener) {
  193. this.removeListener(
  194. RTCEvents.DATA_CHANNEL_OPEN,
  195. this._channelOpenListener
  196. );
  197. }
  198. }
  199. /**
  200. * Exposes the private helper for converting a WebRTC MediaStream to a
  201. * JitsiLocalTrack.
  202. *
  203. * @param {Array<Object>} tracksInfo
  204. * @returns {Array<JitsiLocalTrack>}
  205. */
  206. static newCreateLocalTracks(tracksInfo) {
  207. return _newCreateLocalTracks(tracksInfo);
  208. }
  209. /**
  210. * Creates the local MediaStreams.
  211. * @param {object} [options] Optional parameters.
  212. * @param {array} options.devices The devices that will be requested.
  213. * @param {string} options.resolution Resolution constraints.
  214. * @param {string} options.cameraDeviceId
  215. * @param {string} options.micDeviceId
  216. * @returns {*} Promise object that will receive the new JitsiTracks
  217. */
  218. static obtainAudioAndVideoPermissions(options) {
  219. const usesNewGumFlow = browser.usesNewGumFlow();
  220. const obtainMediaPromise = usesNewGumFlow
  221. ? RTCUtils.newObtainAudioAndVideoPermissions(options)
  222. : RTCUtils.obtainAudioAndVideoPermissions(options);
  223. return obtainMediaPromise.then(tracksInfo => {
  224. if (usesNewGumFlow) {
  225. return _newCreateLocalTracks(tracksInfo);
  226. }
  227. return createLocalTracks(tracksInfo, options);
  228. });
  229. }
  230. /**
  231. * Initializes the bridge channel of this instance.
  232. * At least one of both, peerconnection or wsUrl parameters, must be
  233. * given.
  234. * @param {RTCPeerConnection} [peerconnection] WebRTC peer connection
  235. * instance.
  236. * @param {string} [wsUrl] WebSocket URL.
  237. */
  238. initializeBridgeChannel(peerconnection, wsUrl) {
  239. this._channel = new BridgeChannel(
  240. peerconnection, wsUrl, this.eventEmitter, this._senderVideoConstraintsChanged.bind(this));
  241. this._channelOpenListener = () => {
  242. // When the channel becomes available, tell the bridge about
  243. // video selections so that it can do adaptive simulcast,
  244. // we want the notification to trigger even if userJid
  245. // is undefined, or null.
  246. try {
  247. this._channel.sendSelectedEndpointsMessage(
  248. this._selectedEndpoints);
  249. if (typeof this._maxFrameHeight !== 'undefined') {
  250. this._channel.sendReceiverVideoConstraintMessage(
  251. this._maxFrameHeight);
  252. }
  253. } catch (error) {
  254. GlobalOnErrorHandler.callErrorHandler(error);
  255. logger.error(
  256. `Cannot send selected(${this._selectedEndpoint})`
  257. + `frameHeight(${this._maxFrameHeight}) endpoint message`,
  258. error);
  259. }
  260. this.removeListener(RTCEvents.DATA_CHANNEL_OPEN,
  261. this._channelOpenListener);
  262. this._channelOpenListener = null;
  263. // If setLastN was invoked before the bridge channel completed
  264. // opening, apply the specified value now that the channel
  265. // is open. NOTE that -1 is the default value assumed by both
  266. // RTC module and the JVB.
  267. if (this._lastN !== -1) {
  268. this._channel.sendSetLastNMessage(this._lastN);
  269. }
  270. };
  271. this.addListener(RTCEvents.DATA_CHANNEL_OPEN,
  272. this._channelOpenListener);
  273. // Add Last N change listener.
  274. this.addListener(RTCEvents.LASTN_ENDPOINT_CHANGED,
  275. this._lastNChangeListener);
  276. }
  277. /**
  278. * Callback invoked when the list of known audio and video devices has
  279. * been updated. Attempts to update the known available audio output
  280. * devices.
  281. *
  282. * @private
  283. * @returns {void}
  284. */
  285. _onDeviceListChanged() {
  286. this._updateAudioOutputForAudioTracks(RTCUtils.getAudioOutputDevice());
  287. }
  288. /**
  289. * Notifies this instance that the sender video constraints signaled from the bridge have changed.
  290. *
  291. * @param {Object} senderVideoConstraints the sender video constraints from the bridge.
  292. * @private
  293. */
  294. _senderVideoConstraintsChanged(senderVideoConstraints) {
  295. logger.info('Remote max frame height received on bridge channel: ', JSON.stringify(senderVideoConstraints));
  296. this._senderVideoConstraints = senderVideoConstraints;
  297. this.eventEmitter.emit(RTCEvents.SENDER_VIDEO_CONSTRAINTS_CHANGED);
  298. }
  299. /**
  300. * Receives events when Last N had changed.
  301. * @param {array} lastNEndpoints The new Last N endpoints.
  302. * @private
  303. */
  304. _onLastNChanged(lastNEndpoints = []) {
  305. const oldLastNEndpoints = this._lastNEndpoints || [];
  306. let leavingLastNEndpoints = [];
  307. let enteringLastNEndpoints = [];
  308. this._lastNEndpoints = lastNEndpoints;
  309. leavingLastNEndpoints = oldLastNEndpoints.filter(
  310. id => !this.isInLastN(id));
  311. enteringLastNEndpoints = lastNEndpoints.filter(
  312. id => oldLastNEndpoints.indexOf(id) === -1);
  313. this.conference.eventEmitter.emit(
  314. JitsiConferenceEvents.LAST_N_ENDPOINTS_CHANGED,
  315. leavingLastNEndpoints,
  316. enteringLastNEndpoints);
  317. }
  318. /**
  319. * Should be called when current media session ends and after the
  320. * PeerConnection has been closed using PeerConnection.close() method.
  321. */
  322. onCallEnded() {
  323. if (this._channel) {
  324. // The BridgeChannel is not explicitly closed as the PeerConnection
  325. // is closed on call ended which triggers datachannel onclose
  326. // events. If using a WebSocket, the channel must be closed since
  327. // it is not managed by the PeerConnection.
  328. // The reference is cleared to disable any logic related to the
  329. // channel.
  330. if (this._channel && this._channel.mode === 'websocket') {
  331. this._channel.close();
  332. }
  333. this._channel = null;
  334. }
  335. }
  336. /**
  337. * Sets the maximum video size the local participant should receive from
  338. * remote participants. Will cache the value and send it through the channel
  339. * once it is created.
  340. *
  341. * @param {number} maxFrameHeightPixels the maximum frame height, in pixels,
  342. * this receiver is willing to receive.
  343. * @returns {void}
  344. */
  345. setReceiverVideoConstraint(maxFrameHeight) {
  346. this._maxFrameHeight = maxFrameHeight;
  347. if (this._channel && this._channel.isOpen()) {
  348. this._channel.sendReceiverVideoConstraintMessage(maxFrameHeight);
  349. }
  350. }
  351. /**
  352. * Elects the participants with the given ids to be the selected
  353. * participants in order to always receive video for this participant (even
  354. * when last n is enabled). If there is no channel we store it and send it
  355. * through the channel once it is created.
  356. *
  357. * @param {Array<string>} ids - The user ids.
  358. * @throws NetworkError or InvalidStateError or Error if the operation
  359. * fails.
  360. * @returns {void}
  361. */
  362. selectEndpoints(ids) {
  363. this._selectedEndpoints = ids;
  364. if (this._channel && this._channel.isOpen()) {
  365. this._channel.sendSelectedEndpointsMessage(ids);
  366. }
  367. }
  368. /**
  369. *
  370. * @param eventType
  371. * @param listener
  372. */
  373. static addListener(eventType, listener) {
  374. RTCUtils.addListener(eventType, listener);
  375. }
  376. /**
  377. *
  378. * @param eventType
  379. * @param listener
  380. */
  381. static removeListener(eventType, listener) {
  382. RTCUtils.removeListener(eventType, listener);
  383. }
  384. /**
  385. *
  386. * @param options
  387. */
  388. static init(options = {}) {
  389. this.options = options;
  390. return RTCUtils.init(this.options);
  391. }
  392. /* eslint-disable max-params */
  393. /**
  394. * Creates new <tt>TraceablePeerConnection</tt>
  395. * @param {SignalingLayer} signaling The signaling layer that will
  396. * provide information about the media or participants which is not
  397. * carried over SDP.
  398. * @param {object} iceConfig An object describing the ICE config like
  399. * defined in the WebRTC specification.
  400. * @param {boolean} isP2P Indicates whether or not the new TPC will be used
  401. * in a peer to peer type of session.
  402. * @param {object} options The config options.
  403. * @param {boolean} options.enableInsertableStreams - Set to true when the insertable streams constraints is to be
  404. * enabled on the PeerConnection.
  405. * @param {boolean} options.disableSimulcast If set to 'true' will disable
  406. * the simulcast.
  407. * @param {boolean} options.disableRtx If set to 'true' will disable the
  408. * RTX.
  409. * @param {boolean} options.disableH264 If set to 'true' H264 will be
  410. * disabled by removing it from the SDP.
  411. * @param {boolean} options.preferH264 If set to 'true' H264 will be
  412. * preferred over other video codecs.
  413. * @param {boolean} options.startSilent If set to 'true' no audio will be sent or received.
  414. * @return {TraceablePeerConnection}
  415. */
  416. createPeerConnection(signaling, iceConfig, isP2P, options) {
  417. const pcConstraints = RTC.getPCConstraints(isP2P);
  418. if (typeof options.abtestSuspendVideo !== 'undefined') {
  419. RTCUtils.setSuspendVideo(pcConstraints, options.abtestSuspendVideo);
  420. Statistics.analytics.addPermanentProperties(
  421. { abtestSuspendVideo: options.abtestSuspendVideo });
  422. }
  423. // FIXME: We should rename iceConfig to pcConfig.
  424. if (options.enableInsertableStreams) {
  425. logger.debug('E2EE - setting insertable streams constraints');
  426. iceConfig.encodedInsertableStreams = true;
  427. iceConfig.forceEncodedAudioInsertableStreams = true; // legacy, to be removed in M88.
  428. iceConfig.forceEncodedVideoInsertableStreams = true; // legacy, to be removed in M88.
  429. }
  430. if (browser.supportsSdpSemantics()) {
  431. iceConfig.sdpSemantics = 'plan-b';
  432. }
  433. if (options.forceTurnRelay) {
  434. iceConfig.iceTransportPolicy = 'relay';
  435. }
  436. // Set the RTCBundlePolicy to max-bundle so that only one set of ice candidates is generated.
  437. // The default policy generates separate ice candidates for audio and video connections.
  438. // This change is necessary for Unified plan to work properly on Chrome and Safari.
  439. iceConfig.bundlePolicy = 'max-bundle';
  440. peerConnectionIdCounter = safeCounterIncrement(peerConnectionIdCounter);
  441. const newConnection
  442. = new TraceablePeerConnection(
  443. this,
  444. peerConnectionIdCounter,
  445. signaling,
  446. iceConfig, pcConstraints,
  447. isP2P, options);
  448. this.peerConnections.set(newConnection.id, newConnection);
  449. return newConnection;
  450. }
  451. /* eslint-enable max-params */
  452. /**
  453. * Removed given peer connection from this RTC module instance.
  454. * @param {TraceablePeerConnection} traceablePeerConnection
  455. * @return {boolean} <tt>true</tt> if the given peer connection was removed
  456. * successfully or <tt>false</tt> if there was no peer connection mapped in
  457. * this RTC instance.
  458. */
  459. _removePeerConnection(traceablePeerConnection) {
  460. const id = traceablePeerConnection.id;
  461. if (this.peerConnections.has(id)) {
  462. // NOTE Remote tracks are not removed here.
  463. this.peerConnections.delete(id);
  464. return true;
  465. }
  466. return false;
  467. }
  468. /**
  469. *
  470. * @param track
  471. */
  472. addLocalTrack(track) {
  473. if (!track) {
  474. throw new Error('track must not be null nor undefined');
  475. }
  476. this.localTracks.push(track);
  477. track.conference = this.conference;
  478. }
  479. /**
  480. * Returns the current value for "lastN" - the amount of videos are going
  481. * to be delivered. When set to -1 for unlimited or all available videos.
  482. * @return {number}
  483. */
  484. getLastN() {
  485. return this._lastN;
  486. }
  487. /**
  488. * @return {Object} The sender video constraints signaled from the brridge.
  489. */
  490. getSenderVideoConstraints() {
  491. return this._senderVideoConstraints;
  492. }
  493. /**
  494. * Get local video track.
  495. * @returns {JitsiLocalTrack|undefined}
  496. */
  497. getLocalVideoTrack() {
  498. const localVideo = this.getLocalTracks(MediaType.VIDEO);
  499. return localVideo.length ? localVideo[0] : undefined;
  500. }
  501. /**
  502. * Get local audio track.
  503. * @returns {JitsiLocalTrack|undefined}
  504. */
  505. getLocalAudioTrack() {
  506. const localAudio = this.getLocalTracks(MediaType.AUDIO);
  507. return localAudio.length ? localAudio[0] : undefined;
  508. }
  509. /**
  510. * Returns the local tracks of the given media type, or all local tracks if
  511. * no specific type is given.
  512. * @param {MediaType} [mediaType] Optional media type filter.
  513. * (audio or video).
  514. */
  515. getLocalTracks(mediaType) {
  516. let tracks = this.localTracks.slice();
  517. if (mediaType !== undefined) {
  518. tracks = tracks.filter(
  519. track => track.getType() === mediaType);
  520. }
  521. return tracks;
  522. }
  523. /**
  524. * Obtains all remote tracks currently known to this RTC module instance.
  525. * @param {MediaType} [mediaType] The remote tracks will be filtered
  526. * by their media type if this argument is specified.
  527. * @return {Array<JitsiRemoteTrack>}
  528. */
  529. getRemoteTracks(mediaType) {
  530. let remoteTracks = [];
  531. for (const tpc of this.peerConnections.values()) {
  532. const pcRemoteTracks = tpc.getRemoteTracks(undefined, mediaType);
  533. if (pcRemoteTracks) {
  534. remoteTracks = remoteTracks.concat(pcRemoteTracks);
  535. }
  536. }
  537. return remoteTracks;
  538. }
  539. /**
  540. * Set mute for all local audio streams attached to the conference.
  541. * @param value The mute value.
  542. * @returns {Promise}
  543. */
  544. setAudioMute(value) {
  545. const mutePromises = [];
  546. this.getLocalTracks(MediaType.AUDIO).forEach(audioTrack => {
  547. // this is a Promise
  548. mutePromises.push(value ? audioTrack.mute() : audioTrack.unmute());
  549. });
  550. // We return a Promise from all Promises so we can wait for their
  551. // execution.
  552. return Promise.all(mutePromises);
  553. }
  554. /**
  555. *
  556. * @param track
  557. */
  558. removeLocalTrack(track) {
  559. const pos = this.localTracks.indexOf(track);
  560. if (pos === -1) {
  561. return;
  562. }
  563. this.localTracks.splice(pos, 1);
  564. }
  565. /**
  566. * Removes all JitsiRemoteTracks associated with given MUC nickname
  567. * (resource part of the JID). Returns array of removed tracks.
  568. *
  569. * @param {string} Owner The resource part of the MUC JID.
  570. * @returns {JitsiRemoteTrack[]}
  571. */
  572. removeRemoteTracks(owner) {
  573. let removedTracks = [];
  574. for (const tpc of this.peerConnections.values()) {
  575. const pcRemovedTracks = tpc.removeRemoteTracks(owner);
  576. removedTracks = removedTracks.concat(pcRemovedTracks);
  577. }
  578. logger.debug(
  579. `Removed remote tracks for ${owner}`
  580. + ` count: ${removedTracks.length}`);
  581. return removedTracks;
  582. }
  583. /**
  584. *
  585. */
  586. static getPCConstraints(isP2P) {
  587. const pcConstraints
  588. = isP2P ? RTCUtils.p2pPcConstraints : RTCUtils.pcConstraints;
  589. if (!pcConstraints) {
  590. return {};
  591. }
  592. return JSON.parse(JSON.stringify(pcConstraints));
  593. }
  594. /**
  595. *
  596. * @param elSelector
  597. * @param stream
  598. */
  599. static attachMediaStream(elSelector, stream) {
  600. return RTCUtils.attachMediaStream(elSelector, stream);
  601. }
  602. /**
  603. * Returns the id of the given stream.
  604. * @param {MediaStream} stream
  605. */
  606. static getStreamID(stream) {
  607. return RTCUtils.getStreamID(stream);
  608. }
  609. /**
  610. * Returns the id of the given track.
  611. * @param {MediaStreamTrack} track
  612. */
  613. static getTrackID(track) {
  614. return RTCUtils.getTrackID(track);
  615. }
  616. /**
  617. * Returns true if retrieving the list of input devices is supported
  618. * and false if not.
  619. */
  620. static isDeviceListAvailable() {
  621. return RTCUtils.isDeviceListAvailable();
  622. }
  623. /**
  624. * Returns true if changing the input (camera / microphone) or output
  625. * (audio) device is supported and false if not.
  626. * @param {string} [deviceType] Type of device to change. Default is
  627. * undefined or 'input', 'output' - for audio output device change.
  628. * @returns {boolean} true if available, false otherwise.
  629. */
  630. static isDeviceChangeAvailable(deviceType) {
  631. return RTCUtils.isDeviceChangeAvailable(deviceType);
  632. }
  633. /**
  634. * Returns whether the current execution environment supports WebRTC (for
  635. * use within this library).
  636. *
  637. * @returns {boolean} {@code true} if WebRTC is supported in the current
  638. * execution environment (for use within this library); {@code false},
  639. * otherwise.
  640. */
  641. static isWebRtcSupported() {
  642. return browser.isSupported();
  643. }
  644. /**
  645. * Returns currently used audio output device id, '' stands for default
  646. * device
  647. * @returns {string}
  648. */
  649. static getAudioOutputDevice() {
  650. return RTCUtils.getAudioOutputDevice();
  651. }
  652. /**
  653. * Returns list of available media devices if its obtained, otherwise an
  654. * empty array is returned/
  655. * @returns {array} list of available media devices.
  656. */
  657. static getCurrentlyAvailableMediaDevices() {
  658. return RTCUtils.getCurrentlyAvailableMediaDevices();
  659. }
  660. /**
  661. * Returns event data for device to be reported to stats.
  662. * @returns {MediaDeviceInfo} device.
  663. */
  664. static getEventDataForActiveDevice(device) {
  665. return RTCUtils.getEventDataForActiveDevice(device);
  666. }
  667. /**
  668. * Sets current audio output device.
  669. * @param {string} deviceId Id of 'audiooutput' device from
  670. * navigator.mediaDevices.enumerateDevices().
  671. * @returns {Promise} resolves when audio output is changed, is rejected
  672. * otherwise
  673. */
  674. static setAudioOutputDevice(deviceId) {
  675. return RTCUtils.setAudioOutputDevice(deviceId);
  676. }
  677. /**
  678. * Returns <tt>true<tt/> if given WebRTC MediaStream is considered a valid
  679. * "user" stream which means that it's not a "receive only" stream nor a
  680. * "mixed" JVB stream.
  681. *
  682. * Clients that implement Unified Plan, such as Firefox use recvonly
  683. * "streams/channels/tracks" for receiving remote stream/tracks, as opposed
  684. * to Plan B where there are only 3 channels: audio, video and data.
  685. *
  686. * @param {MediaStream} stream The WebRTC MediaStream instance.
  687. * @returns {boolean}
  688. */
  689. static isUserStream(stream) {
  690. return RTC.isUserStreamById(RTCUtils.getStreamID(stream));
  691. }
  692. /**
  693. * Returns <tt>true<tt/> if a WebRTC MediaStream identified by given stream
  694. * ID is considered a valid "user" stream which means that it's not a
  695. * "receive only" stream nor a "mixed" JVB stream.
  696. *
  697. * Clients that implement Unified Plan, such as Firefox use recvonly
  698. * "streams/channels/tracks" for receiving remote stream/tracks, as opposed
  699. * to Plan B where there are only 3 channels: audio, video and data.
  700. *
  701. * @param {string} streamId The id of WebRTC MediaStream.
  702. * @returns {boolean}
  703. */
  704. static isUserStreamById(streamId) {
  705. return streamId && streamId !== 'mixedmslabel'
  706. && streamId !== 'default';
  707. }
  708. /**
  709. * Allows to receive list of available cameras/microphones.
  710. * @param {function} callback Would receive array of devices as an
  711. * argument.
  712. */
  713. static enumerateDevices(callback) {
  714. RTCUtils.enumerateDevices(callback);
  715. }
  716. /**
  717. * A method to handle stopping of the stream.
  718. * One point to handle the differences in various implementations.
  719. * @param {MediaStream} mediaStream MediaStream object to stop.
  720. */
  721. static stopMediaStream(mediaStream) {
  722. RTCUtils.stopMediaStream(mediaStream);
  723. }
  724. /**
  725. * Returns whether the desktop sharing is enabled or not.
  726. * @returns {boolean}
  727. */
  728. static isDesktopSharingEnabled() {
  729. return RTCUtils.isDesktopSharingEnabled();
  730. }
  731. /**
  732. * Closes the currently opened bridge channel.
  733. */
  734. closeBridgeChannel() {
  735. if (this._channel) {
  736. this._channel.close();
  737. this._channel = null;
  738. this.removeListener(RTCEvents.LASTN_ENDPOINT_CHANGED,
  739. this._lastNChangeListener);
  740. }
  741. }
  742. /* eslint-disable max-params */
  743. /**
  744. *
  745. * @param {TraceablePeerConnection} tpc
  746. * @param {number} ssrc
  747. * @param {number} audioLevel
  748. * @param {boolean} isLocal
  749. */
  750. setAudioLevel(tpc, ssrc, audioLevel, isLocal) {
  751. const track = tpc.getTrackBySSRC(ssrc);
  752. if (!track) {
  753. return;
  754. } else if (!track.isAudioTrack()) {
  755. logger.warn(`Received audio level for non-audio track: ${ssrc}`);
  756. return;
  757. } else if (track.isLocal() !== isLocal) {
  758. logger.error(
  759. `${track} was expected to ${isLocal ? 'be' : 'not be'} local`);
  760. }
  761. track.setAudioLevel(audioLevel, tpc);
  762. }
  763. /* eslint-enable max-params */
  764. /**
  765. * Sends message via the bridge channel.
  766. * @param {string} to The id of the endpoint that should receive the
  767. * message. If "" the message will be sent to all participants.
  768. * @param {object} payload The payload of the message.
  769. * @throws NetworkError or InvalidStateError or Error if the operation
  770. * fails or there is no data channel created.
  771. */
  772. sendChannelMessage(to, payload) {
  773. if (this._channel) {
  774. this._channel.sendMessage(to, payload);
  775. } else {
  776. throw new Error('Channel support is disabled!');
  777. }
  778. }
  779. /**
  780. * Selects a new value for "lastN". The requested amount of videos are going
  781. * to be delivered after the value is in effect. Set to -1 for unlimited or
  782. * all available videos.
  783. * @param {number} value the new value for lastN.
  784. */
  785. setLastN(value) {
  786. if (this._lastN !== value) {
  787. this._lastN = value;
  788. if (this._channel && this._channel.isOpen()) {
  789. this._channel.sendSetLastNMessage(value);
  790. }
  791. this.eventEmitter.emit(RTCEvents.LASTN_VALUE_CHANGED, value);
  792. }
  793. }
  794. /**
  795. * Indicates if the endpoint id is currently included in the last N.
  796. * @param {string} id The endpoint id that we check for last N.
  797. * @returns {boolean} true if the endpoint id is in the last N or if we
  798. * don't have bridge channel support, otherwise we return false.
  799. */
  800. isInLastN(id) {
  801. return !this._lastNEndpoints // lastNEndpoints not initialised yet.
  802. || this._lastNEndpoints.indexOf(id) > -1;
  803. }
  804. /**
  805. * Updates the target audio output device for all remote audio tracks.
  806. *
  807. * @param {string} deviceId - The device id of the audio ouput device to
  808. * use for all remote tracks.
  809. * @private
  810. * @returns {void}
  811. */
  812. _updateAudioOutputForAudioTracks(deviceId) {
  813. const remoteAudioTracks = this.getRemoteTracks(MediaType.AUDIO);
  814. for (const track of remoteAudioTracks) {
  815. track.setAudioOutput(deviceId);
  816. }
  817. }
  818. }