bigbluebutton-Github/bigbluebutton-html5/imports/ui/components/video-preview/component.jsx

1382 lines
43 KiB
React
Raw Normal View History

2018-11-07 07:10:56 +08:00
import PropTypes from 'prop-types';
import React, { Component } from 'react';
2019-03-29 05:53:42 +08:00
import {
defineMessages, injectIntl, FormattedMessage,
2019-03-29 05:53:42 +08:00
} from 'react-intl';
2022-02-15 04:20:50 +08:00
import Button from '/imports/ui/components/common/button/component';
import VirtualBgSelector from '/imports/ui/components/video-preview/virtual-background/component'
import logger from '/imports/startup/client/logger';
import browserInfo from '/imports/utils/browserInfo';
import PreviewService from './service';
2024-06-17 19:54:03 +08:00
import VideoService from '/imports/ui/components/video-provider/service';
2021-10-28 21:16:36 +08:00
import Styled from './styles';
import deviceInfo from '/imports/utils/deviceInfo';
import MediaStreamUtils from '/imports/utils/media-stream-utils';
import { notify } from '/imports/ui/services/notification';
import {
EFFECT_TYPES,
setSessionVirtualBackgroundInfo,
getSessionVirtualBackgroundInfo,
removeSessionVirtualBackgroundInfo,
isVirtualBackgroundSupported,
} from '/imports/ui/services/virtual-background/service';
import { getSettingsSingletonInstance } from '/imports/ui/services/settings';
2022-08-26 22:50:46 +08:00
import Checkbox from '/imports/ui/components/common/checkbox/component'
import AppService from '/imports/ui/components/app/service';
import { CustomVirtualBackgroundsContext } from '/imports/ui/components/video-preview/virtual-background/context';
import VBGSelectorService from '/imports/ui/components/video-preview/virtual-background/service';
const VIEW_STATES = {
finding: 'finding',
found: 'found',
error: 'error',
};
2018-11-07 07:10:56 +08:00
const propTypes = {
intl: PropTypes.object.isRequired,
2018-11-07 07:10:56 +08:00
closeModal: PropTypes.func.isRequired,
startSharing: PropTypes.func.isRequired,
2019-12-19 01:50:16 +08:00
stopSharing: PropTypes.func.isRequired,
2019-07-24 06:24:31 +08:00
resolve: PropTypes.func,
camCapReached: PropTypes.bool,
2020-03-12 03:42:53 +08:00
hasVideoStream: PropTypes.bool.isRequired,
2019-07-27 00:48:51 +08:00
webcamDeviceId: PropTypes.string,
sharedDevices: PropTypes.arrayOf(PropTypes.string),
2018-11-07 07:10:56 +08:00
};
2019-07-24 06:24:31 +08:00
const defaultProps = {
resolve: null,
camCapReached: true,
2019-07-27 00:48:51 +08:00
webcamDeviceId: null,
2019-12-19 01:50:16 +08:00
sharedDevices: [],
2019-07-24 06:24:31 +08:00
};
2018-11-07 07:10:56 +08:00
const intlMessages = defineMessages({
webcamVirtualBackgroundTitle: {
id: 'app.videoPreview.webcamVirtualBackgroundLabel',
description: 'Title for the virtual background modal',
},
2018-11-07 07:10:56 +08:00
webcamSettingsTitle: {
id: 'app.videoPreview.webcamSettingsTitle',
description: 'Title for the video preview modal',
},
closeLabel: {
id: 'app.videoPreview.closeLabel',
description: 'Close button label',
},
2024-06-14 00:46:45 +08:00
cancelLabel: {
id: 'app.mobileAppModal.dismissLabel',
2024-06-14 00:46:45 +08:00
description: 'Close button label',
},
2018-11-07 07:10:56 +08:00
webcamPreviewLabel: {
id: 'app.videoPreview.webcamPreviewLabel',
description: 'Webcam preview label',
},
cameraLabel: {
id: 'app.videoPreview.cameraLabel',
description: 'Camera dropdown label',
},
qualityLabel: {
id: 'app.videoPreview.profileLabel',
description: 'Quality dropdown label',
},
low: {
id: 'app.videoPreview.quality.low',
description: 'Low quality option label',
},
medium: {
id: 'app.videoPreview.quality.medium',
description: 'Medium quality option label',
},
high: {
id: 'app.videoPreview.quality.high',
description: 'High quality option label',
},
hd: {
id: 'app.videoPreview.quality.hd',
description: 'High definition option label',
},
2018-11-07 07:10:56 +08:00
startSharingLabel: {
id: 'app.videoPreview.startSharingLabel',
2019-12-19 01:44:56 +08:00
description: 'Start sharing button label',
},
stopSharingLabel: {
id: 'app.videoPreview.stopSharingLabel',
description: 'Stop sharing button label',
},
2020-03-12 03:42:53 +08:00
stopSharingAllLabel: {
id: 'app.videoPreview.stopSharingAllLabel',
description: 'Stop sharing all button label',
},
2019-12-19 01:44:56 +08:00
sharedCameraLabel: {
id: 'app.videoPreview.sharedCameraLabel',
description: 'Already Shared camera label',
2018-11-07 07:10:56 +08:00
},
findingWebcamsLabel: {
id: 'app.videoPreview.findingWebcamsLabel',
description: 'Finding webcams label',
},
2018-11-07 07:10:56 +08:00
webcamOptionLabel: {
id: 'app.videoPreview.webcamOptionLabel',
description: 'Default webcam option label',
},
webcamNotFoundLabel: {
id: 'app.videoPreview.webcamNotFoundLabel',
description: 'Webcam not found label',
},
profileNotFoundLabel: {
id: 'app.videoPreview.profileNotFoundLabel',
description: 'Profile not found label',
},
permissionError: {
id: 'app.video.permissionError',
description: 'Error message for webcam permission',
},
AbortError: {
id: 'app.video.abortError',
description: 'Some problem occurred which prevented the device from being used',
},
OverconstrainedError: {
id: 'app.video.overconstrainedError',
description: 'No candidate devices which met the criteria requested',
},
SecurityError: {
id: 'app.video.securityError',
description: 'Media support is disabled on the Document',
},
TypeError: {
id: 'app.video.typeError',
description: 'List of constraints specified is empty, or has all constraints set to false',
},
NotFoundError: {
id: 'app.video.notFoundError',
description: 'error message when can not get webcam video',
},
NotAllowedError: {
id: 'app.video.notAllowed',
description: 'error message when webcam had permission denied',
},
NotSupportedError: {
id: 'app.video.notSupportedError',
description: 'error message when origin do not have ssl valid',
},
NotReadableError: {
id: 'app.video.notReadableError',
description: 'error message When the webcam is being used by other software',
},
TimeoutError: {
id: 'app.video.timeoutError',
description: 'error message when promise did not return',
},
iOSError: {
id: 'app.audioModal.iOSBrowser',
description: 'Audio/Video Not supported warning',
},
iOSErrorDescription: {
id: 'app.audioModal.iOSErrorDescription',
description: 'Audio/Video not supported description',
},
iOSErrorRecommendation: {
id: 'app.audioModal.iOSErrorRecommendation',
description: 'Audio/Video recommended action',
},
genericError: {
id: 'app.video.genericError',
description: 'error message for when the webcam sharing fails with unknown error',
},
camCapReached: {
id: 'app.video.camCapReached',
description: 'message for when the camera cap has been reached',
},
virtualBgGenericError: {
id: 'app.video.virtualBackground.genericError',
description: 'Failed to apply camera effect',
2021-07-20 21:41:14 +08:00
},
inactiveError: {
id: 'app.video.inactiveError',
description: 'Camera stopped unexpectedly',
},
2022-08-26 22:50:46 +08:00
brightness: {
id: 'app.videoPreview.brightness',
description: 'Brightness label',
},
wholeImageBrightnessLabel: {
id: 'app.videoPreview.wholeImageBrightnessLabel',
description: 'Whole image brightness label',
},
wholeImageBrightnessDesc: {
id: 'app.videoPreview.wholeImageBrightnessDesc',
description: 'Whole image brightness aria description',
},
cameraAsContentSettingsTitle: {
id: 'app.videoPreview.cameraAsContentSettingsTitle',
description: 'Title for the video preview modal when sharing camera as content',
},
sliderDesc: {
id: 'app.videoPreview.sliderDesc',
description: 'Brightness slider aria description',
},
2018-11-07 07:10:56 +08:00
});
class VideoPreview extends Component {
static contextType = CustomVirtualBackgroundsContext;
2018-11-07 07:10:56 +08:00
constructor(props) {
super(props);
const {
webcamDeviceId,
2018-11-07 07:10:56 +08:00
} = props;
this.handleProceed = this.handleProceed.bind(this);
this.handleStartSharing = this.handleStartSharing.bind(this);
this.handleStopSharing = this.handleStopSharing.bind(this);
2020-03-12 03:42:53 +08:00
this.handleStopSharingAll = this.handleStopSharingAll.bind(this);
this.handleSelectWebcam = this.handleSelectWebcam.bind(this);
this.handleSelectProfile = this.handleSelectProfile.bind(this);
this.handleVirtualBgSelected = this.handleVirtualBgSelected.bind(this);
this.handleLocalStreamInactive = this.handleLocalStreamInactive.bind(this);
2022-08-26 22:50:46 +08:00
this.handleBrightnessAreaChange = this.handleBrightnessAreaChange.bind(this);
2024-06-14 00:46:45 +08:00
this.handleSelectTab = this.handleSelectTab.bind(this);
2019-04-09 06:07:26 +08:00
this._isMounted = false;
this.state = {
2019-01-18 00:33:43 +08:00
webcamDeviceId,
2024-06-14 00:46:45 +08:00
selectedTab: 0,
availableWebcams: null,
2019-04-09 06:07:26 +08:00
selectedProfile: null,
isStartSharingDisabled: true,
viewState: VIEW_STATES.finding,
deviceError: null,
previewError: null,
2022-08-26 22:50:46 +08:00
brightness: 100,
wholeImageBrightness: false,
skipPreviewFailed: false,
};
}
set currentVideoStream (bbbVideoStream) {
// Stream is being unset - remove gUM revocation handler to avoid false negatives
if (this._currentVideoStream) {
this._currentVideoStream.removeListener('inactive', this.handleLocalStreamInactive);
}
// Set up inactivation handler for the new stream (to, eg, detect gUM revocation)
if (bbbVideoStream) {
bbbVideoStream.once('inactive', this.handleLocalStreamInactive);
}
this._currentVideoStream = bbbVideoStream;
}
get currentVideoStream () {
return this._currentVideoStream;
}
shouldSkipVideoPreview() {
const { skipPreviewFailed } = this.state;
const { forceOpen } = this.props;
return PreviewService.getSkipVideoPreview() && !forceOpen && !skipPreviewFailed;
}
componentDidMount() {
2019-11-21 02:35:16 +08:00
const {
webcamDeviceId,
forceOpen,
2019-11-21 02:35:16 +08:00
} = this.props;
this._isMounted = true;
if (deviceInfo.hasMediaDevices) {
navigator.mediaDevices.enumerateDevices().then(async (devices) => {
VideoService.updateNumberOfDevices(devices);
// Tries to skip video preview - this can happen if:
// 1. skipVideoPreview, skipVideoPreviewOnFirstJoin, or
// skipVideoPreviewIfPreviousDevice flags are enabled and meet their
// own conditions
// 2. forceOpen flag was not specified to this component
//
// This will fail if no skip conditions are met, or if an unexpected
// failure occurs during the process. In that case, the error will be
// handled and the component will display the default video preview UI
if (this.shouldSkipVideoPreview()) {
try {
await this.skipVideoPreview()
return;
} catch (error) {
logger.warn({
logCode: 'video_preview_skip_failure',
extraInfo: {
errorName: error.name,
errorMessage: error.message,
},
}, 'Skipping video preview failed');
}
}
// Late enumerateDevices resolution, stop.
if (!this._isMounted) return;
let {
webcams,
areLabelled,
areIdentified
} = PreviewService.digestVideoDevices(devices, webcamDeviceId);
logger.debug({
logCode: 'video_preview_enumerate_devices',
extraInfo: {
devices,
webcams,
},
}, `Enumerate devices came back. There are ${devices.length} devices and ${webcams.length} are video inputs`);
if (webcams.length > 0) {
await this.getInitialCameraStream(webcams[0].deviceId);
// Late gUM resolve, stop.
if (!this._isMounted) return;
if (!areLabelled || !areIdentified) {
// If they aren't labelled or have nullish deviceIds, run
// enumeration again and get their full versions
// Why: fingerprinting countermeasures obfuscate those when
// no permission was granted via gUM
try {
const newDevices = await navigator.mediaDevices.enumerateDevices();
webcams = PreviewService.digestVideoDevices(newDevices, webcamDeviceId).webcams;
} catch (error) {
// Not a critical error beucase it should only affect UI; log it
// and go ahead
logger.error({
logCode: 'video_preview_enumerate_relabel_failure',
extraInfo: {
errorName: error.name, errorMessage: error.message,
},
}, 'enumerateDevices for relabelling failed');
}
}
this.setState({
availableWebcams: webcams,
viewState: VIEW_STATES.found,
});
this.displayPreview();
} else {
// There were no webcams coming from enumerateDevices. Throw an error.
const noWebcamsError = new Error('NotFoundError');
this.handleDeviceError('enumerate', noWebcamsError, ': no webcams found');
}
}).catch((error) => {
// enumerateDevices failed
this.handleDeviceError('enumerate', error, 'enumerating devices');
});
} else {
// Top-level navigator.mediaDevices is not supported.
// The session went through the version checking, but somehow ended here.
// Nothing we can do.
const error = new Error('NotSupportedError');
this.handleDeviceError('mount', error, ': navigator.mediaDevices unavailable');
}
}
2022-08-26 22:50:46 +08:00
componentDidUpdate() {
if (this.brightnessMarker) {
const markerStyle = window.getComputedStyle(this.brightnessMarker);
const left = parseFloat(markerStyle.left);
const right = parseFloat(markerStyle.right);
if (left < 0) {
this.brightnessMarker.style.left = '0px';
this.brightnessMarker.style.right = 'auto';
} else if (right < 0) {
this.brightnessMarker.style.right = '0px';
this.brightnessMarker.style.left = 'auto';
}
}
}
componentWillUnmount() {
const { webcamDeviceId } = this.state;
this.terminateCameraStream(this.currentVideoStream, webcamDeviceId);
this.cleanupStreamAndVideo();
this._isMounted = false;
}
async startCameraBrightness() {
const ENABLE_CAMERA_BRIGHTNESS = window.meetingClientSettings.public.app.enableCameraBrightness;
const CAMERA_BRIGHTNESS_AVAILABLE = ENABLE_CAMERA_BRIGHTNESS && isVirtualBackgroundSupported();
if (CAMERA_BRIGHTNESS_AVAILABLE && this.currentVideoStream) {
const setBrightnessInfo = () => {
const stream = this.currentVideoStream || {};
const service = stream.virtualBgService || {};
const { brightness = 100, wholeImageBrightness = false } = service;
this.setState({ brightness, wholeImageBrightness });
};
if (!this.currentVideoStream.virtualBgService) {
const switched = await this.startVirtualBackground(
this.currentVideoStream,
EFFECT_TYPES.NONE_TYPE,
);
if (switched) setBrightnessInfo();
} else {
setBrightnessInfo();
}
}
}
async setCameraBrightness(brightness) {
const ENABLE_CAMERA_BRIGHTNESS = window.meetingClientSettings.public.app.enableCameraBrightness;
const CAMERA_BRIGHTNESS_AVAILABLE = ENABLE_CAMERA_BRIGHTNESS && isVirtualBackgroundSupported();
if (CAMERA_BRIGHTNESS_AVAILABLE && this.currentVideoStream) {
if (this.currentVideoStream?.virtualBgService == null) {
await this.startCameraBrightness();
}
this.currentVideoStream.changeCameraBrightness(brightness);
this.setState({ brightness });
}
}
2018-11-07 07:10:56 +08:00
handleSelectWebcam(event) {
const webcamValue = event.target.value;
2019-04-09 06:07:26 +08:00
this.getInitialCameraStream(webcamValue).then(() => {
this.displayPreview();
});
2019-04-09 06:07:26 +08:00
}
handleLocalStreamInactive({ id }) {
// id === MediaStream.id
if (this.currentVideoStream
&& typeof id === 'string'
&& this.currentVideoStream?.mediaStream?.id === id) {
this.setState({
isStartSharingDisabled: true,
});
this.handlePreviewError(
'stream_inactive',
new Error('inactiveError'),
'- preview camera stream inactive',
);
}
}
updateVirtualBackgroundInfo () {
const { webcamDeviceId } = this.state;
if (this.currentVideoStream) {
setSessionVirtualBackgroundInfo(
webcamDeviceId,
this.currentVideoStream.virtualBgType,
this.currentVideoStream.virtualBgName,
this.currentVideoStream.virtualBgUniqueId,
);
}
};
// Resolves into true if the background switch is successful, false otherwise
handleVirtualBgSelected(type, name, customParams) {
const { sharedDevices } = this.props;
const { webcamDeviceId, brightness } = this.state;
const shared = this.isAlreadyShared(webcamDeviceId);
const ENABLE_CAMERA_BRIGHTNESS = window.meetingClientSettings.public.app.enableCameraBrightness;
const CAMERA_BRIGHTNESS_AVAILABLE = ENABLE_CAMERA_BRIGHTNESS && isVirtualBackgroundSupported();
if (type !== EFFECT_TYPES.NONE_TYPE || CAMERA_BRIGHTNESS_AVAILABLE && brightness !== 100) {
return this.startVirtualBackground(this.currentVideoStream, type, name, customParams).then((switched) => {
// If it's not shared we don't have to update here because
// it will be updated in the handleStartSharing method.
if (switched && shared) this.updateVirtualBackgroundInfo();
return switched;
});
2021-07-20 21:41:14 +08:00
} else {
this.stopVirtualBackground(this.currentVideoStream);
if (shared) this.updateVirtualBackgroundInfo();
return Promise.resolve(true);
2021-07-20 21:41:14 +08:00
}
}
stopVirtualBackground(bbbVideoStream) {
if (bbbVideoStream) {
bbbVideoStream.stopVirtualBackground();
this.displayPreview();
2021-07-20 21:41:14 +08:00
}
}
startVirtualBackground(bbbVideoStream, type, name, customParams) {
this.setState({ isStartSharingDisabled: true });
2021-07-20 21:41:14 +08:00
if (bbbVideoStream == null) return Promise.resolve(false);
2021-07-20 21:41:14 +08:00
return bbbVideoStream.startVirtualBackground(type, name, customParams).then(() => {
this.displayPreview();
return true;
}).catch(error => {
this.handleVirtualBgError(error, type, name);
return false;
}).finally(() => {
this.setState({ isStartSharingDisabled: false });
});
2021-07-20 21:41:14 +08:00
}
2019-04-09 06:07:26 +08:00
handleSelectProfile(event) {
const profileValue = event.target.value;
const { webcamDeviceId } = this.state;
const selectedProfile = PreviewService.getCameraProfile(profileValue);
this.getCameraStream(webcamDeviceId, selectedProfile).then(() => {
this.displayPreview();
});
2018-11-07 07:10:56 +08:00
}
async handleStartSharing() {
2022-10-03 19:09:03 +08:00
const {
resolve,
startSharing,
cameraAsContent,
startSharingCameraAsContent,
2022-10-03 19:09:03 +08:00
} = this.props;
const {
webcamDeviceId,
selectedProfile,
brightness,
} = this.state;
// Only streams that will be shared should be stored in the service.
// If the store call returns false, we're duplicating stuff. So clean this one
// up because it's an impostor.
if(!PreviewService.storeStream(webcamDeviceId, this.currentVideoStream)) {
this.currentVideoStream.stop();
}
if (
this.currentVideoStream.virtualBgService
&& brightness === 100
&& this.currentVideoStream.virtualBgType === EFFECT_TYPES.NONE_TYPE
) {
this.stopVirtualBackground(this.currentVideoStream);
}
if (!cameraAsContent) {
// Store selected profile, camera ID and virtual background in the storage
// for future use
PreviewService.changeProfile(selectedProfile);
PreviewService.changeWebcam(webcamDeviceId);
this.updateVirtualBackgroundInfo();
this.cleanupStreamAndVideo();
startSharing(webcamDeviceId);
} else {
this.cleanupStreamAndVideo();
startSharingCameraAsContent(webcamDeviceId);
}
}
2019-12-19 01:44:56 +08:00
handleStopSharing() {
const { resolve, stopSharing, stopSharingCameraAsContent } = this.props;
2019-12-19 01:44:56 +08:00
const { webcamDeviceId } = this.state;
if (this.isCameraAsContentDevice(webcamDeviceId)) {
stopSharingCameraAsContent();
} else {
PreviewService.deleteStream(webcamDeviceId);
stopSharing(webcamDeviceId);
this.cleanupStreamAndVideo();
}
if (resolve) resolve();
}
2020-03-12 03:42:53 +08:00
handleStopSharingAll() {
const { resolve, stopSharing } = this.props;
stopSharing();
if (resolve) resolve();
}
handleProceed() {
const { resolve, closeModal, sharedDevices } = this.props;
const { webcamDeviceId, brightness } = this.state;
const shared = sharedDevices.includes(webcamDeviceId);
if (
(shared)
&& this.currentVideoStream.virtualBgService
&& brightness === 100
&& this.currentVideoStream.virtualBgType === EFFECT_TYPES.NONE_TYPE
) {
this.stopVirtualBackground(this.currentVideoStream);
}
this.terminateCameraStream(this.currentVideoStream, webcamDeviceId);
2019-01-18 00:33:43 +08:00
closeModal();
if (resolve) resolve();
}
handlePreviewError(logCode, error, description) {
logger.warn({
logCode: `video_preview_${logCode}_error`,
extraInfo: {
errorName: error.name,
errorMessage: error.message,
},
}, `Error ${description}`);
this.setState({
previewError: this.handleGUMError(error),
});
}
handleDeviceError(logCode, error, description) {
logger.warn({
logCode: `video_preview_${logCode}_error`,
extraInfo: {
errorName: error.name,
errorMessage: error.message,
},
}, `Error ${description}`);
this.setState({
viewState: VIEW_STATES.error,
deviceError: this.handleGUMError(error),
});
}
handleGUMError(error) {
const { intl } = this.props;
logger.error({
logCode: 'video_preview_gum_failure',
extraInfo: {
errorName: error.name, errorMessage: error.message,
},
}, 'getUserMedia failed in video-preview');
const intlError = intlMessages[error.name] || intlMessages[error.message];
if (intlError) {
return intl.formatMessage(intlError);
}
return intl.formatMessage(intlMessages.genericError,
{ 0: `${error.name}: ${error.message}` });
}
terminateCameraStream(stream, deviceId) {
if (stream) {
// Stream is being destroyed - remove gUM revocation handler to avoid false negatives
stream.removeListener('inactive', this.handleLocalStreamInactive);
PreviewService.terminateCameraStream(stream, deviceId);
}
}
cleanupStreamAndVideo() {
this.currentVideoStream = null;
if (this.video) this.video.srcObject = null;
}
handleVirtualBgError(error, type, name) {
const { intl } = this.props;
logger.error({
logCode: `video_preview_virtualbg_error`,
2021-07-20 21:41:14 +08:00
extraInfo: {
errorName: error.name,
errorMessage: error.message,
virtualBgType: type,
virtualBgName: name,
2021-07-20 21:41:14 +08:00
},
}, `Failed to toggle virtual background: ${error.message}`);
notify(intl.formatMessage(intlMessages.virtualBgGenericError), 'error', 'video');
2021-07-20 21:41:14 +08:00
}
updateDeviceId (deviceId) {
let actualDeviceId = deviceId;
if (!actualDeviceId && this.currentVideoStream) {
actualDeviceId = MediaStreamUtils.extractDeviceIdFromStream(
this.currentVideoStream.mediaStream,
'video',
);
}
this.setState({ webcamDeviceId: actualDeviceId, });
}
2019-04-09 06:07:26 +08:00
getInitialCameraStream(deviceId) {
const { cameraAsContent } = this.props;
const defaultProfile = !cameraAsContent ? PreviewService.getDefaultProfile() : PreviewService.getCameraAsContentProfile();
return this.getCameraStream(deviceId, defaultProfile);
}
applyStoredVirtualBg(deviceId = null) {
const webcamDeviceId = deviceId || this.state.webcamDeviceId;
// Apply the virtual background stored in Local/Session Storage, if any
// If it fails, remove the stored background.
return new Promise((resolve, reject) => {
let customParams;
const virtualBackground = getSessionVirtualBackgroundInfo(webcamDeviceId);
if (virtualBackground) {
const { type, name, uniqueId } = virtualBackground;
const handleFailure = (error) => {
this.handleVirtualBgError(error, type, name);
removeSessionVirtualBackgroundInfo(webcamDeviceId);
reject(error);
};
const applyCustomVirtualBg = (backgrounds) => {
const background = backgrounds[uniqueId]
|| Object.values(backgrounds).find(bg => bg.uniqueId === uniqueId);
if (background && background.data) {
customParams = {
uniqueId,
file: background?.data,
};
} else {
handleFailure(new Error('Missing virtual background data'));
return;
}
this.handleVirtualBgSelected(type, name, customParams).then(resolve, handleFailure);
};
// If uniqueId is defined, this is a custom background. Fetch the custom
// params from the context and apply them
if (uniqueId) {
if (!this.context.loaded) {
// Virtual BG context might not be loaded yet (in case this is
// skipping the video preview). Load it manually.
VBGSelectorService.load(handleFailure, applyCustomVirtualBg);
} else {
applyCustomVirtualBg(this.context.backgrounds);
}
return;
}
// Built-in background, just apply it.
this.handleVirtualBgSelected(type, name, customParams).then(resolve, handleFailure);
} else {
resolve();
}
});
2019-04-09 06:07:26 +08:00
}
async getCameraStream(deviceId, profile) {
const { webcamDeviceId } = this.state;
const { cameraAsContent, forceOpen } = this.props;
this.setState({
selectedProfile: profile.id,
isStartSharingDisabled: true,
previewError: undefined,
});
this.terminateCameraStream(this.currentVideoStream, webcamDeviceId);
this.cleanupStreamAndVideo();
2019-04-09 06:07:26 +08:00
try {
// The return of doGUM is an instance of BBBVideoStream (a thin wrapper over a MediaStream)
const bbbVideoStream = await PreviewService.doGUM(deviceId, profile);
this.currentVideoStream = bbbVideoStream;
this.updateDeviceId(deviceId);
} catch(error) {
// When video preview is set to skip, we need some way to bubble errors
// up to users; so re-throw the error
if (!this.shouldSkipVideoPreview()) {
this.handlePreviewError('do_gum_preview', error, 'displaying final selection');
} else {
throw error;
}
}
// Restore virtual background if it was stored in Local/Session Storage
try {
if (!cameraAsContent) await this.applyStoredVirtualBg(deviceId);
} catch (error) {
// Only bubble up errors in this case if we're skipping the video preview
// This is because virtual background failures are deemed critical when
// skipping the video preview, but not otherwise
if (this.shouldSkipVideoPreview()) {
throw error;
}
} finally {
// Late VBG resolve, clean up tracks, stop.
if (!this._isMounted) {
this.terminateCameraStream(bbbVideoStream, deviceId);
this.cleanupStreamAndVideo();
return;
}
this.setState({
isStartSharingDisabled: false,
});
}
2019-04-09 06:07:26 +08:00
}
displayPreview() {
if (this.currentVideoStream && this.video) {
this.video.srcObject = this.currentVideoStream.mediaStream;
}
}
skipVideoPreview() {
const { webcamDeviceId } = this.state;
const { forceOpen } = this.props;
return this.getInitialCameraStream(webcamDeviceId).then(() => {
this.handleStartSharing();
}).catch(error => {
PreviewService.clearWebcamDeviceId();
PreviewService.clearWebcamProfileId();
removeSessionVirtualBackgroundInfo(webcamDeviceId);
this.cleanupStreamAndVideo();
// Mark the skip as failed so that the component will override any option
// to skip the video preview and display the default UI
if (this._isMounted) this.setState({ skipPreviewFailed: true });
throw error;
});
}
supportWarning() {
const { intl } = this.props;
return (
<div>
2021-10-28 21:16:36 +08:00
<Styled.Warning>!</Styled.Warning>
<Styled.Main>{intl.formatMessage(intlMessages.iOSError)}</Styled.Main>
<Styled.Text>{intl.formatMessage(intlMessages.iOSErrorDescription)}</Styled.Text>
<Styled.Text>
{intl.formatMessage(intlMessages.iOSErrorRecommendation)}
2021-10-28 21:16:36 +08:00
</Styled.Text>
</div>
);
}
getFallbackLabel(webcam, index) {
const { intl } = this.props;
return `${intl.formatMessage(intlMessages.cameraLabel)} ${index}`
}
isAlreadyShared (webcamId) {
const { sharedDevices, cameraAsContentDeviceId } = this.props;
return sharedDevices.includes(webcamId) || webcamId === cameraAsContentDeviceId;
}
isCameraAsContentDevice (deviceId) {
const { cameraAsContentDeviceId } = this.props;
return deviceId === cameraAsContentDeviceId;
}
renderDeviceSelectors() {
2018-11-07 07:10:56 +08:00
const {
intl,
sharedDevices,
cameraAsContent,
2018-11-07 07:10:56 +08:00
} = this.props;
2019-01-18 00:33:43 +08:00
const {
webcamDeviceId,
availableWebcams,
2023-04-28 00:38:27 +08:00
selectedProfile,
} = this.state;
2024-06-14 00:46:45 +08:00
return (
<Styled.InternCol>
2024-06-14 00:46:45 +08:00
<Styled.Label htmlFor="setCam">
{intl.formatMessage(intlMessages.cameraLabel)}
</Styled.Label>
{ availableWebcams && availableWebcams.length > 0
? (
<Styled.Select
id="setCam"
value={webcamDeviceId || ''}
onChange={this.handleSelectWebcam}
>
{availableWebcams.map((webcam, index) => (
<option key={webcam.deviceId} value={webcam.deviceId}>
{webcam.label || this.getFallbackLabel(webcam, index)}
</option>
))}
</Styled.Select>
)
: (
<span>
{intl.formatMessage(intlMessages.webcamNotFoundLabel)}
</span>
)
}
{this.renderQualitySelector()}
</Styled.InternCol>
2024-06-14 00:46:45 +08:00
);
}
2019-12-19 01:44:56 +08:00
2024-06-14 00:46:45 +08:00
renderQualitySelector() {
const {
intl,
cameraAsContent,
} = this.props
const {
selectedProfile,
availableWebcams,
webcamDeviceId,
} = this.state;
2024-06-14 00:46:45 +08:00
const shared = this.isAlreadyShared(webcamDeviceId);
if (shared) {
return (
2024-06-14 00:46:45 +08:00
<Styled.Label>
{intl.formatMessage(intlMessages.sharedCameraLabel)}
</Styled.Label>
2022-08-26 22:50:46 +08:00
);
}
if (cameraAsContent) return;
const CAMERA_PROFILES = window.meetingClientSettings.public.kurento.cameraProfiles || [];
// Filtered, without hidden profiles
const PREVIEW_CAMERA_PROFILES = CAMERA_PROFILES.filter(p => !p.hidden);
return (
2022-08-26 22:50:46 +08:00
<>
2024-06-14 00:46:45 +08:00
<Styled.Label htmlFor="setQuality">
{intl.formatMessage(intlMessages.qualityLabel)}
</Styled.Label>
{PREVIEW_CAMERA_PROFILES.length > 0
2024-06-14 00:46:45 +08:00
? (
<Styled.Select
id="setQuality"
value={selectedProfile || ''}
onChange={this.handleSelectProfile}
>
{PREVIEW_CAMERA_PROFILES.map((profile) => {
2024-06-14 00:46:45 +08:00
const label = intlMessages[`${profile.id}`]
? intl.formatMessage(intlMessages[`${profile.id}`])
: profile.name;
return (
<option key={profile.id} value={profile.id}>
{`${label}`}
</option>
2024-06-14 00:46:45 +08:00
);
})}
</Styled.Select>
)
: (
<span>
{intl.formatMessage(intlMessages.profileNotFoundLabel)}
</span>
)
}
2022-08-26 22:50:46 +08:00
</>
);
}
async handleBrightnessAreaChange() {
const ENABLE_CAMERA_BRIGHTNESS = window.meetingClientSettings.public.app.enableCameraBrightness;
const CAMERA_BRIGHTNESS_AVAILABLE = ENABLE_CAMERA_BRIGHTNESS && isVirtualBackgroundSupported();
if (CAMERA_BRIGHTNESS_AVAILABLE && this.currentVideoStream) {
if (this.currentVideoStream?.virtualBgService == null) {
await this.startCameraBrightness();
}
const { wholeImageBrightness } = this.state;
this.currentVideoStream.toggleCameraBrightnessArea(!wholeImageBrightness);
this.setState({ wholeImageBrightness: !wholeImageBrightness });
}
2022-08-26 22:50:46 +08:00
}
renderBrightnessInput() {
const {
cameraAsContent,
cameraAsContentDeviceId,
} = this.props;
2023-04-28 00:38:27 +08:00
const {
webcamDeviceId,
} = this.state;
const ENABLE_CAMERA_BRIGHTNESS = window.meetingClientSettings.public.app.enableCameraBrightness;
2022-08-26 22:50:46 +08:00
if (!ENABLE_CAMERA_BRIGHTNESS) return null;
const { intl } = this.props;
const { brightness, wholeImageBrightness, isStartSharingDisabled } = this.state;
const shared = this.isAlreadyShared(webcamDeviceId);
2022-08-26 22:50:46 +08:00
const origin = brightness <= 100 ? 'left' : 'right';
const offset = origin === 'left'
? (brightness * 100) / 200
: ((200 - brightness) * 100) / 200;
if(cameraAsContent || webcamDeviceId === cameraAsContentDeviceId){ return null }
2022-08-26 22:50:46 +08:00
return (
<Styled.InternCol>
2022-08-26 22:50:46 +08:00
<Styled.Label htmlFor="brightness">
{intl.formatMessage(intlMessages.brightness)}
</Styled.Label>
<div aria-hidden>
2022-08-26 22:50:46 +08:00
<Styled.MarkerDynamicWrapper>
<Styled.MarkerDynamic
ref={(ref) => this.brightnessMarker = ref}
style={{ [origin]: `calc(${offset}% - 1rem)` }}
>
{brightness - 100}
</Styled.MarkerDynamic>
</Styled.MarkerDynamicWrapper>
</div>
<input
id="brightness"
style={{ width: '100%' }}
type="range"
min={0}
max={200}
value={brightness}
2023-01-26 03:50:10 +08:00
aria-describedby={'brightness-slider-desc'}
2022-08-26 22:50:46 +08:00
onChange={(e) => {
const brightness = e.target.valueAsNumber;
this.setCameraBrightness(brightness);
2022-08-26 22:50:46 +08:00
}}
disabled={!isVirtualBackgroundSupported() || isStartSharingDisabled}
2022-08-26 22:50:46 +08:00
/>
<div style={{ display: 'none' }} id={'brightness-slider-desc'}>
{intl.formatMessage(intlMessages.sliderDesc)}
</div>
<Styled.MarkerWrapper aria-hidden>
2022-08-26 22:50:46 +08:00
<Styled.Marker>{'-100'}</Styled.Marker>
<Styled.Marker>{'0'}</Styled.Marker>
<Styled.Marker>{'100'}</Styled.Marker>
</Styled.MarkerWrapper>
<div style={{ display: 'flex', marginTop: '.5rem' }}>
<Checkbox
onChange={this.handleBrightnessAreaChange}
checked={wholeImageBrightness}
ariaLabel={intl.formatMessage(intlMessages.wholeImageBrightnessLabel)}
ariaDescribedBy={'whole-image-desc'}
ariaDesc={intl.formatMessage(intlMessages.wholeImageBrightnessDesc)}
disabled={!isVirtualBackgroundSupported() || isStartSharingDisabled}
2022-12-15 04:03:23 +08:00
label={intl.formatMessage(intlMessages.wholeImageBrightnessLabel)}
2022-08-26 22:50:46 +08:00
/>
</div>
</Styled.InternCol>
);
}
renderVirtualBgSelector() {
const { isCustomVirtualBackgroundsEnabled } = this.props;
const { isStartSharingDisabled, webcamDeviceId } = this.state;
const initialVirtualBgState = this.currentVideoStream ? {
type: this.currentVideoStream.virtualBgType,
name: this.currentVideoStream.virtualBgName,
uniqueId: this.currentVideoStream.virtualBgUniqueId,
} : getSessionVirtualBackgroundInfo(webcamDeviceId);
const {
showThumbnails: SHOW_THUMBNAILS = true,
} = window.meetingClientSettings.public.virtualBackgrounds;
return (
<VirtualBgSelector
handleVirtualBgSelected={this.handleVirtualBgSelected}
locked={isStartSharingDisabled}
showThumbnails={SHOW_THUMBNAILS}
initialVirtualBgState={initialVirtualBgState}
isCustomVirtualBackgroundsEnabled={isCustomVirtualBackgroundsEnabled}
/>
);
}
2024-06-14 00:46:45 +08:00
renderTabsContent(tabNumber) {
const {
cameraAsContent,
isVirtualBackgroundsEnabled,
2024-06-14 00:46:45 +08:00
} = this.props;
const shouldShowVirtualBackgrounds = isVirtualBackgroundsEnabled && !cameraAsContent;
return (
<Styled.ContentCol>
{tabNumber === 0 && (
2024-06-14 00:46:45 +08:00
<Styled.Col>
{this.renderDeviceSelectors()}
{isVirtualBackgroundSupported() && this.renderBrightnessInput()}
2024-06-14 00:46:45 +08:00
</Styled.Col>
)}
{tabNumber === 1 && shouldShowVirtualBackgrounds && (
<Styled.BgnCol>
{this.renderVirtualBgSelector()}
</Styled.BgnCol>
)}
</Styled.ContentCol>
);
2024-06-14 00:46:45 +08:00
}
renderContent(selectedTab) {
const {
intl,
} = this.props;
const {
viewState,
deviceError,
previewError,
} = this.state;
const Settings = getSettingsSingletonInstance();
2021-10-28 21:16:36 +08:00
const { animations } = Settings.application;
const containerStyle = {
width: '60%',
height: '25vh',
display: 'flex',
justifyContent: 'center',
alignItems: 'center',
};
switch (viewState) {
case VIEW_STATES.finding:
return (
2021-10-28 21:16:36 +08:00
<Styled.Content>
<Styled.VideoCol>
<div style={containerStyle}>
<span>{intl.formatMessage(intlMessages.findingWebcamsLabel)}</span>
2021-10-28 21:16:36 +08:00
<Styled.FetchingAnimation animations={animations} />
</div>
2021-10-28 21:16:36 +08:00
</Styled.VideoCol>
</Styled.Content>
);
case VIEW_STATES.error:
return (
2021-10-28 21:16:36 +08:00
<Styled.Content>
<Styled.VideoCol><div>{deviceError}</div></Styled.VideoCol>
</Styled.Content>
);
case VIEW_STATES.found:
default:
return (
2021-10-28 21:16:36 +08:00
<Styled.Content>
<Styled.VideoCol>
{
previewError
? (
<div>{previewError}</div>
)
: (
2021-10-28 21:16:36 +08:00
<Styled.VideoPreview
mirroredVideo={VideoService.mirrorOwnWebcam()}
id="preview"
data-test={VideoService.mirrorOwnWebcam() ? 'mirroredVideoPreview' : 'videoPreview'}
ref={(ref) => { this.video = ref; }}
autoPlay
playsInline
muted
/>
)
}
2021-10-28 21:16:36 +08:00
</Styled.VideoCol>
2024-06-14 00:46:45 +08:00
{this.renderTabsContent(selectedTab)}
2021-10-28 21:16:36 +08:00
</Styled.Content>
);
}
}
getModalTitle() {
const { intl, cameraAsContent } = this.props;
if (cameraAsContent) return intl.formatMessage(intlMessages.cameraAsContentSettingsTitle);
return intl.formatMessage(intlMessages.webcamSettingsTitle);
}
2024-06-14 00:46:45 +08:00
renderModalContent(selectedTab) {
const {
intl,
2020-03-12 03:42:53 +08:00
hasVideoStream,
forceOpen,
camCapReached,
2024-06-14 00:46:45 +08:00
closeModal,
} = this.props;
const {
2019-01-18 00:33:43 +08:00
isStartSharingDisabled,
2019-12-19 01:44:56 +08:00
webcamDeviceId,
deviceError,
previewError,
2019-01-18 00:33:43 +08:00
} = this.state;
const shouldDisableButtons = this.shouldSkipVideoPreview()
&& !(deviceError || previewError);
2019-12-19 01:44:56 +08:00
const shared = this.isAlreadyShared(webcamDeviceId);
2019-12-19 01:44:56 +08:00
const showStopAllButton = hasVideoStream && VideoService.isMultipleCamerasEnabled();
const { isIe } = browserInfo;
2018-11-07 07:10:56 +08:00
return (
2021-11-11 01:52:58 +08:00
<>
{isIe ? (
2021-10-28 21:16:36 +08:00
<Styled.BrowserWarning>
<FormattedMessage
id="app.audioModal.unsupportedBrowserLabel"
description="Warning when someone joins with a browser that isn't supported"
values={{
0: <a href="https://www.google.com/chrome/">Chrome</a>,
1: <a href="https://getfirefox.com">Firefox</a>,
}}
/>
2021-10-28 21:16:36 +08:00
</Styled.BrowserWarning>
2019-07-24 06:24:31 +08:00
) : null}
2024-06-14 00:46:45 +08:00
{this.renderContent(selectedTab)}
<Styled.Footer>
<Styled.BottomSeparator />
<Styled.FooterContainer>
{showStopAllButton ? (
<Styled.ExtraActions>
<Styled.StopAllButton
color="danger"
label={intl.formatMessage(intlMessages.stopSharingAllLabel)}
onClick={this.handleStopSharingAll}
disabled={shouldDisableButtons}
/>
</Styled.ExtraActions>
) : null}
{!shared && camCapReached ? (
<span>{intl.formatMessage(intlMessages.camCapReached)}</span>
) : (
<div style={{ display: 'flex' }}>
<Styled.CancelButton
data-test="cancelSharingWebcam"
label={intl.formatMessage(intlMessages.cancelLabel)}
onClick={closeModal}
/>
<Styled.SharingButton
data-test="startSharingWebcam"
color={shared ? 'danger' : 'primary'}
label={intl.formatMessage(shared ? intlMessages.stopSharingLabel : intlMessages.startSharingLabel)}
onClick={shared ? this.handleStopSharing : this.handleStartSharing}
disabled={isStartSharingDisabled || isStartSharingDisabled === null || shouldDisableButtons}
/>
</div>
)}
</Styled.FooterContainer>
</Styled.Footer>
2021-11-11 01:52:58 +08:00
</>
);
}
2024-06-14 00:46:45 +08:00
handleSelectTab(tab) {
this.setState({
selectedTab: tab,
});
}
render() {
const {
intl,
isCamLocked,
forceOpen,
isOpen,
priority,
cameraAsContent,
cameraAsContentDeviceId,
isVirtualBackgroundsEnabled,
} = this.props;
const { selectedTab, webcamDeviceId } = this.state;
2024-06-14 00:46:45 +08:00
const BASE_NAME = window.meetingClientSettings.public.app.basename;
const WebcamSettingsImg = `${BASE_NAME}/resources/images/webcam_settings.svg`;
const WebcamBackgroundImg = `${BASE_NAME}/resources/images/webcam_background.svg`;
const darkThemeState = AppService.isDarkThemeEnabled();
if (isCamLocked === true) {
this.handleProceed();
return null;
}
if (this.shouldSkipVideoPreview()) {
return null;
}
const {
deviceError,
previewError,
} = this.state;
const allowCloseModal = !!(deviceError || previewError)
|| !PreviewService.getSkipVideoPreview()
|| forceOpen;
const shouldShowVirtualBackgroundsTab = isVirtualBackgroundsEnabled
&& !cameraAsContent
&& !(webcamDeviceId === cameraAsContentDeviceId)
&& isVirtualBackgroundSupported()
return (
2021-10-28 21:16:36 +08:00
<Styled.VideoPreviewModal
onRequestClose={this.handleProceed}
contentLabel={intl.formatMessage(intlMessages.webcamSettingsTitle)}
shouldShowCloseButton={allowCloseModal}
shouldCloseOnOverlayClick={allowCloseModal}
2021-12-10 22:55:37 +08:00
isPhone={deviceInfo.isPhone}
2022-01-20 21:03:18 +08:00
data-test="webcamSettingsModal"
{...{
isOpen,
priority,
}}
>
2024-06-14 00:46:45 +08:00
<Styled.Container>
<Styled.Header>
<Styled.WebcamTabs
onSelect={this.handleSelectTab}
selectedIndex={selectedTab}
>
<Styled.WebcamTabList>
<Styled.WebcamTabSelector selectedClassName="is-selected">
<Styled.IconSvg
src={WebcamSettingsImg}
darkThemeState={darkThemeState}
2024-06-14 00:46:45 +08:00
/>
<span
id="webcam-settings-title">{this.getModalTitle()}
2024-06-14 00:46:45 +08:00
</span>
</Styled.WebcamTabSelector>
{shouldShowVirtualBackgroundsTab && (
<>
<Styled.HeaderSeparator />
<Styled.WebcamTabSelector selectedClassName="is-selected">
<Styled.IconSvg
src={WebcamBackgroundImg}
darkThemeState={darkThemeState}
/>
<span id="backgrounds-title">{intl.formatMessage(intlMessages.webcamVirtualBackgroundTitle)}</span>
</Styled.WebcamTabSelector>
</>
)}
2024-06-14 00:46:45 +08:00
</Styled.WebcamTabList>
</Styled.WebcamTabs>
</Styled.Header>
{deviceInfo.hasMediaDevices
? this.renderModalContent(selectedTab)
: this.supportWarning()
}
</Styled.Container>
2021-10-28 21:16:36 +08:00
</Styled.VideoPreviewModal>
2018-11-07 07:10:56 +08:00
);
}
}
VideoPreview.propTypes = propTypes;
2019-07-24 06:24:31 +08:00
VideoPreview.defaultProps = defaultProps;
2018-11-07 07:10:56 +08:00
export default injectIntl(VideoPreview);