You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

RTC.js 28KB

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