import React from 'react'; import { injectIntl } from 'react-intl'; import PropTypes from 'prop-types'; import { debounce } from '/imports/utils/debounce'; import FullscreenButtonContainer from '/imports/ui/components/common/fullscreen-button/container'; import SwitchButtonContainer from './switch-button/container'; import Styled from './styles'; import * as PluginSdk from 'bigbluebutton-html-plugin-sdk'; import VolumeSlider from '../external-video-player/volume-slider/component'; import PluginButtonContainer from '../plugins/plugin-button/container'; import AutoplayOverlay from '../media/autoplay-overlay/component'; import logger from '/imports/startup/client/logger'; import playAndRetry from '/imports/utils/mediaElementPlayRetry'; import { notify } from '/imports/ui/services/notification'; import { SCREENSHARE_MEDIA_ELEMENT_NAME, isMediaFlowing, screenshareHasEnded, screenshareHasStarted, setOutputDeviceId, getMediaElement, getMediaElementDimensions, attachLocalPreviewStream, setVolume, getVolume, getStats, } from '/imports/ui/components/screenshare/service'; import { isStreamStateHealthy, subscribeToStreamStateChange, unsubscribeFromStreamStateChange, } from '/imports/ui/services/bbb-webrtc-sfu/stream-state-service'; import { ACTIONS, PRESENTATION_AREA } from '/imports/ui/components/layout/enums'; import { getSettingsSingletonInstance } from '/imports/ui/services/settings'; import deviceInfo from '/imports/utils/deviceInfo'; import { uniqueId } from '/imports/utils/string-utils'; import Session from '/imports/ui/services/storage/in-memory'; const MOBILE_HOVER_TIMEOUT = 5000; const MEDIA_FLOW_PROBE_INTERVAL = 500; const SCREEN_SIZE_DISPATCH_INTERVAL = 500; const renderPluginItems = (pluginItems, bottom, right) => { if (pluginItems !== undefined) { return ( <> { pluginItems.map((pluginItem) => { const returnComponent = ( pluginItem.onClick({ browserClickEvent: e })} /> ); return returnComponent; }) } ); } return (<>); }; class ScreenshareComponent extends React.Component { static renderScreenshareContainerInside(mainText) { return ( {mainText} ); } constructor(props) { super(); this.state = { loaded: false, autoplayBlocked: false, mediaFlowing: true, switched: false, // Volume control hover toolbar showHoverToolBar: false, }; this.onLoadedData = this.onLoadedData.bind(this); this.onLoadedMetadata = this.onLoadedMetadata.bind(this); this.onVideoResize = this.onVideoResize.bind(this); this.handleAllowAutoplay = this.handleAllowAutoplay.bind(this); this.handlePlayElementFailed = this.handlePlayElementFailed.bind(this); this.failedMediaElements = []; this.onStreamStateChange = this.onStreamStateChange.bind(this); this.onSwitched = this.onSwitched.bind(this); this.handleOnVolumeChanged = this.handleOnVolumeChanged.bind(this); this.dispatchScreenShareSize = this.dispatchScreenShareSize.bind(this); this.handleOnMuted = this.handleOnMuted.bind(this); this.dispatchScreenShareSize = this.dispatchScreenShareSize.bind(this); this.renderScreenshareButtons = this.renderScreenshareButtons.bind(this); this.splitPluginItems = this.splitPluginItems.bind(this); this.debouncedDispatchScreenShareSize = debounce( this.dispatchScreenShareSize, SCREEN_SIZE_DISPATCH_INTERVAL, { leading: false, trailing: true }, ); const { locales, icon } = props; this.locales = locales; this.icon = icon; this.volume = getVolume(); this.mobileHoverSetTimeout = null; this.mediaFlowMonitor = null; } componentDidMount() { const { isLayoutSwapped, layoutContextDispatch, intl, isPresenter, startPreviewSizeBig, outputDeviceId, isSharedNotesPinned, hasAudio, } = this.props; screenshareHasStarted(hasAudio, isPresenter, { outputDeviceId }); // Autoplay failure handling window.addEventListener('screensharePlayFailed', this.handlePlayElementFailed); // Stream health state tracker to propagate UI changes on reconnections subscribeToStreamStateChange('screenshare', this.onStreamStateChange); // Attaches the local stream if it exists to serve as the local presenter preview attachLocalPreviewStream(getMediaElement()); this.setState({ switched: startPreviewSizeBig }); notify(intl.formatMessage(this.locales.started), 'info', this.icon); layoutContextDispatch({ type: ACTIONS.SET_PILE_CONTENT_FOR_PRESENTATION_AREA, value: { content: PRESENTATION_AREA.SCREEN_SHARE, open: true, }, }); Session.setItem('pinnedNotesLastState', isSharedNotesPinned); } componentDidUpdate(prevProps) { const { isPresenter, outputDeviceId } = this.props; if (prevProps.isPresenter && !isPresenter) { screenshareHasEnded(); } if (prevProps.outputDeviceId !== outputDeviceId && !isPresenter) { setOutputDeviceId(outputDeviceId); } } componentWillUnmount() { const { intl, fullscreenContext, layoutContextDispatch, } = this.props; screenshareHasEnded(); window.removeEventListener('screensharePlayFailed', this.handlePlayElementFailed); unsubscribeFromStreamStateChange('screenshare', this.onStreamStateChange); const Settings = getSettingsSingletonInstance(); if (Settings.dataSaving.viewScreenshare) { notify(intl.formatMessage(this.locales.ended), 'info', this.icon); } else { notify(intl.formatMessage(this.locales.endedDueToDataSaving), 'info', this.icon); } layoutContextDispatch({ type: ACTIONS.SET_PILE_CONTENT_FOR_PRESENTATION_AREA, value: { content: PRESENTATION_AREA.SCREEN_SHARE, open: false, }, }); if (fullscreenContext) { layoutContextDispatch({ type: ACTIONS.SET_FULLSCREEN_ELEMENT, value: { element: '', group: '', }, }); } this.clearMediaFlowingMonitor(); layoutContextDispatch({ type: ACTIONS.SET_PRESENTATION_IS_OPEN, value: Session.getItem('presentationLastState'), }); } clearMediaFlowingMonitor() { if (this.mediaFlowMonitor) { clearInterval(this.mediaFlowMonitor); this.mediaFlowMonitor = null; } } handleAllowAutoplay() { const { autoplayBlocked } = this.state; logger.info({ logCode: 'screenshare_autoplay_allowed', }, 'Screenshare media autoplay allowed by the user'); window.removeEventListener('screensharePlayFailed', this.handlePlayElementFailed); while (this.failedMediaElements.length) { const mediaElement = this.failedMediaElements.shift(); if (mediaElement) { const played = playAndRetry(mediaElement); if (!played) { logger.error({ logCode: 'screenshare_autoplay_handling_failed', }, 'Screenshare autoplay handling failed to play media'); } else { logger.info({ logCode: 'screenshare_viewer_media_play_success', }, 'Screenshare viewer media played successfully'); } } } if (autoplayBlocked) { this.setState({ autoplayBlocked: false }); } } handlePlayElementFailed(e) { const { mediaElement } = e.detail; const { autoplayBlocked } = this.state; e.stopPropagation(); this.failedMediaElements.push(mediaElement); if (!autoplayBlocked) { logger.info({ logCode: 'screenshare_autoplay_prompt', }, 'Prompting user for action to play screenshare media'); this.setState({ autoplayBlocked: true }); } } async monitorMediaFlow() { let previousStats = await getStats(); this.mediaFlowMonitor = setInterval(async () => { const { mediaFlowing: prevMediaFlowing } = this.state; let mediaFlowing; const currentStats = await getStats(); try { mediaFlowing = isMediaFlowing(previousStats, currentStats); } catch (error) { // Stats processing failed for whatever reason - maintain previous state mediaFlowing = prevMediaFlowing; logger.warn({ logCode: 'screenshare_media_monitor_stats_failed', extraInfo: { errorName: error.name, errorMessage: error.message, }, }, 'Failed to collect screenshare stats, flow monitor'); } previousStats = currentStats; if (prevMediaFlowing !== mediaFlowing) this.setState({ mediaFlowing }); }, MEDIA_FLOW_PROBE_INTERVAL); } dispatchScreenShareSize() { const { layoutContextDispatch, } = this.props; const { width, height } = getMediaElementDimensions(); const value = { width, height, browserWidth: window.innerWidth, browserHeight: window.innerHeight, }; layoutContextDispatch({ type: ACTIONS.SET_SCREEN_SHARE_SIZE, value, }); } onLoadedMetadata() { const element = getMediaElement(); // Track HTMLVideo's resize event to propagate stream size changes to the // layout engine. See this.onVideoResize; if (element && typeof element.onresize !== 'function') { element.onresize = this.onVideoResize; } // Dispatch the initial stream size to the layout engine this.dispatchScreenShareSize(); } onLoadedData() { this.setState({ loaded: true }); } onSwitched() { this.setState((prevState) => ({ switched: !prevState.switched })); } handleOnVolumeChanged(volume) { this.volume = volume; setVolume(volume); } handleOnMuted(muted) { if (muted) { setVolume(0); } else { setVolume(this.volume); } } onVideoResize() { // Debounced version of the dispatcher to pace things out - we don't want // to hog the CPU just for resize recalculations... this.debouncedDispatchScreenShareSize(); } onStreamStateChange(event) { const { streamState } = event.detail; const { mediaFlowing } = this.state; const isStreamHealthy = isStreamStateHealthy(streamState); event.stopPropagation(); if (isStreamHealthy) { this.clearMediaFlowingMonitor(); // Current state is media not flowing - stream is now healthy so flip it if (!mediaFlowing) this.setState({ mediaFlowing: isStreamHealthy }); } else if (this.mediaFlowMonitor == null) this.monitorMediaFlow(); } renderFullscreenButton() { const { intl, fullscreenElementId, fullscreenContext } = this.props; const ALLOW_FULLSCREEN = window.meetingClientSettings.public.app.allowFullscreen; if (!ALLOW_FULLSCREEN) return null; return ( ); } renderAutoplayOverlay() { const { intl } = this.props; return ( ); } renderSwitchButton() { const { showSwitchPreviewSizeButton } = this.props; const { switched } = this.state; if (!showSwitchPreviewSizeButton) return null; return ( ); } renderMobileVolumeControlOverlay () { return ( { this.overlay = ref; }} onTouchStart={() => { clearTimeout(this.mobileHoverSetTimeout); this.setState({ showHoverToolBar: true }); }} onTouchEnd={() => { this.mobileHoverSetTimeout = setTimeout( () => this.setState({ showHoverToolBar: false }), MOBILE_HOVER_TIMEOUT, ); }} /> ); } renderVolumeSlider() { const { showHoverToolBar } = this.state; let toolbarStyle = 'hoverToolbar'; if (deviceInfo.isMobile && !showHoverToolBar) { toolbarStyle = 'dontShowMobileHoverToolbar'; } if (deviceInfo.isMobile && showHoverToolBar) { toolbarStyle = 'showMobileHoverToolbar'; } return [( ), (deviceInfo.isMobile) && this.renderMobileVolumeControlOverlay(), ]; } renderVideo(switched) { const { isGloballyBroadcasting } = this.props; const { mediaFlowing } = this.state; return ( { this.videoTag = ref; }} muted /> ); } splitPluginItems() { const { pluginScreenshareHelperItems } = this.props; return pluginScreenshareHelperItems.reduce((result, item) => { switch (item.position) { case PluginSdk.ScreenshareHelperItemPosition.TOP_RIGHT: result.topRightPluginItems.push(item); break; case PluginSdk.ScreenshareHelperItemPosition.TOP_LEFT: result.topLeftPluginItems.push(item); break; case PluginSdk.ScreenshareHelperItemPosition.BOTTOM_RIGHT: result.bottomRightPluginItems.push(item); break; case PluginSdk.ScreenshareHelperItemPosition.BOTTOM_LEFT: result.bottomLeftPluginItems.push(item); break; default: break; } return result; }, { topRightPluginItems: [], topLeftPluginItems: [], bottomRightPluginItems: [], bottomLeftPluginItems: [], }); } renderScreensharePresenter() { const { switched } = this.state; const { isGloballyBroadcasting, intl } = this.props; return ( <> {this.renderVideo(switched)} { isGloballyBroadcasting ? (
{!switched && ScreenshareComponent.renderScreenshareContainerInside( intl.formatMessage(this.locales.presenterSharingLabel), )}
) : ScreenshareComponent.renderScreenshareContainerInside( intl.formatMessage(this.locales.presenterLoadingLabel), ) } ); } renderScreenshareDefault() { const { intl, enableVolumeControl } = this.props; const { loaded } = this.state; return ( <> {this.renderVideo(true)} {loaded && enableVolumeControl && this.renderVolumeSlider() } { !loaded ? ScreenshareComponent.renderScreenshareContainerInside( intl.formatMessage(this.locales.viewerLoadingLabel), ) : null } ); } renderScreenshareButtons() { const { isPresenter, isGloballyBroadcasting } = this.props; const { loaded } = this.state; const { topRightPluginItems, topLeftPluginItems, bottomRightPluginItems, bottomLeftPluginItems, } = this.splitPluginItems(); return ( <> {renderPluginItems(topLeftPluginItems, false, false)} {isPresenter // Presenter button: ? isGloballyBroadcasting && this.renderSwitchButton() // Non-presenter button: : loaded && this.renderFullscreenButton()} {renderPluginItems(topRightPluginItems, false, true)} {renderPluginItems(bottomLeftPluginItems, true, false)} {renderPluginItems(bottomRightPluginItems, true, true)} ); } render() { const { loaded, autoplayBlocked, mediaFlowing, switched, } = this.state; const { isPresenter, isGloballyBroadcasting, top, left, right, width, height, zIndex, fullscreenContext, } = this.props; // Conditions to render the (re)connecting dots and the unhealthy stream // grayscale: // 1 - The local media tag has not received any stream data yet // 2 - The user is a presenter and the stream wasn't globally broadcasted yet // 3 - The media was loaded, the stream was globally broadcasted BUT the stream // state transitioned to an unhealthy stream. tl;dr: screen sharing reconnection const shouldRenderConnectingState = !loaded || (isPresenter && !isGloballyBroadcasting) || (!mediaFlowing && loaded && isGloballyBroadcasting); const display = (width > 0 && height > 0) ? 'inherit' : 'none'; const Settings = getSettingsSingletonInstance(); const { animations } = Settings.application; return (
{(shouldRenderConnectingState) && (
)} {autoplayBlocked ? this.renderAutoplayOverlay() : null} { this.screenshareContainer = ref; }} id="screenshareContainer" > {this.renderScreenshareButtons()} {isPresenter ? this.renderScreensharePresenter() : this.renderScreenshareDefault()}
); } } export default injectIntl(ScreenshareComponent); ScreenshareComponent.propTypes = { intl: PropTypes.shape({ formatMessage: PropTypes.func.isRequired, }).isRequired, pluginScreenshareHelperItems: PropTypes.arrayOf(PropTypes.objectOf({ position: PropTypes.string, })).isRequired, isPresenter: PropTypes.bool.isRequired, layoutContextDispatch: PropTypes.func.isRequired, enableVolumeControl: PropTypes.bool.isRequired, outputDeviceId: PropTypes.string, };