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

171 lines
4.3 KiB
JavaScript
Raw Normal View History

// @flow
import {
ACTION_SHORTCUT_TRIGGERED,
AUDIO_MUTE,
createShortcutEvent,
sendAnalytics
} from '../../analytics';
import { AUDIO_MUTE_BUTTON_ENABLED, getFeatureFlag } from '../../base/flags';
import { translate } from '../../base/i18n';
import { MEDIA_TYPE } from '../../base/media';
2019-03-21 16:38:29 +00:00
import { connect } from '../../base/redux';
import { AbstractAudioMuteButton, AbstractButton } from '../../base/toolbox/components';
2020-07-24 12:14:33 +00:00
import type { AbstractButtonProps } from '../../base/toolbox/components';
import { isLocalTrackMuted } from '../../base/tracks';
import { muteLocal } from '../../video-menu/actions';
import { isAudioMuteButtonDisabled } from '../functions';
declare var APP: Object;
2018-05-11 02:10:26 +00:00
/**
* The type of the React {@code Component} props of {@link AudioMuteButton}.
*/
type Props = AbstractButtonProps & {
/**
* Whether audio is currently muted or not.
*/
_audioMuted: boolean,
/**
* Whether the button is disabled.
*/
_disabled: boolean,
/**
* The redux {@code dispatch} function.
*/
dispatch: Function
}
/**
* Component that renders a toolbar button for toggling audio mute.
*
2021-11-04 21:10:43 +00:00
* @augments AbstractAudioMuteButton
*/
class AudioMuteButton extends AbstractAudioMuteButton<Props, *> {
fix(i18n) Accessiblity labels translations (#3071) * fix(toolbar): accessibilityLabel should be translatable. This commit adds a helper property to get the accessibilityLabel of an item, providing a translation if one is available. This mimics the behavior of label and tooltip. * fix(toolbar) 'hangup' button accessibilityLabel i18n * fix(toolbar) 'mute' button accessibilityLabel i18n * fix(toolbar) 'videomute' button accessibilityLabel i18n * fix(toolbar) 'moreActions' button accessibilityLabel i18n * fix(toolbar) 'shareRoom' button accessibilityLabel i18n * fix(toolbar) 'audioRoute' button accessibilityLabel i18n * fix(toolbar) 'toggleCamera' button accessibilityLabel i18n * fix(toolbar) 'audioOnly' button accessibilityLabel i18n * fix(toolbar) 'roomLock' button accessibilityLabel i18n * fix(toolbar) 'pip' button accessibilityLabel i18n * fix(toolbar) 'invite' button accessibilityLabel i18n * fix(toolbar) 'raiseHand' button accessibilityLabel i18n * fix(toolbar) 'chat' button accessibilityLabel i18n * fix(toolbar) 'shareYourScreen' button accessibilityLabel i18n * fix(toolbar) 'fullScreen' button accessibilityLabel i18n * fix(toolbar) 'sharedvideo' button accessibilityLabel i18n * fix(toolbar) 'document' button accessibilityLabel i18n * fix(toolbar) 'speakerStats' button accessibilityLabel i18n * fix(toolbar) 'feedback' button accessibilityLabel i18n * fix(toolbar) 'shortcuts' button accessibilityLabel i18n * fix(toolbar) 'recording' button accessibilityLabel i18n * fix(toolbar) 'settings' button accessibilityLabel i18n * fix(welcomepage) accessibilityLabels i18n * fix(toolbar) 'info' button accessibilityLabel i18n * fix(i18n): Add translation to various aria-label property values. * fix(i18n): Differentiate between overflow menu and button.
2018-06-07 20:32:18 +00:00
accessibilityLabel = 'toolbar.accessibilityLabel.mute';
label = 'toolbar.mute';
tooltip = 'toolbar.mute';
/**
* Initializes a new {@code AudioMuteButton} 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 audio muting.
*
* @inheritdoc
* @returns {void}
*/
componentDidMount() {
typeof APP === 'undefined'
|| APP.keyboardshortcut.registerShortcut(
'M',
null,
this._onKeyboardShortcut,
'keyboardShortcuts.mute');
}
/**
* Unregisters the keyboard shortcut that toggles the audio muting.
*
* @inheritdoc
* @returns {void}
*/
componentWillUnmount() {
typeof APP === 'undefined'
|| APP.keyboardshortcut.unregisterShortcut('M');
}
/**
* Indicates if audio is currently muted or not.
*
* @override
2018-05-11 02:10:26 +00:00
* @protected
* @returns {boolean}
*/
_isAudioMuted() {
return this.props._audioMuted;
}
_onKeyboardShortcut: () => void;
/**
* Creates an analytics keyboard shortcut event and dispatches an action to
* toggle the audio muting.
*
* @private
* @returns {void}
*/
_onKeyboardShortcut() {
// Ignore keyboard shortcuts if the audio button is disabled.
if (this._isDisabled()) {
return;
}
sendAnalytics(
createShortcutEvent(
AUDIO_MUTE,
ACTION_SHORTCUT_TRIGGERED,
{ enable: !this._isAudioMuted() }));
AbstractButton.prototype._onClick.call(this);
}
/**
* Changes the muted state.
*
* @param {boolean} audioMuted - Whether audio should be muted or not.
2018-05-11 02:10:26 +00:00
* @protected
* @returns {void}
*/
_setAudioMuted(audioMuted: boolean) {
this.props.dispatch(muteLocal(audioMuted, MEDIA_TYPE.AUDIO));
}
/**
* Return a boolean value indicating if this button is disabled or not.
*
* @returns {boolean}
*/
_isDisabled() {
return this.props._disabled;
}
}
/**
* Maps (parts of) the redux state to the associated props for the
* {@code AudioMuteButton} component.
*
* @param {Object} state - The Redux state.
* @private
* @returns {{
2020-04-16 10:47:10 +00:00
* _audioMuted: boolean,
* _disabled: boolean
* }}
*/
function _mapStateToProps(state): Object {
const _audioMuted = isLocalTrackMuted(state['features/base/tracks'], MEDIA_TYPE.AUDIO);
const _disabled = isAudioMuteButtonDisabled(state);
const enabledFlag = getFeatureFlag(state, AUDIO_MUTE_BUTTON_ENABLED, true);
return {
2020-04-16 10:47:10 +00:00
_audioMuted,
_disabled,
visible: enabledFlag
};
}
export default translate(connect(_mapStateToProps)(AudioMuteButton));