/* * (C) Copyright 2017-2018 OpenVidu (https://openvidu.io/) * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ import { OpenVidu } from './OpenVidu'; import { Session } from './Session'; import { Stream } from './Stream'; import { StreamManager } from './StreamManager'; import { EventDispatcher } from '../OpenViduInternal/Interfaces/Public/EventDispatcher'; import { PublisherProperties } from '../OpenViduInternal/Interfaces/Public/PublisherProperties'; import { InboundStreamOptions } from '../OpenViduInternal/Interfaces/Private/InboundStreamOptions'; import { OutboundStreamOptions } from '../OpenViduInternal/Interfaces/Private/OutboundStreamOptions'; import { Event } from '../OpenViduInternal/Events/Event'; import { StreamEvent } from '../OpenViduInternal/Events/StreamEvent'; import { VideoElementEvent } from '../OpenViduInternal/Events/VideoElementEvent'; import { OpenViduError, OpenViduErrorName } from '../OpenViduInternal/Enums/OpenViduError'; import { VideoInsertMode } from '../OpenViduInternal/Enums/VideoInsertMode'; /** * Packs local media streams. Participants can publish it to a session. Initialized with [[OpenVidu.initPublisher]] method */ export class Publisher extends StreamManager { /** * Whether the Publisher has been granted access to the requested input devices or not */ accessAllowed = false; /** * Whether you have called [[Publisher.subscribeToRemote]] with value `true` or `false` (false by default) */ isSubscribedToRemote = false; /** * The [[Session]] to which the Publisher belongs */ session: Session; // Initialized by Session.publish(Publisher) private accessDenied = false; private properties: PublisherProperties; private permissionDialogTimeout: NodeJS.Timer; /** * @hidden */ constructor(targEl: string | HTMLElement, properties: PublisherProperties, private openvidu: OpenVidu) { super(new Stream((!!openvidu.session) ? openvidu.session : new Session(openvidu), { publisherProperties: properties, mediaConstraints: {} }), targEl); this.properties = properties; this.stream.ee.on('local-stream-destroyed-by-disconnect', (reason: string) => { const streamEvent = new StreamEvent(true, this, 'streamDestroyed', this.stream, reason); this.ee.emitEvent('streamDestroyed', [streamEvent]); streamEvent.callDefaultBehaviour(); }); } /** * Publish or unpublish the audio stream (if available). Calling this method twice in a row passing same value will have no effect * @param value `true` to publish the audio stream, `false` to unpublish it */ publishAudio(value: boolean): void { this.stream.getWebRtcPeer().audioEnabled = value; console.info("'Publisher' has " + (value ? 'published' : 'unpublished') + ' its audio stream'); } /** * Publish or unpublish the video stream (if available). Calling this method twice in a row passing same value will have no effect * @param value `true` to publish the video stream, `false` to unpublish it */ publishVideo(value: boolean): void { this.stream.getWebRtcPeer().videoEnabled = value; console.info("'Publisher' has " + (value ? 'published' : 'unpublished') + ' its video stream'); } /** * Call this method before [[Session.publish]] to subscribe to your Publisher's stream as any other user would do. The local video will be automatically replaced by the remote video */ subscribeToRemote(value?: boolean): void { value = (value !== undefined) ? value : true; this.isSubscribedToRemote = value; this.stream.subscribeToMyRemote(value); } /** * See [[EventDispatcher.on]] */ on(type: string, handler: (event: Event) => void): EventDispatcher { super.on(type, handler); if (type === 'streamCreated') { if (!!this.stream && this.stream.isLocalStreamPublished) { this.ee.emitEvent('streamCreated', [new StreamEvent(false, this, 'streamCreated', this.stream, '')]); } else { this.stream.ee.on('stream-created-by-publisher', () => { this.ee.emitEvent('streamCreated', [new StreamEvent(false, this, 'streamCreated', this.stream, '')]); }); } } if (type === 'remoteVideoPlaying') { if (this.stream.displayMyRemote() && this.videos[0] && this.videos[0].video && this.videos[0].video.currentTime > 0 && this.videos[0].video.paused === false && this.videos[0].video.ended === false && this.videos[0].video.readyState === 4) { this.ee.emitEvent('remoteVideoPlaying', [new VideoElementEvent(this.videos[0].video, this, 'remoteVideoPlaying')]); } } if (type === 'accessAllowed') { if (this.accessAllowed) { this.ee.emitEvent('accessAllowed'); } } if (type === 'accessDenied') { if (this.accessDenied) { this.ee.emitEvent('accessDenied'); } } return this; } /** * See [[EventDispatcher.once]] */ once(type: string, handler: (event: Event) => void): Publisher { super.once(type, handler); if (type === 'streamCreated') { if (!!this.stream && this.stream.isLocalStreamPublished) { this.ee.emitEvent('streamCreated', [new StreamEvent(false, this, 'streamCreated', this.stream, '')]); } else { this.stream.ee.once('stream-created-by-publisher', () => { this.ee.emitEvent('streamCreated', [new StreamEvent(false, this, 'streamCreated', this.stream, '')]); }); } } if (type === 'remoteVideoPlaying') { if (this.stream.displayMyRemote() && this.videos[0] && this.videos[0].video && this.videos[0].video.currentTime > 0 && this.videos[0].video.paused === false && this.videos[0].video.ended === false && this.videos[0].video.readyState === 4) { this.ee.emitEvent('remoteVideoPlaying', [new VideoElementEvent(this.videos[0].video, this, 'remoteVideoPlaying')]); } } if (type === 'accessAllowed') { if (this.accessAllowed) { this.ee.emitEvent('accessAllowed'); } } if (type === 'accessDenied') { if (this.accessDenied) { this.ee.emitEvent('accessDenied'); } } return this; } /* Hidden methods */ /** * @hidden */ initialize(): Promise { return new Promise((resolve, reject) => { const errorCallback = (openViduError: OpenViduError) => { this.accessDenied = true; this.accessAllowed = false; reject(openViduError); }; const successCallback = (mediaStream: MediaStream) => { this.accessAllowed = true; this.accessDenied = false; if (this.openvidu.isMediaStreamTrack(this.properties.audioSource)) { mediaStream.removeTrack(mediaStream.getAudioTracks()[0]); mediaStream.addTrack((this.properties.audioSource)); } if (this.openvidu.isMediaStreamTrack(this.properties.videoSource)) { mediaStream.removeTrack(mediaStream.getVideoTracks()[0]); mediaStream.addTrack((this.properties.videoSource)); } // Apply PublisherProperties.publishAudio and PublisherProperties.publishVideo if (!!mediaStream.getAudioTracks()[0]) { mediaStream.getAudioTracks()[0].enabled = !!this.stream.outboundStreamOpts.publisherProperties.publishAudio; } if (!!mediaStream.getVideoTracks()[0]) { mediaStream.getVideoTracks()[0].enabled = !!this.stream.outboundStreamOpts.publisherProperties.publishVideo; } this.stream.setMediaStream(mediaStream); if (!this.stream.displayMyRemote()) { // When we are subscribed to our remote we don't still set the MediaStream object in the video elements to // avoid early 'streamPlaying' event this.stream.updateMediaStreamInVideos(); } this.stream.isLocalStreamReadyToPublish = true; this.stream.ee.emitEvent('stream-ready-to-publish', []); if (!!this.firstVideoElement) { this.createVideoElement(this.firstVideoElement.targetElement, this.properties.insertMode); } delete this.firstVideoElement; resolve(); }; this.openvidu.generateMediaConstraints(this.properties) .then(constraints => { const outboundStreamOptions = { mediaConstraints: constraints, publisherProperties: this.properties }; this.stream.setOutboundStreamOptions(outboundStreamOptions); const constraintsAux: MediaStreamConstraints = {}; const timeForDialogEvent = 1250; if (this.stream.isSendVideo() || this.stream.isSendAudio()) { const definedAudioConstraint = ((constraints.audio === undefined) ? true : constraints.audio); constraintsAux.audio = this.stream.isSendScreen() ? false : definedAudioConstraint; constraintsAux.video = constraints.video; let startTime = Date.now(); this.setPermissionDialogTimer(timeForDialogEvent); navigator.mediaDevices.getUserMedia(constraintsAux) .then(mediaStream => { this.clearPermissionDialogTimer(startTime, timeForDialogEvent); if (this.stream.isSendScreen() && this.stream.isSendAudio()) { // When getting desktop as user media audio constraint must be false. Now we can ask for it if required constraintsAux.audio = definedAudioConstraint; constraintsAux.video = false; startTime = Date.now(); this.setPermissionDialogTimer(timeForDialogEvent); navigator.mediaDevices.getUserMedia(constraintsAux) .then(audioOnlyStream => { this.clearPermissionDialogTimer(startTime, timeForDialogEvent); mediaStream.addTrack(audioOnlyStream.getAudioTracks()[0]); successCallback(mediaStream); }) .catch(error => { this.clearPermissionDialogTimer(startTime, timeForDialogEvent); let errorName, errorMessage; switch (error.name.toLowerCase()) { case 'notfounderror': errorName = OpenViduErrorName.INPUT_AUDIO_DEVICE_NOT_FOUND; errorMessage = error.toString(); errorCallback(new OpenViduError(errorName, errorMessage)); break; case 'notallowederror': errorName = OpenViduErrorName.DEVICE_ACCESS_DENIED; errorMessage = error.toString(); errorCallback(new OpenViduError(errorName, errorMessage)); break; case 'overconstrainederror': if (error.constraint.toLowerCase() === 'deviceid') { errorName = OpenViduErrorName.INPUT_AUDIO_DEVICE_NOT_FOUND; errorMessage = "Audio input device with deviceId '" + ((constraints.video).deviceId!!).exact + "' not found"; } else { errorName = OpenViduErrorName.PUBLISHER_PROPERTIES_ERROR; errorMessage = "Audio input device doesn't support the value passed for constraint '" + error.constraint + "'"; } errorCallback(new OpenViduError(errorName, errorMessage)); break; } }); } else { successCallback(mediaStream); } }) .catch(error => { this.clearPermissionDialogTimer(startTime, timeForDialogEvent); let errorName, errorMessage; switch (error.name.toLowerCase()) { case 'notfounderror': navigator.mediaDevices.getUserMedia({ audio: false, video: constraints.video }) .then(mediaStream => { mediaStream.getVideoTracks().forEach((track) => { track.stop(); }); errorName = OpenViduErrorName.INPUT_AUDIO_DEVICE_NOT_FOUND; errorMessage = error.toString(); errorCallback(new OpenViduError(errorName, errorMessage)); }).catch(e => { errorName = OpenViduErrorName.INPUT_VIDEO_DEVICE_NOT_FOUND; errorMessage = error.toString(); errorCallback(new OpenViduError(errorName, errorMessage)); }); break; case 'notallowederror': errorName = this.stream.isSendScreen() ? OpenViduErrorName.SCREEN_CAPTURE_DENIED : OpenViduErrorName.DEVICE_ACCESS_DENIED; errorMessage = error.toString(); errorCallback(new OpenViduError(errorName, errorMessage)); break; case 'overconstrainederror': navigator.mediaDevices.getUserMedia({ audio: false, video: constraints.video }) .then(mediaStream => { mediaStream.getVideoTracks().forEach((track) => { track.stop(); }); if (error.constraint.toLowerCase() === 'deviceid') { errorName = OpenViduErrorName.INPUT_AUDIO_DEVICE_NOT_FOUND; errorMessage = "Audio input device with deviceId '" + ((constraints.audio).deviceId!!).exact + "' not found"; } else { errorName = OpenViduErrorName.PUBLISHER_PROPERTIES_ERROR; errorMessage = "Audio input device doesn't support the value passed for constraint '" + error.constraint + "'"; } errorCallback(new OpenViduError(errorName, errorMessage)); }).catch(e => { if (error.constraint.toLowerCase() === 'deviceid') { errorName = OpenViduErrorName.INPUT_VIDEO_DEVICE_NOT_FOUND; errorMessage = "Video input device with deviceId '" + ((constraints.video).deviceId!!).exact + "' not found"; } else { errorName = OpenViduErrorName.PUBLISHER_PROPERTIES_ERROR; errorMessage = "Video input device doesn't support the value passed for constraint '" + error.constraint + "'"; } errorCallback(new OpenViduError(errorName, errorMessage)); }); break; } }); } else { reject(new OpenViduError(OpenViduErrorName.NO_INPUT_SOURCE_SET, "Properties 'audioSource' and 'videoSource' cannot be set to false or null at the same time when calling 'OpenVidu.initPublisher'")); } }) .catch((error: OpenViduError) => { errorCallback(error); }); }); } /** * @hidden */ updateSession(session: Session): void { this.session = session; this.stream.session = session; } /** * @hidden */ emitEvent(type: string, eventArray: any[]): void { this.ee.emitEvent(type, eventArray); } /** * @hidden */ reestablishStreamPlayingEvent() { if (this.ee.getListeners('streamPlaying').length > 0) { this.addPlayEventToFirstVideo(); } } /* Private methods */ private setPermissionDialogTimer(waitTime: number): void { this.permissionDialogTimeout = setTimeout(() => { this.ee.emitEvent('accessDialogOpened', []); }, waitTime); } private clearPermissionDialogTimer(startTime: number, waitTime: number): void { clearTimeout(this.permissionDialogTimeout); if ((Date.now() - startTime) > waitTime) { // Permission dialog was shown and now is closed this.ee.emitEvent('accessDialogClosed', []); } } }