jiti-meet/react/features/toolbox/components/VideoMuteButton.js

173 lines
4.4 KiB
JavaScript

// @flow
import {
ACTION_SHORTCUT_TRIGGERED,
VIDEO_MUTE,
createShortcutEvent,
sendAnalytics
} from '../../analytics';
import { VIDEO_MUTE_BUTTON_ENABLED, getFeatureFlag } from '../../base/flags';
import { translate } from '../../base/i18n';
import { MEDIA_TYPE } from '../../base/media';
import { connect } from '../../base/redux';
import { AbstractButton, AbstractVideoMuteButton } from '../../base/toolbox/components';
import type { AbstractButtonProps } from '../../base/toolbox/components';
import { isLocalTrackMuted } from '../../base/tracks';
import { handleToggleVideoMuted } from '../actions.any';
import { isVideoMuteButtonDisabled } from '../functions';
declare var APP: Object;
/**
* The type of the React {@code Component} props of {@link VideoMuteButton}.
*/
type Props = AbstractButtonProps & {
/**
* Whether video is currently muted or not.
*/
_videoMuted: boolean,
/**
* Whether video button is disabled or not.
*/
_videoDisabled: boolean,
/**
* The redux {@code dispatch} function.
*/
dispatch: Function
}
/**
* Component that renders a toolbar button for toggling video mute.
*
* @augments AbstractVideoMuteButton
*/
class VideoMuteButton extends AbstractVideoMuteButton<Props, *> {
accessibilityLabel = 'toolbar.accessibilityLabel.videomute';
label = 'toolbar.videomute';
tooltip = 'toolbar.videomute';
/**
* Initializes a new {@code VideoMuteButton} instance.
*
* @param {Props} props - The read-only React {@code Component} props with
* which the new instance is to be initialized.
*/
constructor(props: Props) {
super(props);
// Bind event handlers so they are only bound once per instance.
this._onKeyboardShortcut = this._onKeyboardShortcut.bind(this);
}
/**
* Registers the keyboard shortcut that toggles the video muting.
*
* @inheritdoc
* @returns {void}
*/
componentDidMount() {
typeof APP === 'undefined'
|| APP.keyboardshortcut.registerShortcut(
'V',
null,
this._onKeyboardShortcut,
'keyboardShortcuts.videoMute');
}
/**
* Unregisters the keyboard shortcut that toggles the video muting.
*
* @inheritdoc
* @returns {void}
*/
componentWillUnmount() {
typeof APP === 'undefined'
|| APP.keyboardshortcut.unregisterShortcut('V');
}
/**
* Indicates if video is currently disabled or not.
*
* @override
* @protected
* @returns {boolean}
*/
_isDisabled() {
return this.props._videoDisabled;
}
/**
* Indicates if video is currently muted or not.
*
* @override
* @protected
* @returns {boolean}
*/
_isVideoMuted() {
return this.props._videoMuted;
}
_onKeyboardShortcut: () => void;
/**
* Creates an analytics keyboard shortcut event and dispatches an action to
* toggle the video muting.
*
* @private
* @returns {void}
*/
_onKeyboardShortcut() {
// Ignore keyboard shortcuts if the video button is disabled.
if (this._isDisabled()) {
return;
}
sendAnalytics(
createShortcutEvent(
VIDEO_MUTE,
ACTION_SHORTCUT_TRIGGERED,
{ enable: !this._isVideoMuted() }));
AbstractButton.prototype._onClick.call(this);
}
/**
* Changes the muted state.
*
* @override
* @param {boolean} videoMuted - Whether video should be muted or not.
* @protected
* @returns {void}
*/
_setVideoMuted(videoMuted: boolean) {
this.props.dispatch(handleToggleVideoMuted(videoMuted, true, true));
}
}
/**
* Maps (parts of) the redux state to the associated props for the
* {@code VideoMuteButton} component.
*
* @param {Object} state - The Redux state.
* @private
* @returns {{
* _videoMuted: boolean
* }}
*/
function _mapStateToProps(state): Object {
const tracks = state['features/base/tracks'];
const enabledFlag = getFeatureFlag(state, VIDEO_MUTE_BUTTON_ENABLED, true);
return {
_videoDisabled: isVideoMuteButtonDisabled(state),
_videoMuted: isLocalTrackMuted(tracks, MEDIA_TYPE.VIDEO),
visible: enabledFlag
};
}
export default translate(connect(_mapStateToProps)(VideoMuteButton));