-
-
Notifications
You must be signed in to change notification settings - Fork 314
/
videojs.record.js
2010 lines (1741 loc) · 68.2 KB
/
videojs.record.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @file videojs.record.js
*
* The main file for the videojs-record project.
* MIT license: https://github.com/collab-project/videojs-record/blob/master/LICENSE
*/
import videojs from 'video.js';
import AnimationDisplay from './controls/animation-display';
import RecordCanvas from './controls/record-canvas';
import DeviceButton from './controls/device-button';
import CameraButton from './controls/camera-button';
import RecordToggle from './controls/record-toggle';
import RecordIndicator from './controls/record-indicator';
import PictureInPictureToggle from './controls/picture-in-picture-toggle';
import Event from './event';
import defaultKeyHandler from './hot-keys';
import pluginDefaultOptions from './defaults';
import formatTime from './utils/format-time';
import setSrcObject from './utils/browser-shim';
import compareVersion from './utils/compare-version';
import {detectBrowser} from './utils/detect-browser';
import {getAudioEngine, isAudioPluginActive, getVideoEngine, getConvertEngine} from './engine/engine-loader';
import {IMAGE_ONLY, AUDIO_ONLY, VIDEO_ONLY, AUDIO_VIDEO, AUDIO_SCREEN, ANIMATION, SCREEN_ONLY, getRecorderMode} from './engine/record-mode';
const Plugin = videojs.getPlugin('plugin');
const Player = videojs.getComponent('Player');
const AUTO = 'auto';
/**
* Record audio/video/images using the Video.js player.
*
* @class
* @augments videojs.Plugin
*/
class Record extends Plugin {
/**
* The constructor function for the class.
*
* @param {(videojs.Player|Object)} player - video.js Player object.
* @param {Object} options - Player options.
*/
constructor(player, options) {
super(player, options);
// monkey-patch play (#152)
Player.prototype.play = function play() {
let retval = this.techGet_('play');
// silence errors (unhandled promise from play)
if (retval !== undefined && typeof retval.then === 'function') {
retval.then(null, (e) => {});
}
return retval;
};
// add plugin style
player.addClass('vjs-record');
// setup plugin options
this.loadOptions();
// (re)set recorder state
this.resetState();
// use custom time format for video.js player
if (options.formatTime && typeof options.formatTime === 'function') {
// user-supplied formatTime
this.setFormatTime(options.formatTime);
} else {
// plugin's default formatTime
this.setFormatTime((seconds, guide) => {
return formatTime(seconds, guide, this.displayMilliseconds);
});
}
// add device button with icon based on type
let deviceIcon = 'av-perm';
switch (this.getRecordType()) {
case IMAGE_ONLY:
case VIDEO_ONLY:
case ANIMATION:
deviceIcon = 'video-perm';
break;
case AUDIO_ONLY:
deviceIcon = 'audio-perm';
break;
case SCREEN_ONLY:
deviceIcon = 'screen-perm';
break;
case AUDIO_SCREEN:
deviceIcon = 'sv-perm';
break;
}
// add custom interface elements
DeviceButton.prototype.buildCSSClass = () => {
// use dynamic icon class
return 'vjs-record vjs-device-button vjs-control vjs-icon-' + deviceIcon;
};
player.deviceButton = new DeviceButton(player, options);
player.addChild(player.deviceButton);
// add blinking record indicator
player.recordIndicator = new RecordIndicator(player, options);
player.recordIndicator.hide();
player.addChild(player.recordIndicator);
// add canvas for recording and displaying image
player.recordCanvas = new RecordCanvas(player, options);
player.recordCanvas.hide();
player.addChild(player.recordCanvas);
// add image for animation display
player.animationDisplay = new AnimationDisplay(player, options);
player.animationDisplay.hide();
player.addChild(player.animationDisplay);
// add camera button
player.cameraButton = new CameraButton(player, options);
player.cameraButton.hide();
// add record toggle button
player.recordToggle = new RecordToggle(player, options);
player.recordToggle.hide();
// picture-in-picture
let oldVideoJS = videojs.VERSION === undefined || compareVersion(videojs.VERSION, '7.6.0') === -1;
if (!('pictureInPictureEnabled' in document)) {
// no support for picture-in-picture, disable pip
this.pictureInPicture = false;
}
if (this.pictureInPicture === true) {
if (oldVideoJS) {
// add picture-in-picture toggle button for older video.js versions
// in browsers that support PIP
player.pipToggle = new PictureInPictureToggle(player, options);
player.pipToggle.hide();
}
// define Picture-in-Picture event handlers once
this.onEnterPiPHandler = this.onEnterPiP.bind(this);
this.onLeavePiPHandler = this.onLeavePiP.bind(this);
}
// exclude custom UI elements
if (this.player.options_.controlBar) {
let customUIElements = ['deviceButton', 'recordIndicator',
'cameraButton', 'recordToggle'];
if (player.pipToggle) {
customUIElements.push('pipToggle');
}
customUIElements.forEach((element) => {
if (this.player.options_.controlBar[element] !== undefined) {
this.player[element].layoutExclude = true;
this.player[element].hide();
}
});
}
// wait until player ui is ready
this.player.one(Event.READY, this.setupUI.bind(this));
}
/**
* Setup plugin options.
*
* @param {Object} newOptions - Optional new player options.
*/
loadOptions(newOptions = {}) {
let merge;
if (videojs.obj !== undefined) {
// video.js v8 and newer
merge = videojs.obj.merge;
} else {
merge = videojs.mergeOptions;
}
let recordOptions = merge(pluginDefaultOptions,
this.player.options_.plugins.record, newOptions);
// record settings
this.recordImage = recordOptions.image;
this.recordAudio = recordOptions.audio;
this.recordVideo = recordOptions.video;
this.recordAnimation = recordOptions.animation;
this.recordScreen = recordOptions.screen;
this.maxLength = recordOptions.maxLength;
this.maxFileSize = recordOptions.maxFileSize;
this.displayMilliseconds = recordOptions.displayMilliseconds;
this.debug = recordOptions.debug;
this.pictureInPicture = recordOptions.pip;
this.recordTimeSlice = recordOptions.timeSlice;
this.autoMuteDevice = recordOptions.autoMuteDevice;
this.pluginLibraryOptions = recordOptions.pluginLibraryOptions;
// video/canvas settings
this.videoFrameWidth = recordOptions.frameWidth;
this.videoFrameHeight = recordOptions.frameHeight;
this.videoFrameRate = recordOptions.videoFrameRate;
this.videoBitRate = recordOptions.videoBitRate;
this.videoEngine = recordOptions.videoEngine;
this.videoRecorderType = recordOptions.videoRecorderType;
this.videoMimeType = recordOptions.videoMimeType;
this.videoWorkerURL = recordOptions.videoWorkerURL;
this.videoWebAssemblyURL = recordOptions.videoWebAssemblyURL;
// convert settings
this.convertEngine = recordOptions.convertEngine;
this.convertAuto = recordOptions.convertAuto;
this.convertWorkerURL = recordOptions.convertWorkerURL;
this.convertOptions = recordOptions.convertOptions;
// audio settings
this.audioEngine = recordOptions.audioEngine;
this.audioRecorderType = recordOptions.audioRecorderType;
this.audioWorkerURL = recordOptions.audioWorkerURL;
this.audioWebAssemblyURL = recordOptions.audioWebAssemblyURL;
this.audioBufferSize = recordOptions.audioBufferSize;
this.audioSampleRate = recordOptions.audioSampleRate;
this.audioBitRate = recordOptions.audioBitRate;
this.audioChannels = recordOptions.audioChannels;
this.audioMimeType = recordOptions.audioMimeType;
this.audioBufferUpdate = recordOptions.audioBufferUpdate;
// image settings
this.imageOutputType = recordOptions.imageOutputType;
this.imageOutputFormat = recordOptions.imageOutputFormat;
this.imageOutputQuality = recordOptions.imageOutputQuality;
// animation settings
this.animationFrameRate = recordOptions.animationFrameRate;
this.animationQuality = recordOptions.animationQuality;
}
/**
* Player UI is ready.
* @private
*/
setupUI() {
// insert custom controls on left-side of controlbar
this.player.controlBar.addChild(this.player.cameraButton);
this.player.controlBar.el().insertBefore(
this.player.cameraButton.el(),
this.player.controlBar.el().firstChild);
this.player.controlBar.el().insertBefore(
this.player.recordToggle.el(),
this.player.controlBar.el().firstChild);
// picture-in-picture
if (this.pictureInPicture === true) {
if (this.player.controlBar.pictureInPictureToggle === undefined &&
this.player.pipToggle !== undefined) {
// add custom PiP toggle
this.player.controlBar.addChild(this.player.pipToggle);
} else if (this.player.controlBar.pictureInPictureToggle !== undefined) {
// use video.js PiP toggle
this.player.pipToggle = this.player.controlBar.pictureInPictureToggle;
this.player.pipToggle.hide();
}
} else if (
this.pictureInPicture === false &&
this.player.controlBar.pictureInPictureToggle !== undefined) {
this.player.controlBar.pictureInPictureToggle.hide();
}
// get rid of unused controls
if (this.player.controlBar.remainingTimeDisplay !== undefined) {
this.player.controlBar.remainingTimeDisplay.el().style.display = 'none';
}
if (this.player.controlBar.liveDisplay !== undefined) {
this.player.controlBar.liveDisplay.el().style.display = 'none';
}
// loop feature is never used in this plugin
this.player.loop(false);
// tweak player UI based on type
switch (this.getRecordType()) {
case AUDIO_ONLY:
// reference to videojs-wavesurfer plugin
this.surfer = this.player.wavesurfer();
// use same time format as this plugin
this.surfer.setFormatTime(this._formatTime);
break;
case IMAGE_ONLY:
case VIDEO_ONLY:
case AUDIO_VIDEO:
case ANIMATION:
case SCREEN_ONLY:
case AUDIO_SCREEN:
// customize controls
if (this.player.bigPlayButton !== undefined) {
this.player.bigPlayButton.hide();
}
// 'loadedmetadata' and 'loadstart' events reset the
// durationDisplay for the first time: prevent this
this.player.one(Event.LOADEDMETADATA, () => {
// display max record time
this.setDuration(this.maxLength);
});
this.player.one(Event.LOADSTART, () => {
// display max record time
this.setDuration(this.maxLength);
});
// the native controls don't work for this UI so disable
// them no matter what
if (this.player.usingNativeControls_ === true) {
if (this.player.tech_.el_ !== undefined) {
this.player.tech_.el_.controls = false;
}
}
// clicking or tapping the player video element should not try
// to start playback
this.player.removeTechControlsListeners_();
if (this.player.options_.controls) {
// progress control isn't used by this plugin, hide if present
if (this.player.controlBar.progressControl !== undefined) {
this.player.controlBar.progressControl.hide();
}
// prevent controlbar fadeout
this.player.on(Event.USERINACTIVE, (event) => {
this.player.userActive(true);
});
// videojs automatically hides the controls when no valid 'source'
// element is included in the video or audio tag. Don't. Ever again.
this.player.controlBar.show();
this.player.controlBar.el().style.display = 'flex';
}
break;
}
// disable time display events that constantly try to reset the current time
// and duration values
this.player.off(Event.TIMEUPDATE);
this.player.off(Event.DURATIONCHANGE);
this.player.off(Event.LOADEDMETADATA);
this.player.off(Event.LOADSTART);
this.player.off(Event.ENDED);
// display max record time
this.setDuration(this.maxLength);
// hot keys
if (this.player.options_.plugins.record &&
this.player.options_.plugins.record.hotKeys &&
(this.player.options_.plugins.record.hotKeys !== false)) {
let handler = this.player.options_.plugins.record.hotKeys;
if (handler === true) {
handler = defaultKeyHandler;
}
// enable video.js user action
this.player.options_.userActions = {
hotkeys: handler
};
}
// hide play control (if present)
if (this.player.controlBar.playToggle !== undefined) {
this.player.controlBar.playToggle.hide();
}
}
/**
* Indicates whether the plugin is currently recording or not.
*
* @return {boolean} Plugin currently recording or not.
*/
isRecording() {
return this._recording;
}
/**
* Indicates whether the plugin is currently processing recorded data
* or not.
*
* @return {boolean} Plugin processing or not.
*/
isProcessing() {
return this._processing;
}
/**
* Indicates whether the plugin is destroyed or not.
*
* @return {boolean} Plugin destroyed or not.
*/
isDestroyed() {
let destroyed = (this.player === null);
if (destroyed === false) {
destroyed = (this.player.children() === null);
}
return destroyed;
}
/**
* Open the browser's recording device selection dialog and start the
* device.
*/
getDevice() {
// define device callbacks once
if (this.deviceReadyCallback === undefined) {
this.deviceReadyCallback = this.onDeviceReady.bind(this);
}
if (this.deviceErrorCallback === undefined) {
this.deviceErrorCallback = this.onDeviceError.bind(this);
}
if (this.engineStopCallback === undefined) {
this.engineStopCallback = this.onRecordComplete.bind(this);
}
if (this.streamVisibleCallback === undefined) {
this.streamVisibleCallback = this.onStreamVisible.bind(this);
}
// check for support because some browsers still do not support
// getDisplayMedia or getUserMedia (like Chrome iOS, see:
// https://bugs.chromium.org/p/chromium/issues/detail?id=752458)
if (this.getRecordType() === SCREEN_ONLY || this.getRecordType() === AUDIO_SCREEN) {
if (navigator.mediaDevices === undefined ||
navigator.mediaDevices.getDisplayMedia === undefined) {
this.player.trigger(Event.ERROR,
'This browser does not support navigator.mediaDevices.getDisplayMedia');
return;
}
} else {
if (navigator.mediaDevices === undefined ||
navigator.mediaDevices.getUserMedia === undefined) {
this.player.trigger(Event.ERROR,
'This browser does not support navigator.mediaDevices.getUserMedia');
return;
}
}
// ask the browser to give the user access to the media device
// and get a stream reference in the callback function
switch (this.getRecordType()) {
case AUDIO_ONLY:
// setup microphone
this.mediaType = {
audio: (this.audioRecorderType === AUTO) ? true : this.audioRecorderType,
video: false
};
// remove existing microphone listeners
this.surfer.surfer.microphone.un(Event.DEVICE_READY,
this.deviceReadyCallback);
this.surfer.surfer.microphone.un(Event.DEVICE_ERROR,
this.deviceErrorCallback);
// setup new microphone listeners
this.surfer.surfer.microphone.on(Event.DEVICE_READY,
this.deviceReadyCallback);
this.surfer.surfer.microphone.on(Event.DEVICE_ERROR,
this.deviceErrorCallback);
// disable existing playback events
this.surfer.setupPlaybackEvents(false);
// (re)set surfer liveMode
this.surfer.liveMode = true;
this.surfer.surfer.microphone.paused = false;
// resume AudioContext when it's suspended by the browser, due to
// autoplay rules. Chrome warns with the following message:
// "The AudioContext was not allowed to start. It must be resumed
// (or created) after a user gesture on the page."
if (this.surfer.surfer.backend.ac.state === 'suspended') {
this.surfer.surfer.backend.ac.resume();
}
// assign custom reloadBufferFunction for microphone plugin to
// obtain AudioBuffer chunks
if (this.audioBufferUpdate === true) {
this.surfer.surfer.microphone.reloadBufferFunction = (event) => {
if (!this.surfer.surfer.microphone.paused) {
// redraw
this.surfer.surfer.empty();
this.surfer.surfer.loadDecodedBuffer(event.inputBuffer);
// store data and notify others
this.player.recordedData = event.inputBuffer;
this.player.trigger(Event.AUDIO_BUFFER_UPDATE);
}
};
}
// open browser device selection/permissions dialog
this.surfer.surfer.microphone.start();
break;
case IMAGE_ONLY:
case VIDEO_ONLY:
if (this.getRecordType() === IMAGE_ONLY) {
// using player.el() here because this.mediaElement is not available yet
this.player.el().firstChild.addEventListener(Event.PLAYING,
this.streamVisibleCallback);
}
// setup camera
this.mediaType = {
audio: false,
video: (this.videoRecorderType === AUTO) ? true : this.videoRecorderType
};
navigator.mediaDevices.getUserMedia({
audio: false,
video: (this.getRecordType() === IMAGE_ONLY) ? this.recordImage : this.recordVideo
}).then(
this.onDeviceReady.bind(this)
).catch(
this.onDeviceError.bind(this)
);
break;
case AUDIO_SCREEN:
// setup camera and microphone
this.mediaType = {
audio: (this.audioRecorderType === AUTO) ? true : this.audioRecorderType,
video: (this.videoRecorderType === AUTO) ? true : this.videoRecorderType
};
let audioScreenConstraints = {};
if (this.recordScreen === true) {
audioScreenConstraints = {
video: true // needs to be true for it to work in Firefox
};
} else if (typeof this.recordScreen === 'object' &&
this.recordScreen.constructor === Object) {
audioScreenConstraints = this.recordScreen;
}
navigator.mediaDevices.getDisplayMedia(audioScreenConstraints).then(screenStream => {
navigator.mediaDevices.getUserMedia({
audio: this.recordAudio
}).then((mic) => {
// join microphone track with screencast stream (order matters)
screenStream.addTrack(mic.getTracks()[0]);
this.onDeviceReady.bind(this)(screenStream);
}).catch((code) => {
// here the screen sharing is in progress as successful result of navigator.mediaDevices.getDisplayMedia and
// needs to be stopped because microphone permissions are not acquired by navigator.mediaDevices.getUserMedia
if (screenStream.active) {
screenStream.stop();
}
this.onDeviceError(code);
});
}).catch(
this.onDeviceError.bind(this)
);
break;
case AUDIO_VIDEO:
// setup camera and microphone
this.mediaType = {
audio: (this.audioRecorderType === AUTO) ? true : this.audioRecorderType,
video: (this.videoRecorderType === AUTO) ? true : this.videoRecorderType
};
navigator.mediaDevices.getUserMedia({
audio: this.recordAudio,
video: this.recordVideo
}).then(
this.onDeviceReady.bind(this)
).catch(
this.onDeviceError.bind(this)
);
break;
case ANIMATION:
// setup camera
this.mediaType = {
// animated GIF
audio: false,
video: false,
gif: true
};
navigator.mediaDevices.getUserMedia({
audio: false,
video: this.recordAnimation
}).then(
this.onDeviceReady.bind(this)
).catch(
this.onDeviceError.bind(this)
);
break;
case SCREEN_ONLY:
// setup screen
this.mediaType = {
// screen capture
audio: false,
video: false,
screen: true,
gif: false
};
let screenOnlyConstraints = {};
if (this.recordScreen === true) {
screenOnlyConstraints = {
video: true
};
} else if (typeof this.recordScreen === 'object' &&
this.recordScreen.constructor === Object) {
screenOnlyConstraints = this.recordScreen;
}
navigator.mediaDevices.getDisplayMedia(screenOnlyConstraints).then(
this.onDeviceReady.bind(this)
).catch(
this.onDeviceError.bind(this)
);
break;
}
}
/**
* Invoked when the device is ready.
*
* @private
* @param {LocalMediaStream} stream - Local media stream from device.
*/
onDeviceReady(stream) {
this._deviceActive = true;
// stop previous stream if it is active
if (this.stream !== undefined && this.stream.active) {
this.stream.stop();
}
// store reference to stream for stopping etc.
this.stream = stream;
// hide device selection button
this.player.deviceButton.hide();
// reset time (e.g. when stopDevice was used)
this.setDuration(this.maxLength);
this.setCurrentTime(0);
// hide play/pause control (e.g. when stopDevice was used)
if (this.player.controlBar.playToggle !== undefined) {
this.player.controlBar.playToggle.hide();
}
// reset playback listeners
this.off(this.player, Event.TIMEUPDATE, this.playbackTimeUpdate);
this.off(this.player, Event.ENDED, this.playbackTimeUpdate);
// setup recording engine
if (this.getRecordType() !== IMAGE_ONLY) {
// currently record plugins are only supported in audio-only mode
if (this.getRecordType() !== AUDIO_ONLY && isAudioPluginActive(this.audioEngine)) {
throw new Error('Currently ' + this.audioEngine +
' is only supported in audio-only mode.');
}
// load plugins, if any
let EngineClass, engineType;
switch (this.getRecordType()) {
case AUDIO_ONLY:
// get audio plugin engine class (or default recordrtc engine)
EngineClass = getAudioEngine(this.audioEngine);
engineType = this.audioEngine;
break;
default:
// get video plugin engine class (or default recordrtc engine)
EngineClass = getVideoEngine(this.videoEngine);
engineType = this.videoEngine;
}
// create recording engine
try {
// connect stream to recording engine
this.engine = new EngineClass(this.player, this.player.options_);
} catch (err) {
throw new Error('Could not load ' + engineType + ' plugin');
}
// listen for events
this.engine.on(Event.RECORD_COMPLETE, this.engineStopCallback);
// audio settings
this.engine.bufferSize = this.audioBufferSize;
this.engine.sampleRate = this.audioSampleRate;
this.engine.bitRate = this.audioBitRate;
this.engine.audioChannels = this.audioChannels;
this.engine.audioWorkerURL = this.audioWorkerURL;
this.engine.audioWebAssemblyURL = this.audioWebAssemblyURL;
// mime type
this.engine.mimeType = {
video: this.videoMimeType,
gif: 'image/gif'
};
if (this.audioMimeType !== null &&
this.audioMimeType !== AUTO) {
this.engine.mimeType.audio = this.audioMimeType;
}
// video/canvas settings
this.engine.videoWorkerURL = this.videoWorkerURL;
this.engine.videoWebAssemblyURL = this.videoWebAssemblyURL;
this.engine.videoBitRate = this.videoBitRate;
this.engine.videoFrameRate = this.videoFrameRate;
this.engine.video = {
width: this.videoFrameWidth,
height: this.videoFrameHeight
};
this.engine.canvas = {
width: this.videoFrameWidth,
height: this.videoFrameHeight
};
// animated GIF settings
this.engine.quality = this.animationQuality;
this.engine.frameRate = this.animationFrameRate;
// timeSlice
if (this.recordTimeSlice && this.recordTimeSlice > 0) {
this.engine.timeSlice = this.recordTimeSlice;
this.engine.maxFileSize = this.maxFileSize;
}
// additional 3rd-party library options
this.engine.pluginLibraryOptions = this.pluginLibraryOptions;
// initialize recorder
this.engine.setup(this.stream, this.mediaType, this.debug);
// create converter engine
if (this.convertEngine !== '') {
let ConvertEngineClass = getConvertEngine(this.convertEngine);
try {
this.converter = new ConvertEngineClass(this.player,
this.player.options_);
}
catch (err) {
throw new Error('Could not load ' + this.convertEngine +
' plugin');
}
// convert settings
this.converter.convertAuto = this.convertAuto;
this.converter.convertWorkerURL = this.convertWorkerURL;
this.converter.convertOptions = this.convertOptions;
this.converter.pluginLibraryOptions = this.pluginLibraryOptions;
// initialize converter
this.converter.setup(this.mediaType, this.debug);
}
// show elements that should never be hidden in animation,
// audio and/or video modus
let uiElements = ['currentTimeDisplay', 'timeDivider', 'durationDisplay'];
uiElements.forEach((element) => {
element = this.player.controlBar[element];
if (element !== undefined) {
element.el().style.display = 'block';
element.show();
}
});
// show record button
this.player.recordToggle.show();
} else {
// disable record indicator
this.player.recordIndicator.disable();
// setup UI for retrying snapshot (e.g. when stopDevice was
// used)
this.retrySnapshot();
// camera button will be displayed as soon as this.onStreamVisible fires
}
// setup preview
if (this.getRecordType() !== AUDIO_ONLY) {
// show live preview
this.mediaElement = this.player.el().firstChild;
this.mediaElement.controls = false;
// mute incoming audio for feedback loops
this.mediaElement.muted = true;
// hide the volume bar while it's muted
this.displayVolumeControl(false);
// picture-in-picture
if (this.pictureInPicture === true) {
// show button
this.player.pipToggle.show();
// listen to and forward Picture-in-Picture events
this.mediaElement.removeEventListener(Event.ENTERPICTUREINPICTURE,
this.onEnterPiPHandler);
this.mediaElement.removeEventListener(Event.LEAVEPICTUREINPICTURE,
this.onLeavePiPHandler);
this.mediaElement.addEventListener(Event.ENTERPICTUREINPICTURE,
this.onEnterPiPHandler);
this.mediaElement.addEventListener(Event.LEAVEPICTUREINPICTURE,
this.onLeavePiPHandler);
}
// load stream
this.load(this.stream);
// stream loading is async, so we wait until it's ready to play
// the stream
this.player.one(Event.LOADEDMETADATA, () => {
// start stream
this.mediaElement.play();
// forward to listeners
this.player.trigger(Event.DEVICE_READY);
});
} else {
// forward to listeners
this.player.trigger(Event.DEVICE_READY);
}
}
/**
* Invoked when an device error occurred.
*
* @private
* @param {(string|number)} code - Error code/description.
*/
onDeviceError(code) {
this._deviceActive = false;
if (!this.isDestroyed()) {
// store code
this.player.deviceErrorCode = code;
// forward error to player
this.player.trigger(Event.DEVICE_ERROR);
}
}
/**
* Start recording.
*/
start() {
if (!this.isProcessing()) {
// check if user didn't revoke permissions after a previous recording
if (this.stream && this.stream.active === false) {
// ask for permissions again
this.getDevice();
return;
}
this._recording = true;
// hide play/pause control
if (this.player.controlBar.playToggle !== undefined) {
this.player.controlBar.playToggle.hide();
}
// reset playback listeners
this.off(this.player, Event.TIMEUPDATE, this.playbackTimeUpdate);
this.off(this.player, Event.ENDED, this.playbackTimeUpdate);
// start preview
switch (this.getRecordType()) {
case AUDIO_ONLY:
// disable playback events
this.surfer.setupPlaybackEvents(false);
// start/resume live audio visualization
this.surfer.surfer.microphone.paused = false;
this.surfer.liveMode = true;
this.surfer.surfer.microphone.play();
break;
case VIDEO_ONLY:
case AUDIO_VIDEO:
case AUDIO_SCREEN:
case SCREEN_ONLY:
// preview video stream in video element
this.startVideoPreview();
break;
case ANIMATION:
// hide the first frame
this.player.recordCanvas.hide();
// hide the animation
this.player.animationDisplay.hide();
// show preview video
this.mediaElement.style.display = 'block';
// for animations, capture the first frame
// that can be displayed as soon as recording
// is complete
this.captureFrame().then((result) => {
// start video preview **after** capturing first frame
this.startVideoPreview();
});
break;
}
if (this.autoMuteDevice) {
// unmute device
this.muteTracks(false);
}
// start recording
switch (this.getRecordType()) {
case IMAGE_ONLY:
// create snapshot
this.createSnapshot();
// notify UI
this.player.trigger(Event.START_RECORD);
break;
case VIDEO_ONLY:
case AUDIO_VIDEO:
case AUDIO_SCREEN:
case ANIMATION:
case SCREEN_ONLY:
// wait for media stream on video element to actually load
this.player.one(Event.LOADEDMETADATA, () => {
// start actually recording process
this.startRecording();
});
break;
default:
// all resources have already loaded, so we can start
// recording right away
this.startRecording();
}
}
}
/**
* Start recording.
* @private
*/
startRecording() {
// register starting point
this.paused = false;
this.pauseTime = this.pausedTime = 0;
this.startTime = performance.now();
// start countdown
const COUNTDOWN_SPEED = 100; // ms
this.countDown = this.player.setInterval(
this.onCountDown.bind(this), COUNTDOWN_SPEED);
// cleanup previous recording
if (this.engine !== undefined) {
this.engine.dispose();
}
// start recording stream
this.engine.start();
// notify UI
this.player.trigger(Event.START_RECORD);
}
/**
* Stop recording.
*/
stop() {
if (!this.isProcessing()) {
this._recording = false;
this._processing = true;
if (this.getRecordType() !== IMAGE_ONLY) {
// notify UI
this.player.trigger(Event.STOP_RECORD);
// stop countdown
this.player.clearInterval(this.countDown);
// stop recording stream (result will be available async)
if (this.engine) {
this.engine.stop();
}
if (this.autoMuteDevice) {
// mute device
this.muteTracks(true);
}
} else {
if (this.player.recordedData) {
// notify listeners that image data is (already) available
this.player.trigger(Event.FINISH_RECORD);
}
}
}
}
/**