mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-14 15:56:38 +03:00
Phyo Wai Lin
e7b1e5a0f6
## How to register a custom icon?
**Icons need to be registered before initializing the player.**
Register a custom icon from Material Symbols:
```js
shaka.ui.IconRegistry.register('<PATH_VALUE>');
```
Register a custom Icon from any icon set:
```js
shaka.ui.IconRegistry.register('<NAME>', {
path: '<PATH_VALUE>',
viewBox: '<VIEW_BOX>',
size: 24, // optional
});
```
Register a custom Icon (that contains multiple paths) from any icon set:
```js
shaka.ui.IconRegistry.register('<NAME>', {
path: ['<PATH_VALUE_1>', '<PATH_VALUE_2>'],
viewBox: '<VIEW_BOX>',
size: 24, // optional
});
```
Register a custom Icon using URL of the icon:
```js
shaka.ui.IconRegistry.register('<NAME>', {
url: '<URL>',
size: 24, // optional
});
```
Closes: #9045
---------
Co-authored-by: Álvaro Velad Galván <ladvan91@hotmail.com>
121 lines
3.2 KiB
JavaScript
121 lines
3.2 KiB
JavaScript
/*! @license
|
|
* Shaka Player
|
|
* Copyright 2016 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
|
|
goog.provide('shaka.ui.FastForwardButton');
|
|
|
|
goog.require('shaka.ui.Controls');
|
|
goog.require('shaka.ui.Element');
|
|
goog.require('shaka.ui.Enums');
|
|
goog.require('shaka.ui.Icon');
|
|
goog.require('shaka.ui.Locales');
|
|
goog.require('shaka.ui.Localization');
|
|
goog.require('shaka.util.Dom');
|
|
|
|
|
|
/**
|
|
* @extends {shaka.ui.Element}
|
|
* @final
|
|
* @export
|
|
*/
|
|
shaka.ui.FastForwardButton = 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-fast-forward-button');
|
|
this.button_.classList.add('shaka-tooltip-status');
|
|
this.button_.setAttribute('shaka-status', '1x');
|
|
|
|
new shaka.ui.Icon(this.button_).use(
|
|
shaka.ui.Enums.MaterialDesignSVGIcons['FAST_FORWARD']);
|
|
|
|
this.parent.appendChild(this.button_);
|
|
this.updateAriaLabel_();
|
|
|
|
/** @private {!Array<number>} */
|
|
this.fastForwardRates_ = this.controls.getConfig().fastForwardRates;
|
|
|
|
this.eventManager.listen(
|
|
this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
|
|
this.updateAriaLabel_();
|
|
});
|
|
|
|
this.eventManager.listen(
|
|
this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
|
|
this.updateAriaLabel_();
|
|
});
|
|
|
|
this.eventManager.listen(this.button_, 'click', () => {
|
|
if (!this.controls.isOpaque()) {
|
|
return;
|
|
}
|
|
this.fastForward_();
|
|
});
|
|
|
|
this.eventManager.listen(this.player, 'ratechange', () => {
|
|
this.button_.setAttribute(
|
|
'shaka-status', this.player.getPlaybackRate() + 'x');
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @private
|
|
*/
|
|
updateAriaLabel_() {
|
|
this.button_.ariaLabel =
|
|
this.localization.resolve(shaka.ui.Locales.Ids.FAST_FORWARD);
|
|
}
|
|
|
|
/**
|
|
* Cycles trick play rate between the selected fast forward rates.
|
|
* @private
|
|
*/
|
|
fastForward_() {
|
|
if (!this.video.duration) {
|
|
return;
|
|
}
|
|
|
|
const trickPlayRate = this.player.getPlaybackRate();
|
|
const newRateIndex = this.fastForwardRates_.indexOf(trickPlayRate) + 1;
|
|
|
|
// When the button is clicked, the next rate in this.fastForwardRates_ is
|
|
// selected. If no more rates are available, the first one is set.
|
|
const newRate = (newRateIndex != this.fastForwardRates_.length) ?
|
|
this.fastForwardRates_[newRateIndex] : this.fastForwardRates_[0];
|
|
|
|
if (this.video.paused) {
|
|
// Our fast forward is implemented with playbackRate and needs the video
|
|
// to be playing (to not be paused) to take immediate effect.
|
|
// If the video is paused, "unpause" it.
|
|
this.video.play();
|
|
}
|
|
this.player.trickPlay(newRate);
|
|
|
|
this.button_.setAttribute('shaka-status', newRate + 'x');
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* @implements {shaka.extern.IUIElement.Factory}
|
|
* @final
|
|
*/
|
|
shaka.ui.FastForwardButton.Factory = class {
|
|
/** @override */
|
|
create(rootElement, controls) {
|
|
return new shaka.ui.FastForwardButton(rootElement, controls);
|
|
}
|
|
};
|
|
|
|
shaka.ui.Controls.registerElement(
|
|
'fast_forward', new shaka.ui.FastForwardButton.Factory());
|