jiti-meet/react/features/base/toolbox/components/AbstractVideoMuteButton.js

62 lines
1.5 KiB
JavaScript

// @flow
import { IconCamera, IconCameraDisabled } from '../../icons';
import AbstractButton from './AbstractButton';
import type { Props } from './AbstractButton';
/**
* An abstract implementation of a button for toggling video mute.
*/
export default class AbstractVideoMuteButton<P : Props, S : *>
extends AbstractButton<P, S> {
icon = IconCamera;
toggledIcon = IconCameraDisabled;
/**
* Handles clicking / pressing the button, and toggles the video mute state
* accordingly.
*
* @protected
* @returns {void}
*/
_handleClick() {
this._setVideoMuted(!this._isVideoMuted());
}
/**
* Indicates whether this button is in toggled state or not.
*
* @override
* @protected
* @returns {boolean}
*/
_isToggled() {
return this._isVideoMuted();
}
/**
* Helper function to be implemented by subclasses, which must return a
* {@code boolean} value indicating if video is muted or not.
*
* @protected
* @returns {boolean}
*/
_isVideoMuted() {
// To be implemented by subclass.
}
/**
* Helper function to perform the actual setting of the video mute / unmute
* action.
*
* @param {boolean} videoMuted - Whether video should be muted or not.
* @protected
* @returns {void}
*/
_setVideoMuted(videoMuted: boolean) { // eslint-disable-line no-unused-vars
// To be implemented by subclass.
}
}