/* global $, APP, interfaceConfig */ const logger = require("jitsi-meet-logger").getLogger(__filename); import ConnectionIndicator from './ConnectionIndicator'; import SmallVideo from "./SmallVideo"; import UIUtils from "../util/UIUtil"; import UIEvents from '../../../service/UI/UIEvents'; import JitsiPopover from "../util/JitsiPopover"; const MUTED_DIALOG_BUTTON_VALUES = { cancel: 0, muted: 1 }; /** * Creates new instance of the RemoteVideo. * @param user {JitsiParticipant} the user for whom remote video instance will * be created. * @param {VideoLayout} VideoLayout the video layout instance. * @param {EventEmitter} emitter the event emitter which will be used by * the new instance to emit events. * @constructor */ function RemoteVideo(user, VideoLayout, emitter) { this.user = user; this.id = user.getId(); this.emitter = emitter; this.videoSpanId = `participant_${this.id}`; SmallVideo.call(this, VideoLayout); this._audioStreamElement = null; this.hasRemoteVideoMenu = false; this._supportsRemoteControl = false; this.addRemoteVideoContainer(); this.connectionIndicator = new ConnectionIndicator(this, this.id); this.setDisplayName(); this.bindHoverHandler(); this.flipX = false; this.isLocal = false; this.popupMenuIsHovered = false; /** * The flag is set to true after the 'onplay' event has been * triggered on the current video element. It goes back to false * when the stream is removed. It is used to determine whether the video * playback has ever started. * @type {boolean} */ this.wasVideoPlayed = false; /** * The flag is set to true if remote participant's video gets muted * during his media connection disruption. This is to prevent black video * being render on the thumbnail, because even though once the video has * been played the image usually remains on the video element it seems that * after longer period of the video element being hidden this image can be * lost. * @type {boolean} */ this.mutedWhileDisconnected = false; } RemoteVideo.prototype = Object.create(SmallVideo.prototype); RemoteVideo.prototype.constructor = RemoteVideo; RemoteVideo.prototype.addRemoteVideoContainer = function() { this.container = RemoteVideo.createContainer(this.videoSpanId); this.initBrowserSpecificProperties(); if (APP.conference.isModerator || this._supportsRemoteControl) { this.addRemoteVideoMenu(); } this.VideoLayout.resizeThumbnails(false, true); this.addAudioLevelIndicator(); return this.container; }; /** * Initializes the remote participant popup menu, by specifying previously * constructed popupMenuElement, containing all the menu items. * * @param popupMenuElement a pre-constructed element, containing the menu items * to display in the popup */ RemoteVideo.prototype._initPopupMenu = function (popupMenuElement) { let options = { content: popupMenuElement.outerHTML, skin: "black", hasArrow: false, onBeforePosition: el => APP.translation.translateElement(el) }; let element = $("#" + this.videoSpanId + " .remotevideomenu"); this.popover = new JitsiPopover(element, options); this.popover.addOnHoverPopover(isHovered => { this.popupMenuIsHovered = isHovered; this.updateView(); }); // override popover show method to make sure we will update the content // before showing the popover let origShowFunc = this.popover.show; this.popover.show = function () { // update content by forcing it, to finish even if popover // is not visible this.updateRemoteVideoMenu(this.isAudioMuted, true); // call the original show, passing its actual this origShowFunc.call(this.popover); }.bind(this); }; /** * Checks whether current video is considered hovered. Currently it is hovered * if the mouse is over the video, or if the connection indicator or the popup * menu is shown(hovered). * @private * NOTE: extends SmallVideo's method */ RemoteVideo.prototype._isHovered = function () { let isHovered = SmallVideo.prototype._isHovered.call(this) || this.popupMenuIsHovered; return isHovered; }; /** * Generates the popup menu content. * * @returns {Element|*} the constructed element, containing popup menu items * @private */ RemoteVideo.prototype._generatePopupContent = function () { let popupmenuElement = document.createElement('ul'); popupmenuElement.className = 'popupmenu'; popupmenuElement.id = `remote_popupmenu_${this.id}`; let menuItems = []; if(APP.conference.isModerator) { let muteTranslationKey; let muteClassName; if (this.isAudioMuted) { muteTranslationKey = 'videothumbnail.muted'; muteClassName = 'mutelink disabled'; } else { muteTranslationKey = 'videothumbnail.domute'; muteClassName = 'mutelink'; } let muteHandler = this._muteHandler.bind(this); let kickHandler = this._kickHandler.bind(this); menuItems = [ { id: 'mutelink_' + this.id, handler: muteHandler, icon: 'icon-mic-disabled', className: muteClassName, data: { i18n: muteTranslationKey } }, { id: 'ejectlink_' + this.id, handler: kickHandler, icon: 'icon-kick', data: { i18n: 'videothumbnail.kick' } } ]; } if(this._supportsRemoteControl) { let icon, handler, className; if(APP.remoteControl.controller.getRequestedParticipant() === this.id) { handler = () => {}; className = "requestRemoteControlLink disabled"; icon = "remote-control-spinner fa fa-spinner fa-spin"; } else if(!APP.remoteControl.controller.isStarted()) { handler = this._requestRemoteControlPermissions.bind(this); icon = "fa fa-play"; className = "requestRemoteControlLink"; } else { handler = this._stopRemoteControl.bind(this); icon = "fa fa-stop"; className = "requestRemoteControlLink"; } menuItems.push({ id: 'remoteControl_' + this.id, handler, icon, className, data: { i18n: 'videothumbnail.remoteControl' } }); } menuItems.forEach(el => { let menuItem = this._generatePopupMenuItem(el); popupmenuElement.appendChild(menuItem); }); // feature check for volume setting as temasys objects cannot adjust volume if (this._canSetAudioVolume()) { const volumeScale = 100; const volumeSlider = this._generatePopupMenuSliderItem({ handler: this._setAudioVolume.bind(this, volumeScale), icon: 'icon-volume', initialValue: this._getAudioElement().volume * volumeScale, maxValue: volumeScale }); popupmenuElement.appendChild(volumeSlider); } APP.translation.translateElement($(popupmenuElement)); return popupmenuElement; }; /** * Sets the remote control supported value and initializes or updates the menu * depending on the remote control is supported or not. * @param {boolean} isSupported */ RemoteVideo.prototype.setRemoteControlSupport = function(isSupported = false) { if(this._supportsRemoteControl === isSupported) { return; } this._supportsRemoteControl = isSupported; if(!isSupported) { return; } if(!this.hasRemoteVideoMenu) { //create menu this.addRemoteVideoMenu(); } else { //update the content this.updateRemoteVideoMenu(this.isAudioMuted, true); } }; /** * Requests permissions for remote control session. */ RemoteVideo.prototype._requestRemoteControlPermissions = function () { APP.remoteControl.controller.requestPermissions( this.id, this.VideoLayout.getLargeVideoWrapper()).then(result => { if(result === null) { return; } this.updateRemoteVideoMenu(this.isAudioMuted, true); APP.UI.messageHandler.openMessageDialog( "dialog.remoteControlTitle", (result === false) ? "dialog.remoteControlDeniedMessage" : "dialog.remoteControlAllowedMessage", {user: this.user.getDisplayName() || interfaceConfig.DEFAULT_REMOTE_DISPLAY_NAME} ); if(result === true) {//the remote control permissions has been granted // pin the controlled participant let pinnedId = this.VideoLayout.getPinnedId(); if(pinnedId !== this.id) { this.VideoLayout.handleVideoThumbClicked(this.id); } } }, error => { logger.error(error); this.updateRemoteVideoMenu(this.isAudioMuted, true); APP.UI.messageHandler.openMessageDialog( "dialog.remoteControlTitle", "dialog.remoteControlErrorMessage", {user: this.user.getDisplayName() || interfaceConfig.DEFAULT_REMOTE_DISPLAY_NAME} ); }); this.updateRemoteVideoMenu(this.isAudioMuted, true); }; /** * Stops remote control session. */ RemoteVideo.prototype._stopRemoteControl = function () { // send message about stopping APP.remoteControl.controller.stop(); this.updateRemoteVideoMenu(this.isAudioMuted, true); }; RemoteVideo.prototype._muteHandler = function () { if (this.isAudioMuted) return; RemoteVideo.showMuteParticipantDialog().then(reason => { if(reason === MUTED_DIALOG_BUTTON_VALUES.muted) { this.emitter.emit(UIEvents.REMOTE_AUDIO_MUTED, this.id); } }).catch(e => { //currently shouldn't be called logger.error(e); }); this.popover.forceHide(); }; RemoteVideo.prototype._kickHandler = function () { this.emitter.emit(UIEvents.USER_KICKED, this.id); this.popover.forceHide(); }; RemoteVideo.prototype._generatePopupMenuItem = function (opts = {}) { let { id, handler, icon, data, className } = opts; handler = handler || $.noop; let menuItem = document.createElement('li'); menuItem.className = 'popupmenu__item'; let linkItem = document.createElement('a'); linkItem.className = 'popupmenu__link'; if (className) { linkItem.className += ` ${className}`; } if (icon) { let indicator = document.createElement('span'); indicator.className = 'popupmenu__icon'; indicator.innerHTML = ``; linkItem.appendChild(indicator); } let textContent = document.createElement('span'); textContent.className = 'popupmenu__text'; if (data) { let dataKeys = Object.keys(data); dataKeys.forEach(key => { textContent.dataset[key] = data[key]; }); } linkItem.appendChild(textContent); linkItem.id = id; linkItem.onclick = handler; menuItem.appendChild(linkItem); return menuItem; }; /** * Create a div element with a slider. * * @param {object} options - Configuration for the div's display and slider. * @param {string} options.icon - The classname for the icon to display. * @param {int} options.maxValue - The maximum value on the slider. The default * value is 100. * @param {int} options.initialValue - The value the slider should start at. * The default value is 0. * @param {function} options.handler - The callback for slider value changes. * @returns {Element} A div element with a slider. */ RemoteVideo.prototype._generatePopupMenuSliderItem = function (options) { const template = `
`; const menuItem = document.createElement('li'); menuItem.className = 'popupmenu__item'; menuItem.innerHTML = template; const slider = menuItem.getElementsByClassName('popupmenu__slider')[0]; slider.oninput = function () { options.handler(Number(slider.value)); }; return menuItem; }; /** * Get the remote participant's audio element. * * @returns {Element} audio element */ RemoteVideo.prototype._getAudioElement = function () { return this._audioStreamElement; }; /** * Check if the remote participant's audio can have its volume adjusted. * * @returns {boolean} true if the volume can be adjusted. */ RemoteVideo.prototype._canSetAudioVolume = function () { const audioElement = this._getAudioElement(); return audioElement && audioElement.volume !== undefined; }; /** * Change the remote participant's volume level. * * @param {int} scale - The maximum value the slider can go to. * @param {int} newVal - The value to set the slider to. */ RemoteVideo.prototype._setAudioVolume = function (scale, newVal) { if (this._canSetAudioVolume()) { this._getAudioElement().volume = newVal / scale; } }; /** * Updates the remote video menu. * * @param isMuted the new muted state to update to * @param force to work even if popover is not visible */ RemoteVideo.prototype.updateRemoteVideoMenu = function (isMuted, force) { this.isAudioMuted = isMuted; // generate content, translate it and add it to document only if // popover is visible or we force to do so. if(this.popover.popoverShown || force) { this.popover.updateContent(this._generatePopupContent()); } }; /** * @inheritDoc */ RemoteVideo.prototype.setMutedView = function(isMuted) { SmallVideo.prototype.setMutedView.call(this, isMuted); // Update 'mutedWhileDisconnected' flag this._figureOutMutedWhileDisconnected(this.isConnectionActive() === false); }; /** * Figures out the value of {@link #mutedWhileDisconnected} flag by taking into * account remote participant's network connectivity and video muted status. * * @param {boolean} isDisconnected true if the remote participant is * currently having connectivity issues or false otherwise. * * @private */ RemoteVideo.prototype._figureOutMutedWhileDisconnected = function(isDisconnected) { if (isDisconnected && this.isVideoMuted) { this.mutedWhileDisconnected = true; } else if (!isDisconnected && !this.isVideoMuted) { this.mutedWhileDisconnected = false; } }; /** * Adds the remote video menu element for the given id in the * given parentElement. * * @param id the id indicating the video for which we're adding a menu. * @param parentElement the parent element where this menu will be added */ RemoteVideo.prototype.addRemoteVideoMenu = function () { if (interfaceConfig.filmStripOnly) { return; } var spanElement = document.createElement('span'); spanElement.className = 'remotevideomenu'; this.container.appendChild(spanElement); var menuElement = document.createElement('i'); menuElement.className = 'icon-menu-up'; menuElement.title = 'Remote user controls'; spanElement.appendChild(menuElement); this._initPopupMenu(this._generatePopupContent()); this.hasRemoteVideoMenu = true; }; /** * Removes the remote stream element corresponding to the given stream and * parent container. * * @param stream the MediaStream * @param isVideo true if given stream is a video one. */ RemoteVideo.prototype.removeRemoteStreamElement = function (stream) { if (!this.container) return false; var isVideo = stream.isVideoTrack(); var elementID = SmallVideo.getStreamElementID(stream); var select = $('#' + elementID); select.remove(); if (isVideo) { this.wasVideoPlayed = false; } logger.info((isVideo ? "Video" : "Audio") + " removed " + this.id, select); // when removing only the video element and we are on stage // update the stage if (isVideo && this.isCurrentlyOnLargeVideo()) this.VideoLayout.updateLargeVideo(this.id); else // Missing video stream will affect display mode this.updateView(); }; /** * Checks whether the remote user associated with this RemoteVideo * has connectivity issues. * * @return {boolean} true if the user's connection is fine or * false otherwise. */ RemoteVideo.prototype.isConnectionActive = function() { return this.user.isConnectionActive(); }; /** * The remote video is considered "playable" once the stream has started * according to the {@link #hasVideoStarted} result. * * @inheritdoc * @override */ RemoteVideo.prototype.isVideoPlayable = function () { return SmallVideo.prototype.isVideoPlayable.call(this) && this.hasVideoStarted() && !this.mutedWhileDisconnected; }; /** * @inheritDoc */ RemoteVideo.prototype.updateView = function () { this.updateConnectionStatusIndicator(); // This must be called after 'updateConnectionStatusIndicator' because it // affects the display mode by modifying 'mutedWhileDisconnected' flag SmallVideo.prototype.updateView.call(this); }; /** * Updates the UI to reflect user's connectivity status. */ RemoteVideo.prototype.updateConnectionStatusIndicator = function () { const isActive = this.isConnectionActive(); if (isActive === null) { // Cancel processing at this point - no update return; } logger.debug(this.id + " thumbnail is connection active ? " + isActive); // Update 'mutedWhileDisconnected' flag this._figureOutMutedWhileDisconnected(!isActive); if(this.connectionIndicator) this.connectionIndicator.updateConnectionStatusIndicator(isActive); // Toggle thumbnail video problem filter this.selectVideoElement().toggleClass( "videoThumbnailProblemFilter", !isActive); this.$avatar().toggleClass( "videoThumbnailProblemFilter", !isActive); }; /** * Removes RemoteVideo from the page. */ RemoteVideo.prototype.remove = function () { logger.log("Remove thumbnail", this.id); this.removeConnectionIndicator(); // Make sure that the large video is updated if are removing its // corresponding small video. this.VideoLayout.updateAfterThumbRemoved(this.id); // Remove whole container if (this.container.parentNode) { this.container.parentNode.removeChild(this.container); } }; RemoteVideo.prototype.waitForPlayback = function (streamElement, stream) { var webRtcStream = stream.getOriginalStream(); var isVideo = stream.isVideoTrack(); if (!isVideo || webRtcStream.id === 'mixedmslabel') { return; } var self = this; // Triggers when video playback starts var onPlayingHandler = function () { self.wasVideoPlayed = true; self.VideoLayout.remoteVideoActive(streamElement, self.id); streamElement.onplaying = null; // Refresh to show the video self.updateView(); }; streamElement.onplaying = onPlayingHandler; }; /** * Checks whether the video stream has started for this RemoteVideo instance. * * @returns {boolean} true if this RemoteVideo has a video stream for which * the playback has been started. */ RemoteVideo.prototype.hasVideoStarted = function () { return this.wasVideoPlayed; }; RemoteVideo.prototype.addRemoteStreamElement = function (stream) { if (!this.container) { return; } let isVideo = stream.isVideoTrack(); isVideo ? this.videoStream = stream : this.audioStream = stream; if (isVideo) this.setVideoType(stream.videoType); // Add click handler. let onClickHandler = (event) => { let source = event.target || event.srcElement; // ignore click if it was done in popup menu if ($(source).parents('.popupmenu').length === 0) { this.VideoLayout.handleVideoThumbClicked(this.id); } // On IE we need to populate this handler on video // and it does not give event instance as an argument, // so we check here for methods. if (event.stopPropagation && event.preventDefault) { event.stopPropagation(); event.preventDefault(); } return false; }; this.container.onclick = onClickHandler; if(!stream.getOriginalStream()) return; let streamElement = SmallVideo.createStreamElement(stream); // Put new stream element always in front UIUtils.prependChild(this.container, streamElement); // If we hide element when Temasys plugin is used then // we'll never receive 'onplay' event and other logic won't work as expected // NOTE: hiding will not have effect when Temasys plugin is in use, as // calling attach will show it back $(streamElement).hide(); // If the container is currently visible // we attach the stream to the element. if (!isVideo || (this.container.offsetParent !== null && isVideo)) { this.waitForPlayback(streamElement, stream); streamElement = stream.attach(streamElement); } $(streamElement).click(onClickHandler); if (!isVideo) { this._audioStreamElement = streamElement; } }; RemoteVideo.prototype.updateResolution = function (resolution) { if (this.connectionIndicator) { this.connectionIndicator.updateResolution(resolution); } }; /** * Updates this video framerate indication. * @param framerate the value to update */ RemoteVideo.prototype.updateFramerate = function (framerate) { if (this.connectionIndicator) { this.connectionIndicator.updateFramerate(framerate); } }; RemoteVideo.prototype.removeConnectionIndicator = function () { if (this.connectionIndicator) this.connectionIndicator.remove(); }; RemoteVideo.prototype.hideConnectionIndicator = function () { if (this.connectionIndicator) this.connectionIndicator.hide(); }; /** * Sets the display name for the given video span id. * * @param displayName the display name to set */ RemoteVideo.prototype.setDisplayName = function(displayName) { if (!this.container) { logger.warn( "Unable to set displayName - " + this.videoSpanId + " does not exist"); return; } var nameSpan = $('#' + this.videoSpanId + ' .displayname'); // If we already have a display name for this video. if (nameSpan.length > 0) { if (displayName && displayName.length > 0) { var displaynameSpan = $('#' + this.videoSpanId + '_name'); if (displaynameSpan.text() !== displayName) displaynameSpan.text(displayName); } else $('#' + this.videoSpanId + '_name').text( interfaceConfig.DEFAULT_REMOTE_DISPLAY_NAME); } else { nameSpan = document.createElement('span'); nameSpan.className = 'displayname'; $('#' + this.videoSpanId)[0] .appendChild(nameSpan); if (displayName && displayName.length > 0) { $(nameSpan).text(displayName); } else { nameSpan.innerHTML = interfaceConfig.DEFAULT_REMOTE_DISPLAY_NAME; } nameSpan.id = this.videoSpanId + '_name'; } }; /** * Removes remote video menu element from video element identified by * given videoElementId. * * @param videoElementId the id of local or remote video element. */ RemoteVideo.prototype.removeRemoteVideoMenu = function() { var menuSpan = $('#' + this.videoSpanId + '> .remotevideomenu'); if (menuSpan.length) { this.popover.forceHide(); menuSpan.remove(); this.hasRemoteVideoMenu = false; } }; RemoteVideo.createContainer = function (spanId) { let container = document.createElement('span'); container.id = spanId; container.className = 'videocontainer'; let wrapper = document.createElement('div'); wrapper.className = 'videocontainer__background'; container.appendChild(wrapper); let indicatorBar = document.createElement('div'); indicatorBar.className = "videocontainer__toptoolbar"; container.appendChild(indicatorBar); let toolbar = document.createElement('div'); toolbar.className = "videocontainer__toolbar"; container.appendChild(toolbar); let overlay = document.createElement('div'); overlay.className = "videocontainer__hoverOverlay"; container.appendChild(overlay); var remotes = document.getElementById('remoteVideos'); return remotes.appendChild(container); }; /** * Shows 2 button dialog for confirmation from the user for muting remote * participant. */ RemoteVideo.showMuteParticipantDialog = function () { return new Promise(resolve => { APP.UI.messageHandler.openTwoButtonDialog({ titleKey : "dialog.muteParticipantTitle", msgString: "
", leftButtonKey: "dialog.muteParticipantButton", dontShowAgain: { id: "dontShowMuteParticipantDialog", textKey: "dialog.doNotShowMessageAgain", checked: true, buttonValues: [true] }, submitFunction: () => resolve(MUTED_DIALOG_BUTTON_VALUES.muted), closeFunction: () => resolve(MUTED_DIALOG_BUTTON_VALUES.cancel) }); }); }; export default RemoteVideo;