1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
8 * @fileoverview MediaControls class implements media playback controls
9 * that exist outside of the audio/video HTML element.
13 * @param {HTMLElement} containerElement The container for the controls.
14 * @param {function} onMediaError Function to display an error message.
17 function MediaControls(containerElement, onMediaError) {
18 this.container_ = containerElement;
19 this.document_ = this.container_.ownerDocument;
22 this.onMediaPlayBound_ = this.onMediaPlay_.bind(this, true);
23 this.onMediaPauseBound_ = this.onMediaPlay_.bind(this, false);
24 this.onMediaDurationBound_ = this.onMediaDuration_.bind(this);
25 this.onMediaProgressBound_ = this.onMediaProgress_.bind(this);
26 this.onMediaError_ = onMediaError || function() {};
30 * Button's state types. Values are used as CSS class names.
33 MediaControls.ButtonStateType = {
40 * @return {HTMLAudioElement|HTMLVideoElement} The media element.
42 MediaControls.prototype.getMedia = function() { return this.media_ };
45 * Format the time in hh:mm:ss format (omitting redundant leading zeros).
47 * @param {number} timeInSec Time in seconds.
48 * @return {string} Formatted time string.
51 MediaControls.formatTime_ = function(timeInSec) {
52 var seconds = Math.floor(timeInSec % 60);
53 var minutes = Math.floor((timeInSec / 60) % 60);
54 var hours = Math.floor(timeInSec / 60 / 60);
56 if (hours) result += hours + ':';
57 if (hours && (minutes < 10)) result += '0';
58 result += minutes + ':';
59 if (seconds < 10) result += '0';
65 * Create a custom control.
67 * @param {string} className Class name.
68 * @param {HTMLElement=} opt_parent Parent element or container if undefined.
69 * @return {HTMLElement} The new control element.
71 MediaControls.prototype.createControl = function(className, opt_parent) {
72 var parent = opt_parent || this.container_;
73 var control = this.document_.createElement('div');
74 control.className = className;
75 parent.appendChild(control);
80 * Create a custom button.
82 * @param {string} className Class name.
83 * @param {function(Event)} handler Click handler.
84 * @param {HTMLElement=} opt_parent Parent element or container if undefined.
85 * @param {number=} opt_numStates Number of states, default: 1.
86 * @return {HTMLElement} The new button element.
88 MediaControls.prototype.createButton = function(
89 className, handler, opt_parent, opt_numStates) {
90 opt_numStates = opt_numStates || 1;
92 var button = this.createControl(className, opt_parent);
93 button.classList.add('media-button');
94 button.addEventListener('click', handler);
96 var stateTypes = Object.keys(MediaControls.ButtonStateType);
97 for (var state = 0; state != opt_numStates; state++) {
98 var stateClass = MediaControls.ButtonStateType[stateTypes[state]];
99 this.createControl('normal ' + stateClass, button);
100 this.createControl('hover ' + stateClass, button);
101 this.createControl('active ' + stateClass, button);
103 this.createControl('disabled', button);
105 button.setAttribute('state', MediaControls.ButtonStateType.DEFAULT);
106 button.addEventListener('click', handler);
111 * Enable/disable controls matching a given selector.
113 * @param {string} selector CSS selector.
114 * @param {boolean} on True if enable, false if disable.
117 MediaControls.prototype.enableControls_ = function(selector, on) {
118 var controls = this.container_.querySelectorAll(selector);
119 for (var i = 0; i != controls.length; i++) {
120 var classList = controls[i].classList;
122 classList.remove('disabled');
124 classList.add('disabled');
135 MediaControls.prototype.play = function() {
142 MediaControls.prototype.pause = function() {
147 * @return {boolean} True if the media is currently playing.
149 MediaControls.prototype.isPlaying = function() {
150 return !this.media_.paused && !this.media_.ended;
156 MediaControls.prototype.togglePlayState = function() {
157 if (this.isPlaying())
164 * Toggle play/pause state on a mouse click on the play/pause button. Can be
165 * called externally. TODO(mtomasz): Remove it. http://www.crbug.com/254318.
167 * @param {Event=} opt_event Mouse click event.
169 MediaControls.prototype.onPlayButtonClicked = function(opt_event) {
170 this.togglePlayState();
174 * @param {HTMLElement=} opt_parent Parent container.
176 MediaControls.prototype.initPlayButton = function(opt_parent) {
177 this.playButton_ = this.createButton('play media-control',
178 this.onPlayButtonClicked.bind(this), opt_parent, 3 /* States. */);
186 * The default range of 100 is too coarse for the media progress slider.
188 MediaControls.PROGRESS_RANGE = 5000;
191 * @param {boolean=} opt_seekMark True if the progress slider should have
193 * @param {HTMLElement=} opt_parent Parent container.
195 MediaControls.prototype.initTimeControls = function(opt_seekMark, opt_parent) {
196 var timeControls = this.createControl('time-controls', opt_parent);
198 var sliderConstructor =
199 opt_seekMark ? MediaControls.PreciseSlider : MediaControls.Slider;
201 this.progressSlider_ = new sliderConstructor(
202 this.createControl('progress media-control', timeControls),
204 MediaControls.PROGRESS_RANGE,
205 this.onProgressChange_.bind(this),
206 this.onProgressDrag_.bind(this));
208 var timeBox = this.createControl('time media-control', timeControls);
210 this.duration_ = this.createControl('duration', timeBox);
211 // Set the initial width to the minimum to reduce the flicker.
212 this.duration_.textContent = MediaControls.formatTime_(0);
214 this.currentTime_ = this.createControl('current', timeBox);
218 * @param {number} current Current time is seconds.
219 * @param {number} duration Duration in seconds.
222 MediaControls.prototype.displayProgress_ = function(current, duration) {
223 var ratio = current / duration;
224 this.progressSlider_.setValue(ratio);
225 this.currentTime_.textContent = MediaControls.formatTime_(current);
229 * @param {number} value Progress [0..1].
232 MediaControls.prototype.onProgressChange_ = function(value) {
233 if (!this.media_.seekable || !this.media_.duration) {
234 console.error('Inconsistent media state');
238 var current = this.media_.duration * value;
239 this.media_.currentTime = current;
240 this.currentTime_.textContent = MediaControls.formatTime_(current);
244 * @param {boolean} on True if dragging.
247 MediaControls.prototype.onProgressDrag_ = function(on) {
249 this.resumeAfterDrag_ = this.isPlaying();
252 if (this.resumeAfterDrag_) {
253 if (this.media_.ended)
254 this.onMediaPlay_(false);
258 this.updatePlayButtonState_(this.isPlaying());
267 * @param {HTMLElement=} opt_parent Parent element for the controls.
269 MediaControls.prototype.initVolumeControls = function(opt_parent) {
270 var volumeControls = this.createControl('volume-controls', opt_parent);
272 this.soundButton_ = this.createButton('sound media-control',
273 this.onSoundButtonClick_.bind(this), volumeControls);
274 this.soundButton_.setAttribute('level', 3); // max level.
276 this.volume_ = new MediaControls.AnimatedSlider(
277 this.createControl('volume media-control', volumeControls),
280 this.onVolumeChange_.bind(this),
281 this.onVolumeDrag_.bind(this));
285 * Click handler for the sound level button.
288 MediaControls.prototype.onSoundButtonClick_ = function() {
289 if (this.media_.volume == 0) {
290 this.volume_.setValue(this.savedVolume_ || 1);
292 this.savedVolume_ = this.media_.volume;
293 this.volume_.setValue(0);
295 this.onVolumeChange_(this.volume_.getValue());
299 * @param {number} value Volume [0..1].
300 * @return {number} The rough level [0..3] used to pick an icon.
303 MediaControls.getVolumeLevel_ = function(value) {
304 if (value == 0) return 0;
305 if (value <= 1 / 3) return 1;
306 if (value <= 2 / 3) return 2;
311 * @param {number} value Volume [0..1].
314 MediaControls.prototype.onVolumeChange_ = function(value) {
315 this.media_.volume = value;
316 this.soundButton_.setAttribute('level', MediaControls.getVolumeLevel_(value));
320 * @param {boolean} on True if dragging is in progress.
323 MediaControls.prototype.onVolumeDrag_ = function(on) {
324 if (on && (this.media_.volume != 0)) {
325 this.savedVolume_ = this.media_.volume;
330 * Media event handlers.
334 * Attach a media element.
336 * @param {HTMLMediaElement} mediaElement The media element to control.
338 MediaControls.prototype.attachMedia = function(mediaElement) {
339 this.media_ = mediaElement;
341 this.media_.addEventListener('play', this.onMediaPlayBound_);
342 this.media_.addEventListener('pause', this.onMediaPauseBound_);
343 this.media_.addEventListener('durationchange', this.onMediaDurationBound_);
344 this.media_.addEventListener('timeupdate', this.onMediaProgressBound_);
345 this.media_.addEventListener('error', this.onMediaError_);
347 // Reflect the media state in the UI.
348 this.onMediaDuration_();
349 this.onMediaPlay_(this.isPlaying());
350 this.onMediaProgress_();
352 /* Copy the user selected volume to the new media element. */
353 this.media_.volume = this.volume_.getValue();
358 * Detach media event handlers.
360 MediaControls.prototype.detachMedia = function() {
364 this.media_.removeEventListener('play', this.onMediaPlayBound_);
365 this.media_.removeEventListener('pause', this.onMediaPauseBound_);
366 this.media_.removeEventListener('durationchange', this.onMediaDurationBound_);
367 this.media_.removeEventListener('timeupdate', this.onMediaProgressBound_);
368 this.media_.removeEventListener('error', this.onMediaError_);
374 * Force-empty the media pipeline. This is a workaround for crbug.com/149957.
375 * The document is not going to be GC-ed until the last Files app window closes,
376 * but we want the media pipeline to deinitialize ASAP to minimize leakage.
378 MediaControls.prototype.cleanup = function() {
379 this.media_.src = '';
385 * 'play' and 'pause' event handler.
386 * @param {boolean} playing True if playing.
389 MediaControls.prototype.onMediaPlay_ = function(playing) {
390 if (this.progressSlider_.isDragging())
393 this.updatePlayButtonState_(playing);
394 this.onPlayStateChanged();
398 * 'durationchange' event handler.
401 MediaControls.prototype.onMediaDuration_ = function() {
402 if (!this.media_.duration) {
403 this.enableControls_('.media-control', false);
407 this.enableControls_('.media-control', true);
409 var sliderContainer = this.progressSlider_.getContainer();
410 if (this.media_.seekable)
411 sliderContainer.classList.remove('readonly');
413 sliderContainer.classList.add('readonly');
415 var valueToString = function(value) {
416 return MediaControls.formatTime_(this.media_.duration * value);
419 this.duration_.textContent = valueToString(1);
421 if (this.progressSlider_.setValueToStringFunction)
422 this.progressSlider_.setValueToStringFunction(valueToString);
424 if (this.media_.seekable)
425 this.restorePlayState();
429 * 'timeupdate' event handler.
432 MediaControls.prototype.onMediaProgress_ = function() {
433 if (!this.media_.duration) {
434 this.displayProgress_(0, 1);
438 var current = this.media_.currentTime;
439 var duration = this.media_.duration;
441 if (this.progressSlider_.isDragging())
444 this.displayProgress_(current, duration);
446 if (current == duration) {
447 this.onMediaComplete();
449 this.onPlayStateChanged();
453 * Called when the media playback is complete.
455 MediaControls.prototype.onMediaComplete = function() {};
458 * Called when play/pause state is changed or on playback progress.
459 * This is the right moment to save the play state.
461 MediaControls.prototype.onPlayStateChanged = function() {};
464 * Updates the play button state.
465 * @param {boolean} playing If the video is playing.
468 MediaControls.prototype.updatePlayButtonState_ = function(playing) {
470 this.playButton_.setAttribute('state',
471 MediaControls.ButtonStateType.PLAYING);
472 } else if (!this.media_.ended) {
473 this.playButton_.setAttribute('state',
474 MediaControls.ButtonStateType.DEFAULT);
476 this.playButton_.setAttribute('state',
477 MediaControls.ButtonStateType.ENDED);
482 * Restore play state. Base implementation is empty.
484 MediaControls.prototype.restorePlayState = function() {};
487 * Encode current state into the page URL or the app state.
489 MediaControls.prototype.encodeState = function() {
490 if (!this.media_.duration)
493 if (window.appState) {
494 window.appState.time = this.media_.currentTime;
499 var playState = JSON.stringify({
500 play: this.isPlaying(),
501 time: this.media_.currentTime
504 var newLocation = document.location.origin + document.location.pathname +
505 document.location.search + '#' + playState;
507 document.location.href = newLocation;
511 * Decode current state from the page URL or the app state.
512 * @return {boolean} True if decode succeeded.
514 MediaControls.prototype.decodeState = function() {
515 if (window.appState) {
516 if (!('time' in window.appState))
518 // There is no page reload for apps v2, only app restart.
519 // Always restart in paused state.
520 this.media_.currentTime = appState.time;
525 var hash = document.location.hash.substring(1);
528 var playState = JSON.parse(hash);
529 if (!('time' in playState))
532 this.media_.currentTime = playState.time;
541 console.warn('Cannot decode play state');
548 * Remove current state from the page URL or the app state.
550 MediaControls.prototype.clearState = function() {
551 if (window.appState) {
552 if ('time' in window.appState)
553 delete window.appState.time;
558 var newLocation = document.location.origin + document.location.pathname +
559 document.location.search + '#';
561 document.location.href = newLocation;
565 * Create a customized slider control.
567 * @param {HTMLElement} container The containing div element.
568 * @param {number} value Initial value [0..1].
569 * @param {number} range Number of distinct slider positions to be supported.
570 * @param {function(number)} onChange Value change handler.
571 * @param {function(boolean)} onDrag Drag begin/end handler.
575 MediaControls.Slider = function(container, value, range, onChange, onDrag) {
576 this.container_ = container;
577 this.onChange_ = onChange;
578 this.onDrag_ = onDrag;
580 var document = this.container_.ownerDocument;
582 this.container_.classList.add('custom-slider');
584 this.input_ = document.createElement('input');
585 this.input_.type = 'range';
587 this.input_.max = range;
588 this.input_.value = value * range;
589 this.container_.appendChild(this.input_);
591 this.input_.addEventListener(
592 'change', this.onInputChange_.bind(this));
593 this.input_.addEventListener(
594 'mousedown', this.onInputDrag_.bind(this, true));
595 this.input_.addEventListener(
596 'mouseup', this.onInputDrag_.bind(this, false));
598 this.bar_ = document.createElement('div');
599 this.bar_.className = 'bar';
600 this.container_.appendChild(this.bar_);
602 this.filled_ = document.createElement('div');
603 this.filled_.className = 'filled';
604 this.bar_.appendChild(this.filled_);
606 var leftCap = document.createElement('div');
607 leftCap.className = 'cap left';
608 this.bar_.appendChild(leftCap);
610 var rightCap = document.createElement('div');
611 rightCap.className = 'cap right';
612 this.bar_.appendChild(rightCap);
615 this.setFilled_(value);
619 * @return {HTMLElement} The container element.
621 MediaControls.Slider.prototype.getContainer = function() {
622 return this.container_;
626 * @return {HTMLElement} The standard input element.
629 MediaControls.Slider.prototype.getInput_ = function() {
634 * @return {HTMLElement} The slider bar element.
636 MediaControls.Slider.prototype.getBar = function() {
641 * @return {number} [0..1] The current value.
643 MediaControls.Slider.prototype.getValue = function() {
648 * @param {number} value [0..1].
650 MediaControls.Slider.prototype.setValue = function(value) {
652 this.setValueToUI_(value);
656 * Fill the given proportion the slider bar (from the left).
658 * @param {number} proportion [0..1].
661 MediaControls.Slider.prototype.setFilled_ = function(proportion) {
662 this.filled_.style.width = proportion * 100 + '%';
666 * Get the value from the input element.
668 * @return {number} Value [0..1].
671 MediaControls.Slider.prototype.getValueFromUI_ = function() {
672 return this.input_.value / this.input_.max;
676 * Update the UI with the current value.
678 * @param {number} value [0..1].
681 MediaControls.Slider.prototype.setValueToUI_ = function(value) {
682 this.input_.value = value * this.input_.max;
683 this.setFilled_(value);
687 * Compute the proportion in which the given position divides the slider bar.
689 * @param {number} position in pixels.
690 * @return {number} [0..1] proportion.
692 MediaControls.Slider.prototype.getProportion = function(position) {
693 var rect = this.bar_.getBoundingClientRect();
694 return Math.max(0, Math.min(1, (position - rect.left) / rect.width));
698 * 'change' event handler.
701 MediaControls.Slider.prototype.onInputChange_ = function() {
702 this.value_ = this.getValueFromUI_();
703 this.setFilled_(this.value_);
704 this.onChange_(this.value_);
708 * @return {boolean} True if dragging is in progress.
710 MediaControls.Slider.prototype.isDragging = function() {
711 return this.isDragging_;
715 * Mousedown/mouseup handler.
716 * @param {boolean} on True if the mouse is down.
719 MediaControls.Slider.prototype.onInputDrag_ = function(on) {
720 this.isDragging_ = on;
725 * Create a customized slider with animated thumb movement.
727 * @param {HTMLElement} container The containing div element.
728 * @param {number} value Initial value [0..1].
729 * @param {number} range Number of distinct slider positions to be supported.
730 * @param {function(number)} onChange Value change handler.
731 * @param {function(boolean)} onDrag Drag begin/end handler.
732 * @param {function(number):string} formatFunction Value formatting function.
735 MediaControls.AnimatedSlider = function(
736 container, value, range, onChange, onDrag, formatFunction) {
737 MediaControls.Slider.apply(this, arguments);
740 MediaControls.AnimatedSlider.prototype = {
741 __proto__: MediaControls.Slider.prototype
745 * Number of animation steps.
747 MediaControls.AnimatedSlider.STEPS = 10;
750 * Animation duration.
752 MediaControls.AnimatedSlider.DURATION = 100;
755 * @param {number} value [0..1].
758 MediaControls.AnimatedSlider.prototype.setValueToUI_ = function(value) {
759 if (this.animationInterval_) {
760 clearInterval(this.animationInterval_);
762 var oldValue = this.getValueFromUI_();
764 this.animationInterval_ = setInterval(function() {
766 var currentValue = oldValue +
767 (value - oldValue) * (step / MediaControls.AnimatedSlider.STEPS);
768 MediaControls.Slider.prototype.setValueToUI_.call(this, currentValue);
769 if (step == MediaControls.AnimatedSlider.STEPS) {
770 clearInterval(this.animationInterval_);
773 MediaControls.AnimatedSlider.DURATION / MediaControls.AnimatedSlider.STEPS);
777 * Create a customized slider with a precise time feedback.
779 * The time value is shown above the slider bar at the mouse position.
781 * @param {HTMLElement} container The containing div element.
782 * @param {number} value Initial value [0..1].
783 * @param {number} range Number of distinct slider positions to be supported.
784 * @param {function(number)} onChange Value change handler.
785 * @param {function(boolean)} onDrag Drag begin/end handler.
786 * @param {function(number):string} formatFunction Value formatting function.
789 MediaControls.PreciseSlider = function(
790 container, value, range, onChange, onDrag, formatFunction) {
791 MediaControls.Slider.apply(this, arguments);
793 var doc = this.container_.ownerDocument;
796 * @type {function(number):string}
799 this.valueToString_ = null;
801 this.seekMark_ = doc.createElement('div');
802 this.seekMark_.className = 'seek-mark';
803 this.getBar().appendChild(this.seekMark_);
805 this.seekLabel_ = doc.createElement('div');
806 this.seekLabel_.className = 'seek-label';
807 this.seekMark_.appendChild(this.seekLabel_);
809 this.getContainer().addEventListener(
810 'mousemove', this.onMouseMove_.bind(this));
811 this.getContainer().addEventListener(
812 'mouseout', this.onMouseOut_.bind(this));
815 MediaControls.PreciseSlider.prototype = {
816 __proto__: MediaControls.Slider.prototype
820 * Show the seek mark after a delay.
822 MediaControls.PreciseSlider.SHOW_DELAY = 200;
825 * Hide the seek mark for this long after changing the position with a click.
827 MediaControls.PreciseSlider.HIDE_AFTER_MOVE_DELAY = 2500;
830 * Hide the seek mark for this long after changing the position with a drag.
832 MediaControls.PreciseSlider.HIDE_AFTER_DRAG_DELAY = 750;
835 * Default hide timeout (no hiding).
837 MediaControls.PreciseSlider.NO_AUTO_HIDE = 0;
840 * @param {function(number):string} func Value formatting function.
842 MediaControls.PreciseSlider.prototype.setValueToStringFunction =
844 this.valueToString_ = func;
846 /* It is not completely accurate to assume that the max value corresponds
847 to the longest string, but generous CSS padding will compensate for that. */
848 var labelWidth = this.valueToString_(1).length / 2 + 1;
849 this.seekLabel_.style.width = labelWidth + 'em';
850 this.seekLabel_.style.marginLeft = -labelWidth / 2 + 'em';
854 * Show the time above the slider.
856 * @param {number} ratio [0..1] The proportion of the duration.
857 * @param {number} timeout Timeout in ms after which the label should be hidden.
858 * MediaControls.PreciseSlider.NO_AUTO_HIDE means show until the next call.
861 MediaControls.PreciseSlider.prototype.showSeekMark_ =
862 function(ratio, timeout) {
863 // Do not update the seek mark for the first 500ms after the drag is finished.
864 if (this.latestMouseUpTime_ && (this.latestMouseUpTime_ + 500 > Date.now()))
867 this.seekMark_.style.left = ratio * 100 + '%';
869 if (ratio < this.getValue()) {
870 this.seekMark_.classList.remove('inverted');
872 this.seekMark_.classList.add('inverted');
874 this.seekLabel_.textContent = this.valueToString_(ratio);
876 this.seekMark_.classList.add('visible');
878 if (this.seekMarkTimer_) {
879 clearTimeout(this.seekMarkTimer_);
880 this.seekMarkTimer_ = null;
882 if (timeout != MediaControls.PreciseSlider.NO_AUTO_HIDE) {
883 this.seekMarkTimer_ = setTimeout(this.hideSeekMark_.bind(this), timeout);
890 MediaControls.PreciseSlider.prototype.hideSeekMark_ = function() {
891 this.seekMarkTimer_ = null;
892 this.seekMark_.classList.remove('visible');
896 * 'mouseout' event handler.
897 * @param {Event} e Event.
900 MediaControls.PreciseSlider.prototype.onMouseMove_ = function(e) {
901 this.latestSeekRatio_ = this.getProportion(e.clientX);
904 function showMark() {
905 if (!self.isDragging()) {
906 self.showSeekMark_(self.latestSeekRatio_,
907 MediaControls.PreciseSlider.HIDE_AFTER_MOVE_DELAY);
911 if (this.seekMark_.classList.contains('visible')) {
913 } else if (!this.seekMarkTimer_) {
914 this.seekMarkTimer_ =
915 setTimeout(showMark, MediaControls.PreciseSlider.SHOW_DELAY);
920 * 'mouseout' event handler.
921 * @param {Event} e Event.
924 MediaControls.PreciseSlider.prototype.onMouseOut_ = function(e) {
925 for (var element = e.relatedTarget; element; element = element.parentNode) {
926 if (element == this.getContainer())
929 if (this.seekMarkTimer_) {
930 clearTimeout(this.seekMarkTimer_);
931 this.seekMarkTimer_ = null;
933 this.hideSeekMark_();
937 * 'change' event handler.
940 MediaControls.PreciseSlider.prototype.onInputChange_ = function() {
941 MediaControls.Slider.prototype.onInputChange_.apply(this, arguments);
942 if (this.isDragging()) {
944 this.getValue(), MediaControls.PreciseSlider.NO_AUTO_HIDE);
949 * Mousedown/mouseup handler.
950 * @param {boolean} on True if the mouse is down.
953 MediaControls.PreciseSlider.prototype.onInputDrag_ = function(on) {
954 MediaControls.Slider.prototype.onInputDrag_.apply(this, arguments);
957 // Dragging started, align the seek mark with the thumb position.
959 this.getValue(), MediaControls.PreciseSlider.NO_AUTO_HIDE);
961 // Just finished dragging.
962 // Show the label for the last time with a shorter timeout.
964 this.getValue(), MediaControls.PreciseSlider.HIDE_AFTER_DRAG_DELAY);
965 this.latestMouseUpTime_ = Date.now();
970 * Create video controls.
972 * @param {HTMLElement} containerElement The container for the controls.
973 * @param {function} onMediaError Function to display an error message.
974 * @param {function(string):string} stringFunction Function providing localized
976 * @param {function=} opt_fullScreenToggle Function to toggle fullscreen mode.
977 * @param {HTMLElement=} opt_stateIconParent The parent for the icon that
978 * gives visual feedback when the playback state changes.
981 function VideoControls(containerElement, onMediaError, stringFunction,
982 opt_fullScreenToggle, opt_stateIconParent) {
983 MediaControls.call(this, containerElement, onMediaError);
984 this.stringFunction_ = stringFunction;
986 this.container_.classList.add('video-controls');
987 this.initPlayButton();
988 this.initTimeControls(true /* show seek mark */);
989 this.initVolumeControls();
991 if (opt_fullScreenToggle) {
992 this.fullscreenButton_ =
993 this.createButton('fullscreen', opt_fullScreenToggle);
996 if (opt_stateIconParent) {
997 this.stateIcon_ = this.createControl(
998 'playback-state-icon', opt_stateIconParent);
999 this.textBanner_ = this.createControl('text-banner', opt_stateIconParent);
1002 var videoControls = this;
1003 chrome.mediaPlayerPrivate.onTogglePlayState.addListener(
1004 function() { videoControls.togglePlayStateWithFeedback(); });
1008 * No resume if we are within this margin from the start or the end.
1010 VideoControls.RESUME_MARGIN = 0.03;
1013 * No resume for videos shorter than this.
1015 VideoControls.RESUME_THRESHOLD = 5 * 60; // 5 min.
1018 * When resuming rewind back this much.
1020 VideoControls.RESUME_REWIND = 5; // seconds.
1022 VideoControls.prototype = { __proto__: MediaControls.prototype };
1025 * Shows icon feedback for the current state of the video player.
1028 VideoControls.prototype.showIconFeedback_ = function() {
1029 this.stateIcon_.removeAttribute('state');
1030 setTimeout(function() {
1031 this.stateIcon_.setAttribute('state', this.isPlaying() ? 'play' : 'pause');
1036 * Shows a text banner.
1038 * @param {string} identifier String identifier.
1041 VideoControls.prototype.showTextBanner_ = function(identifier) {
1042 this.textBanner_.removeAttribute('visible');
1043 this.textBanner_.textContent = this.stringFunction_(identifier);
1044 setTimeout(function() {
1045 this.textBanner_.setAttribute('visible', 'true');
1050 * Toggle play/pause state on a mouse click on the play/pause button. Can be
1051 * called externally.
1053 * @param {Event} event Mouse click event.
1055 VideoControls.prototype.onPlayButtonClicked = function(event) {
1056 if (event.ctrlKey) {
1057 this.toggleLoopedModeWithFeedback(true);
1058 if (!this.isPlaying())
1059 this.togglePlayState();
1061 this.togglePlayState();
1066 * Media completion handler.
1068 VideoControls.prototype.onMediaComplete = function() {
1069 this.onMediaPlay_(false); // Just update the UI.
1070 this.savePosition(); // This will effectively forget the position.
1074 * Toggles the looped mode with feedback.
1075 * @param {boolean} on Whether enabled or not.
1077 VideoControls.prototype.toggleLoopedModeWithFeedback = function(on) {
1078 if (!this.getMedia().duration)
1080 this.toggleLoopedMode(on);
1082 // TODO(mtomasz): Simplify, crbug.com/254318.
1083 this.showTextBanner_('GALLERY_VIDEO_LOOPED_MODE');
1088 * Toggles the looped mode.
1089 * @param {boolean} on Whether enabled or not.
1091 VideoControls.prototype.toggleLoopedMode = function(on) {
1092 this.getMedia().loop = on;
1096 * Toggles play/pause state and flash an icon over the video.
1098 VideoControls.prototype.togglePlayStateWithFeedback = function() {
1099 if (!this.getMedia().duration)
1102 this.togglePlayState();
1103 this.showIconFeedback_();
1107 * Toggles play/pause state.
1109 VideoControls.prototype.togglePlayState = function() {
1110 if (this.isPlaying()) {
1111 // User gave the Pause command. Save the state and reset the loop mode.
1112 this.toggleLoopedMode(false);
1113 this.savePosition();
1115 MediaControls.prototype.togglePlayState.apply(this, arguments);
1119 * Saves the playback position to the persistent storage.
1120 * @param {boolean=} opt_sync True if the position must be saved synchronously
1121 * (required when closing app windows).
1123 VideoControls.prototype.savePosition = function(opt_sync) {
1124 if (!this.media_.duration ||
1125 this.media_.duration < VideoControls.RESUME_THRESHOLD) {
1129 var ratio = this.media_.currentTime / this.media_.duration;
1131 if (ratio < VideoControls.RESUME_MARGIN ||
1132 ratio > (1 - VideoControls.RESUME_MARGIN)) {
1133 // We are too close to the beginning or the end.
1134 // Remove the resume position so that next time we start from the beginning.
1137 position = Math.floor(
1138 Math.max(0, this.media_.currentTime - VideoControls.RESUME_REWIND));
1142 // Packaged apps cannot save synchronously.
1143 // Pass the data to the background page.
1144 if (!window.saveOnExit)
1145 window.saveOnExit = [];
1146 window.saveOnExit.push({ key: this.media_.src, value: position });
1148 util.AppCache.update(this.media_.src, position);
1153 * Resumes the playback position saved in the persistent storage.
1155 VideoControls.prototype.restorePlayState = function() {
1156 if (this.media_.duration >= VideoControls.RESUME_THRESHOLD) {
1157 util.AppCache.getValue(this.media_.src, function(position) {
1159 this.media_.currentTime = position;
1165 * Updates style to best fit the size of the container.
1167 VideoControls.prototype.updateStyle = function() {
1168 // We assume that the video controls element fills the parent container.
1169 // This is easier than adding margins to this.container_.clientWidth.
1170 var width = this.container_.parentNode.clientWidth;
1172 // Set the margin to 5px for width >= 400, 0px for width < 160,
1173 // interpolate linearly in between.
1174 this.container_.style.margin =
1175 Math.ceil((Math.max(160, Math.min(width, 400)) - 160) / 48) + 'px';
1177 var hideBelow = function(selector, limit) {
1178 this.container_.querySelector(selector).style.display =
1179 width < limit ? 'none' : '-webkit-box';
1182 hideBelow('.time', 350);
1183 hideBelow('.volume', 275);
1184 hideBelow('.volume-controls', 210);
1185 hideBelow('.fullscreen', 150);
1189 * Creates audio controls.
1191 * @param {HTMLElement} container Parent container.
1192 * @param {function(boolean)} advanceTrack Parameter: true=forward.
1193 * @param {function} onError Error handler.
1196 function AudioControls(container, advanceTrack, onError) {
1197 MediaControls.call(this, container, onError);
1199 this.container_.classList.add('audio-controls');
1201 this.advanceTrack_ = advanceTrack;
1203 this.initPlayButton();
1204 this.initTimeControls(false /* no seek mark */);
1205 /* No volume controls */
1206 this.createButton('previous', this.onAdvanceClick_.bind(this, false));
1207 this.createButton('next', this.onAdvanceClick_.bind(this, true));
1209 var audioControls = this;
1210 chrome.mediaPlayerPrivate.onNextTrack.addListener(
1211 function() { audioControls.onAdvanceClick_(true); });
1212 chrome.mediaPlayerPrivate.onPrevTrack.addListener(
1213 function() { audioControls.onAdvanceClick_(false); });
1214 chrome.mediaPlayerPrivate.onTogglePlayState.addListener(
1215 function() { audioControls.togglePlayState(); });
1218 AudioControls.prototype = { __proto__: MediaControls.prototype };
1221 * Media completion handler. Advances to the next track.
1223 AudioControls.prototype.onMediaComplete = function() {
1224 this.advanceTrack_(true);
1228 * The track position after which "previous" button acts as "restart".
1230 AudioControls.TRACK_RESTART_THRESHOLD = 5; // seconds.
1233 * @param {boolean} forward True if advancing forward.
1236 AudioControls.prototype.onAdvanceClick_ = function(forward) {
1238 (this.getMedia().currentTime > AudioControls.TRACK_RESTART_THRESHOLD)) {
1239 // We are far enough from the beginning of the current track.
1240 // Restart it instead of than skipping to the previous one.
1241 this.getMedia().currentTime = 0;
1243 this.advanceTrack_(forward);