-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(UI): Add ad statistics button #6827
Merged
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,235 @@ | ||
| /*! @license | ||
| * Shaka Player | ||
| * Copyright 2016 Google LLC | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
|
|
||
| goog.provide('shaka.ui.AdStatisticsButton'); | ||
|
|
||
| goog.require('shaka.log'); | ||
| goog.require('shaka.ads.AdManager'); | ||
| goog.require('shaka.ui.ContextMenu'); | ||
| goog.require('shaka.ui.Controls'); | ||
| goog.require('shaka.ui.Element'); | ||
| goog.require('shaka.ui.Enums'); | ||
| goog.require('shaka.ui.Locales'); | ||
| goog.require('shaka.ui.Localization'); | ||
| goog.require('shaka.ui.OverflowMenu'); | ||
| goog.require('shaka.ui.Utils'); | ||
| goog.require('shaka.util.Dom'); | ||
| goog.require('shaka.util.Timer'); | ||
| goog.requireType('shaka.ui.Controls'); | ||
|
|
||
|
|
||
| /** | ||
| * @extends {shaka.ui.Element} | ||
| * @final | ||
| * @export | ||
| */ | ||
| shaka.ui.AdStatisticsButton = class extends shaka.ui.Element { | ||
| /** | ||
| * @param {!HTMLElement} parent | ||
| * @param {!shaka.ui.Controls} controls | ||
| */ | ||
| constructor(parent, controls) { | ||
| super(parent, controls); | ||
|
|
||
| /** @private {!HTMLButtonElement} */ | ||
| this.button_ = shaka.util.Dom.createButton(); | ||
| this.button_.classList.add('shaka-ad-statistics-button'); | ||
|
|
||
| /** @private {!HTMLElement} */ | ||
| this.icon_ = shaka.util.Dom.createHTMLElement('i'); | ||
| this.icon_.classList.add('material-icons-round'); | ||
| this.icon_.textContent = | ||
| shaka.ui.Enums.MaterialDesignIcons.STATISTICS_ON; | ||
| this.button_.appendChild(this.icon_); | ||
|
|
||
| const label = shaka.util.Dom.createHTMLElement('label'); | ||
| label.classList.add('shaka-overflow-button-label'); | ||
|
|
||
| /** @private {!HTMLElement} */ | ||
| this.nameSpan_ = shaka.util.Dom.createHTMLElement('span'); | ||
| label.appendChild(this.nameSpan_); | ||
|
|
||
| /** @private {!HTMLElement} */ | ||
| this.stateSpan_ = shaka.util.Dom.createHTMLElement('span'); | ||
| this.stateSpan_.classList.add('shaka-current-selection-span'); | ||
| label.appendChild(this.stateSpan_); | ||
|
|
||
| this.button_.appendChild(label); | ||
|
|
||
| this.parent.appendChild(this.button_); | ||
|
|
||
| /** @private {!HTMLElement} */ | ||
| this.container_ = shaka.util.Dom.createHTMLElement('div'); | ||
| this.container_.classList.add('shaka-no-propagation'); | ||
| this.container_.classList.add('shaka-show-controls-on-mouse-over'); | ||
| this.container_.classList.add('shaka-ad-statistics-container'); | ||
| this.container_.classList.add('shaka-hidden'); | ||
|
|
||
| const controlsContainer = this.controls.getControlsContainer(); | ||
| controlsContainer.appendChild(this.container_); | ||
|
|
||
| /** @private {!Array} */ | ||
| this.statisticsList_ = []; | ||
|
|
||
| /** @private {!Object.<string, (number|!Array.<number>)>} */ | ||
| this.currentStats_ = this.adManager.getStats(); | ||
|
|
||
| /** @private {!Object.<string, HTMLElement>} */ | ||
| this.displayedElements_ = {}; | ||
|
|
||
| const parseLoadTimes = (name) => { | ||
| let totalTime = 0; | ||
| const loadTimes = | ||
| /** @type {!Array.<number>} */ (this.currentStats_[name]); | ||
| for (const loadTime of loadTimes) { | ||
| totalTime += parseFloat(loadTime); | ||
| } | ||
| return totalTime; | ||
| }; | ||
|
|
||
| const showNumber = (name) => { | ||
| return this.currentStats_[name]; | ||
| }; | ||
|
|
||
| /** @private {!Object.<string, function(string):string>} */ | ||
| this.parseFrom_ = { | ||
| 'loadTimes': parseLoadTimes, | ||
| 'started': showNumber, | ||
| 'playedCompletely': showNumber, | ||
| 'skipped': showNumber, | ||
| }; | ||
|
|
||
| /** @private {shaka.util.Timer} */ | ||
| this.timer_ = new shaka.util.Timer(() => { | ||
| this.onTimerTick_(); | ||
| }); | ||
|
|
||
| this.updateLocalizedStrings_(); | ||
|
|
||
| this.loadContainer_(); | ||
|
|
||
| this.eventManager.listen( | ||
| this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => { | ||
| this.updateLocalizedStrings_(); | ||
| }); | ||
|
|
||
| this.eventManager.listen( | ||
| this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => { | ||
| this.updateLocalizedStrings_(); | ||
| }); | ||
|
|
||
| this.eventManager.listen(this.button_, 'click', () => { | ||
| this.onClick_(); | ||
| this.updateLocalizedStrings_(); | ||
| }); | ||
|
|
||
| this.eventManager.listen(this.player, 'loading', () => { | ||
| shaka.ui.Utils.setDisplay(this.button_, false); | ||
| }); | ||
|
|
||
| this.eventManager.listen( | ||
| this.adManager, shaka.ads.AdManager.AD_STARTED, () => { | ||
| shaka.ui.Utils.setDisplay(this.button_, true); | ||
| }); | ||
| } | ||
|
|
||
| /** @private */ | ||
| onClick_() { | ||
| shaka.ui.Utils.setDisplay(this.parent, false); | ||
|
|
||
| if (this.container_.classList.contains('shaka-hidden')) { | ||
| this.icon_.textContent = | ||
| shaka.ui.Enums.MaterialDesignIcons.STATISTICS_OFF; | ||
| this.timer_.tickEvery(0.1); | ||
| shaka.ui.Utils.setDisplay(this.container_, true); | ||
| } else { | ||
| this.icon_.textContent = | ||
| shaka.ui.Enums.MaterialDesignIcons.STATISTICS_ON; | ||
| this.timer_.stop(); | ||
| shaka.ui.Utils.setDisplay(this.container_, false); | ||
| } | ||
| } | ||
|
|
||
| /** @private */ | ||
| updateLocalizedStrings_() { | ||
| const LocIds = shaka.ui.Locales.Ids; | ||
|
|
||
| this.nameSpan_.textContent = | ||
| this.localization.resolve(LocIds.AD_STATISTICS); | ||
|
|
||
| this.button_.ariaLabel = this.localization.resolve(LocIds.AD_STATISTICS); | ||
|
|
||
| const labelText = this.container_.classList.contains('shaka-hidden') ? | ||
| LocIds.OFF : LocIds.ON; | ||
| this.stateSpan_.textContent = this.localization.resolve(labelText); | ||
| } | ||
|
|
||
| /** @private */ | ||
| generateComponent_(name) { | ||
| const section = shaka.util.Dom.createHTMLElement('div'); | ||
|
|
||
| const label = shaka.util.Dom.createHTMLElement('label'); | ||
| label.textContent = name + ':'; | ||
| section.appendChild(label); | ||
|
|
||
| const value = shaka.util.Dom.createHTMLElement('span'); | ||
| value.textContent = this.parseFrom_[name](name); | ||
| section.appendChild(value); | ||
|
|
||
| this.displayedElements_[name] = value; | ||
|
|
||
| return section; | ||
| } | ||
|
|
||
| /** @private */ | ||
| loadContainer_() { | ||
| for (const name of this.controls.getConfig().adStatisticsList) { | ||
| if (name in this.currentStats_) { | ||
| this.container_.appendChild(this.generateComponent_(name)); | ||
| this.statisticsList_.push(name); | ||
| } else { | ||
| shaka.log.alwaysWarn('Unrecognized ad statistic element:', name); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** @private */ | ||
| onTimerTick_() { | ||
| this.currentStats_ = this.adManager.getStats(); | ||
|
|
||
| for (const name of this.statisticsList_) { | ||
| this.displayedElements_[name].textContent = | ||
| this.parseFrom_[name](name); | ||
| } | ||
| } | ||
|
|
||
| /** @override */ | ||
| release() { | ||
| this.timer_.stop(); | ||
| this.timer_ = null; | ||
| super.release(); | ||
| } | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * @implements {shaka.extern.IUIElement.Factory} | ||
| * @final | ||
| */ | ||
| shaka.ui.AdStatisticsButton.Factory = class { | ||
| /** @override */ | ||
| create(rootElement, controls) { | ||
| return new shaka.ui.AdStatisticsButton(rootElement, controls); | ||
| } | ||
| }; | ||
|
|
||
|
|
||
| shaka.ui.OverflowMenu.registerElement( | ||
| 'ad_statistics', new shaka.ui.AdStatisticsButton.Factory()); | ||
|
|
||
| shaka.ui.ContextMenu.registerElement( | ||
| 'ad_statistics', new shaka.ui.AdStatisticsButton.Factory()); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Be sure to add this to docs/tutorials/ui-customization.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That doc also lists elements that can be added to different UI areas. See, for example, where it lists
picture_in_pictureThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!