4bf19d73fd
* Javadoc introduced @code as a replacement of <code> and <tt> which is better aligned with other javadoc tags such as @link. Use it in the Java source code. If we switch to Kotlin, then we'll definitely use Markdown. * There are more uses of @code in the JavaScript source code than <tt> so use @code for the sake of consistency. Eventually, I'd rather we switch to Markdown because it's easier on my eyes. * Xcode is plain confused by @code and @link. The Internet says that Xcode supports the backquote character to denote the beginning and end of a string of characters which should be formatted for display as code but it doesn't work for me. <tt> is not rendered at all. So use the backquote which is rendered itself. Hopefully, if we switch to Markdown, then it'll be common between JavaScript and Objective-C source code.
68 lines
2.2 KiB
JavaScript
68 lines
2.2 KiB
JavaScript
/* @flow */
|
|
|
|
import { toState } from '../redux';
|
|
|
|
import { VIDEO_MUTISM_AUTHORITY } from './constants';
|
|
|
|
/**
|
|
* Determines whether video is currently muted by the audio-only authority.
|
|
*
|
|
* @param {Function|Object} stateful - The redux store, state, or
|
|
* {@code getState} function.
|
|
* @returns {boolean}
|
|
*/
|
|
export function isVideoMutedByAudioOnly(stateful: Function | Object) {
|
|
return (
|
|
_isVideoMutedByAuthority(stateful, VIDEO_MUTISM_AUTHORITY.AUDIO_ONLY));
|
|
}
|
|
|
|
/**
|
|
* Determines whether video is currently muted by a specific
|
|
* {@code VIDEO_MUTISM_AUTHORITY}.
|
|
*
|
|
* @param {Function|Object} stateful - The redux store, state, or
|
|
* {@code getState} function.
|
|
* @param {number} videoMutismAuthority - The {@code VIDEO_MUTISM_AUTHORITY}
|
|
* which is to be checked whether it has muted video.
|
|
* @returns {boolean} If video is currently muted by the specified
|
|
* {@code videoMutismAuthority}, then {@code true}; otherwise, {@code false}.
|
|
*/
|
|
function _isVideoMutedByAuthority(
|
|
stateful: Function | Object,
|
|
videoMutismAuthority: number) {
|
|
const { muted } = toState(stateful)['features/base/media'].video;
|
|
|
|
// eslint-disable-next-line no-bitwise
|
|
return Boolean(muted & videoMutismAuthority);
|
|
}
|
|
|
|
/**
|
|
* Determines whether video is currently muted by the user authority.
|
|
*
|
|
* @param {Function|Object} stateful - The redux store, state, or
|
|
* {@code getState} function.
|
|
* @returns {boolean}
|
|
*/
|
|
export function isVideoMutedByUser(stateful: Function | Object) {
|
|
return _isVideoMutedByAuthority(stateful, VIDEO_MUTISM_AUTHORITY.USER);
|
|
}
|
|
|
|
/**
|
|
* Determines whether a specific videoTrack should be rendered.
|
|
*
|
|
* @param {Track} videoTrack - The video track which is to be rendered.
|
|
* @param {boolean} waitForVideoStarted - True if the specified videoTrack
|
|
* should be rendered only after its associated video has started;
|
|
* otherwise, false.
|
|
* @returns {boolean} True if the specified videoTrack should be renderd;
|
|
* otherwise, false.
|
|
*/
|
|
export function shouldRenderVideoTrack(
|
|
videoTrack: { muted: boolean, videoStarted: boolean },
|
|
waitForVideoStarted: boolean) {
|
|
return (
|
|
videoTrack
|
|
&& !videoTrack.muted
|
|
&& (!waitForVideoStarted || videoTrack.videoStarted));
|
|
}
|