99ce5064f5
To track media devices, we were previously relying on a combination of LiveKit's useMediaDeviceSelect hook, and an object called UserChoices. Device settings should be accessible from outside a call, but the latter hook should only be used with a room or set of preview tracks, so it couldn't be raised to the app's top level. I also felt that the UserChoices code was hard to follow due to lack of clear ownership of the object. To bring clarity to media device handling and allow device settings to be shown outside a call, I refactored these things into a single MediaDevicesContext which is instantiated at the top level of the app. Then, I had to manually sync LiveKit's device state with whatever is present in the context. This refactoring ended up fixing a couple other bugs with device handling along the way.
560 lines
17 KiB
TypeScript
560 lines
17 KiB
TypeScript
/*
|
|
Copyright 2022 - 2023 New Vector Ltd
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import { ResizeObserver } from "@juggle/resize-observer";
|
|
import {
|
|
RoomAudioRenderer,
|
|
RoomContext,
|
|
useLocalParticipant,
|
|
useParticipants,
|
|
useTracks,
|
|
} from "@livekit/components-react";
|
|
import { usePreventScroll } from "@react-aria/overlays";
|
|
import classNames from "classnames";
|
|
import { DisconnectReason, Room, RoomEvent, Track } from "livekit-client";
|
|
import { MatrixClient } from "matrix-js-sdk/src/client";
|
|
import { RoomMember } from "matrix-js-sdk/src/models/room-member";
|
|
import { GroupCall } from "matrix-js-sdk/src/webrtc/groupCall";
|
|
import { Ref, useCallback, useEffect, useMemo, useRef } from "react";
|
|
import { useTranslation } from "react-i18next";
|
|
import useMeasure from "react-use-measure";
|
|
import { OverlayTriggerState } from "@react-stately/overlays";
|
|
import { JoinRule } from "matrix-js-sdk/src/@types/partials";
|
|
import { logger } from "matrix-js-sdk/src/logger";
|
|
|
|
import type { IWidgetApiRequest } from "matrix-widget-api";
|
|
import {
|
|
HangupButton,
|
|
MicButton,
|
|
VideoButton,
|
|
ScreenshareButton,
|
|
SettingsButton,
|
|
InviteButton,
|
|
} from "../button";
|
|
import {
|
|
Header,
|
|
LeftNav,
|
|
RightNav,
|
|
RoomHeaderInfo,
|
|
VersionMismatchWarning,
|
|
} from "../Header";
|
|
import {
|
|
useVideoGridLayout,
|
|
TileDescriptor,
|
|
VideoGrid,
|
|
} from "../video-grid/VideoGrid";
|
|
import {
|
|
useShowInspector,
|
|
useShowConnectionStats,
|
|
} from "../settings/useSetting";
|
|
import { useModalTriggerState } from "../Modal";
|
|
import { PosthogAnalytics } from "../analytics/PosthogAnalytics";
|
|
import { useUrlParams } from "../UrlParams";
|
|
import { useCallViewKeyboardShortcuts } from "../useCallViewKeyboardShortcuts";
|
|
import { usePrefersReducedMotion } from "../usePrefersReducedMotion";
|
|
import { ElementWidgetActions, widget } from "../widget";
|
|
import { GridLayoutMenu } from "./GridLayoutMenu";
|
|
import { GroupCallInspector } from "./GroupCallInspector";
|
|
import styles from "./InCallView.module.css";
|
|
import { useJoinRule } from "./useJoinRule";
|
|
import { ParticipantInfo } from "./useGroupCall";
|
|
import { ItemData, TileContent, VideoTile } from "../video-grid/VideoTile";
|
|
import { NewVideoGrid } from "../video-grid/NewVideoGrid";
|
|
import { OTelGroupCallMembership } from "../otel/OTelGroupCallMembership";
|
|
import { SettingsModal } from "../settings/SettingsModal";
|
|
import { InviteModal } from "./InviteModal";
|
|
import { useRageshakeRequestModal } from "../settings/submit-rageshake";
|
|
import { RageshakeRequestModal } from "./RageshakeRequestModal";
|
|
import { E2EEConfig, useLiveKit } from "../livekit/useLiveKit";
|
|
import { useFullscreen } from "./useFullscreen";
|
|
import { useLayoutStates } from "../video-grid/Layout";
|
|
import { useSFUConfig } from "../livekit/OpenIDLoader";
|
|
import { E2EELock } from "../E2EELock";
|
|
import { useEventEmitterThree } from "../useEvents";
|
|
import { useWakeLock } from "../useWakeLock";
|
|
import { useMergedRefs } from "../useMergedRefs";
|
|
import { MuteStates } from "./MuteStates";
|
|
|
|
const canScreenshare = "getDisplayMedia" in (navigator.mediaDevices ?? {});
|
|
// There is currently a bug in Safari our our code with cloning and sending MediaStreams
|
|
// or with getUsermedia and getDisplaymedia being used within the same session.
|
|
// For now we can disable screensharing in Safari.
|
|
const isSafari = /^((?!chrome|android).)*safari/i.test(navigator.userAgent);
|
|
|
|
export interface ActiveCallProps extends Omit<InCallViewProps, "livekitRoom"> {
|
|
e2eeConfig?: E2EEConfig;
|
|
}
|
|
|
|
export function ActiveCall(props: ActiveCallProps) {
|
|
const sfuConfig = useSFUConfig();
|
|
const livekitRoom = useLiveKit(props.muteStates, sfuConfig, props.e2eeConfig);
|
|
|
|
if (!livekitRoom) {
|
|
return null;
|
|
}
|
|
|
|
if (props.e2eeConfig && !livekitRoom.isE2EEEnabled) {
|
|
livekitRoom.setE2EEEnabled(!!props.e2eeConfig);
|
|
}
|
|
|
|
return (
|
|
<RoomContext.Provider value={livekitRoom}>
|
|
<InCallView {...props} livekitRoom={livekitRoom} />
|
|
</RoomContext.Provider>
|
|
);
|
|
}
|
|
|
|
export interface InCallViewProps {
|
|
client: MatrixClient;
|
|
groupCall: GroupCall;
|
|
livekitRoom: Room;
|
|
muteStates: MuteStates;
|
|
participants: Map<RoomMember, Map<string, ParticipantInfo>>;
|
|
onLeave: (error?: Error) => void;
|
|
unencryptedEventsFromUsers: Set<string>;
|
|
hideHeader: boolean;
|
|
otelGroupCallMembership?: OTelGroupCallMembership;
|
|
}
|
|
|
|
export function InCallView({
|
|
client,
|
|
groupCall,
|
|
livekitRoom,
|
|
muteStates,
|
|
participants,
|
|
onLeave,
|
|
unencryptedEventsFromUsers,
|
|
hideHeader,
|
|
otelGroupCallMembership,
|
|
}: InCallViewProps) {
|
|
const { t } = useTranslation();
|
|
usePreventScroll();
|
|
useWakeLock();
|
|
|
|
const containerRef1 = useRef<HTMLDivElement | null>(null);
|
|
const [containerRef2, bounds] = useMeasure({ polyfill: ResizeObserver });
|
|
const boundsValid = bounds.height > 0;
|
|
// Merge the refs so they can attach to the same element
|
|
const containerRef = useMergedRefs(containerRef1, containerRef2);
|
|
|
|
const screenSharingTracks = useTracks(
|
|
[{ source: Track.Source.ScreenShare, withPlaceholder: false }],
|
|
{
|
|
room: livekitRoom,
|
|
}
|
|
);
|
|
const { layout, setLayout } = useVideoGridLayout(
|
|
screenSharingTracks.length > 0
|
|
);
|
|
|
|
const [showInspector] = useShowInspector();
|
|
const [showConnectionStats] = useShowConnectionStats();
|
|
|
|
const { hideScreensharing } = useUrlParams();
|
|
|
|
const { isScreenShareEnabled, localParticipant } = useLocalParticipant({
|
|
room: livekitRoom,
|
|
});
|
|
|
|
const toggleMicrophone = useCallback(
|
|
() => muteStates.audio.setEnabled?.((e) => !e),
|
|
[muteStates]
|
|
);
|
|
const toggleCamera = useCallback(
|
|
() => muteStates.video.setEnabled?.((e) => !e),
|
|
[muteStates]
|
|
);
|
|
|
|
const joinRule = useJoinRule(groupCall.room);
|
|
|
|
// This function incorrectly assumes that there is a camera and microphone, which is not always the case.
|
|
// TODO: Make sure that this module is resilient when it comes to camera/microphone availability!
|
|
useCallViewKeyboardShortcuts(
|
|
containerRef1,
|
|
toggleMicrophone,
|
|
toggleCamera,
|
|
async (muted) => await localParticipant.setMicrophoneEnabled(!muted)
|
|
);
|
|
|
|
const onDisconnected = useCallback(
|
|
(reason?: DisconnectReason) => {
|
|
PosthogAnalytics.instance.eventCallDisconnected.track(reason);
|
|
logger.info("Disconnected from livekit call with reason ", reason);
|
|
onLeave(
|
|
new Error("Disconnected from LiveKit call with reason " + reason)
|
|
);
|
|
},
|
|
[onLeave]
|
|
);
|
|
|
|
const onLeavePress = useCallback(() => {
|
|
onLeave();
|
|
}, [onLeave]);
|
|
|
|
useEventEmitterThree(livekitRoom, RoomEvent.Disconnected, onDisconnected);
|
|
|
|
useEffect(() => {
|
|
widget?.api.transport.send(
|
|
layout === "freedom"
|
|
? ElementWidgetActions.TileLayout
|
|
: ElementWidgetActions.SpotlightLayout,
|
|
{}
|
|
);
|
|
}, [layout]);
|
|
|
|
useEffect(() => {
|
|
if (widget) {
|
|
const onTileLayout = async (ev: CustomEvent<IWidgetApiRequest>) => {
|
|
setLayout("freedom");
|
|
await widget!.api.transport.reply(ev.detail, {});
|
|
};
|
|
const onSpotlightLayout = async (ev: CustomEvent<IWidgetApiRequest>) => {
|
|
setLayout("spotlight");
|
|
await widget!.api.transport.reply(ev.detail, {});
|
|
};
|
|
|
|
widget.lazyActions.on(ElementWidgetActions.TileLayout, onTileLayout);
|
|
widget.lazyActions.on(
|
|
ElementWidgetActions.SpotlightLayout,
|
|
onSpotlightLayout
|
|
);
|
|
|
|
return () => {
|
|
widget!.lazyActions.off(ElementWidgetActions.TileLayout, onTileLayout);
|
|
widget!.lazyActions.off(
|
|
ElementWidgetActions.SpotlightLayout,
|
|
onSpotlightLayout
|
|
);
|
|
};
|
|
}
|
|
}, [setLayout]);
|
|
|
|
const reducedControls = boundsValid && bounds.width <= 400;
|
|
const noControls = reducedControls && bounds.height <= 400;
|
|
|
|
const items = useParticipantTiles(livekitRoom, participants);
|
|
const { fullscreenItem, toggleFullscreen, exitFullscreen } =
|
|
useFullscreen(items);
|
|
|
|
// The maximised participant: either the participant that the user has
|
|
// manually put in fullscreen, or the focused (active) participant if the
|
|
// window is too small to show everyone
|
|
const maximisedParticipant = useMemo(
|
|
() =>
|
|
fullscreenItem ??
|
|
(noControls
|
|
? items.find((item) => item.isSpeaker) ?? items.at(0) ?? null
|
|
: null),
|
|
[fullscreenItem, noControls, items]
|
|
);
|
|
|
|
const Grid =
|
|
items.length > 12 && layout === "freedom" ? NewVideoGrid : VideoGrid;
|
|
|
|
const prefersReducedMotion = usePrefersReducedMotion();
|
|
|
|
// This state is lifted out of NewVideoGrid so that layout states can be
|
|
// restored after a layout switch or upon exiting fullscreen
|
|
const layoutStates = useLayoutStates();
|
|
|
|
const renderContent = (): JSX.Element => {
|
|
if (items.length === 0) {
|
|
return (
|
|
<div className={styles.centerMessage}>
|
|
<p>{t("Waiting for other participants…")}</p>
|
|
</div>
|
|
);
|
|
}
|
|
if (maximisedParticipant) {
|
|
return (
|
|
<VideoTile
|
|
maximised={true}
|
|
fullscreen={maximisedParticipant === fullscreenItem}
|
|
onToggleFullscreen={toggleFullscreen}
|
|
targetHeight={bounds.height}
|
|
targetWidth={bounds.width}
|
|
key={maximisedParticipant.id}
|
|
data={maximisedParticipant.data}
|
|
showSpeakingIndicator={false}
|
|
showConnectionStats={showConnectionStats}
|
|
/>
|
|
);
|
|
}
|
|
|
|
return (
|
|
<Grid
|
|
items={items}
|
|
layout={layout}
|
|
disableAnimations={prefersReducedMotion || isSafari}
|
|
layoutStates={layoutStates}
|
|
>
|
|
{(props) => (
|
|
<VideoTile
|
|
maximised={false}
|
|
fullscreen={false}
|
|
onToggleFullscreen={toggleFullscreen}
|
|
showSpeakingIndicator={items.length > 2}
|
|
showConnectionStats={showConnectionStats}
|
|
{...props}
|
|
ref={props.ref as Ref<HTMLDivElement>}
|
|
/>
|
|
)}
|
|
</Grid>
|
|
);
|
|
};
|
|
|
|
const {
|
|
modalState: rageshakeRequestModalState,
|
|
modalProps: rageshakeRequestModalProps,
|
|
} = useRageshakeRequestModal(groupCall.room.roomId);
|
|
|
|
const {
|
|
modalState: settingsModalState,
|
|
modalProps: settingsModalProps,
|
|
}: {
|
|
modalState: OverlayTriggerState;
|
|
modalProps: {
|
|
isOpen: boolean;
|
|
onClose: () => void;
|
|
};
|
|
} = useModalTriggerState();
|
|
|
|
const openSettings = useCallback(() => {
|
|
settingsModalState.open();
|
|
}, [settingsModalState]);
|
|
|
|
const {
|
|
modalState: inviteModalState,
|
|
modalProps: inviteModalProps,
|
|
}: {
|
|
modalState: OverlayTriggerState;
|
|
modalProps: {
|
|
isOpen: boolean;
|
|
onClose: () => void;
|
|
};
|
|
} = useModalTriggerState();
|
|
|
|
const openInvite = useCallback(() => {
|
|
inviteModalState.open();
|
|
}, [inviteModalState]);
|
|
|
|
const containerClasses = classNames(styles.inRoom, {
|
|
[styles.maximised]: undefined,
|
|
});
|
|
|
|
const toggleScreensharing = useCallback(async () => {
|
|
exitFullscreen();
|
|
await localParticipant.setScreenShareEnabled(!isScreenShareEnabled, {
|
|
audio: true,
|
|
selfBrowserSurface: "include",
|
|
surfaceSwitching: "include",
|
|
systemAudio: "include",
|
|
});
|
|
}, [localParticipant, isScreenShareEnabled, exitFullscreen]);
|
|
|
|
let footer: JSX.Element | null;
|
|
|
|
if (noControls) {
|
|
footer = null;
|
|
} else {
|
|
const buttons: JSX.Element[] = [];
|
|
|
|
buttons.push(
|
|
<MicButton
|
|
key="1"
|
|
muted={!muteStates.audio.enabled}
|
|
onPress={toggleMicrophone}
|
|
disabled={muteStates.audio.setEnabled === null}
|
|
data-testid="incall_mute"
|
|
/>,
|
|
<VideoButton
|
|
key="2"
|
|
muted={!muteStates.video.enabled}
|
|
onPress={toggleCamera}
|
|
disabled={muteStates.video.setEnabled === null}
|
|
data-testid="incall_videomute"
|
|
/>
|
|
);
|
|
|
|
if (!reducedControls) {
|
|
if (canScreenshare && !hideScreensharing && !isSafari) {
|
|
buttons.push(
|
|
<ScreenshareButton
|
|
key="3"
|
|
enabled={isScreenShareEnabled}
|
|
onPress={toggleScreensharing}
|
|
data-testid="incall_screenshare"
|
|
/>
|
|
);
|
|
}
|
|
buttons.push(<SettingsButton key="4" onPress={openSettings} />);
|
|
}
|
|
|
|
buttons.push(
|
|
<HangupButton key="6" onPress={onLeavePress} data-testid="incall_leave" />
|
|
);
|
|
footer = <div className={styles.footer}>{buttons}</div>;
|
|
}
|
|
|
|
return (
|
|
<div className={containerClasses} ref={containerRef}>
|
|
{!hideHeader && maximisedParticipant === null && (
|
|
<Header>
|
|
<LeftNav>
|
|
<RoomHeaderInfo roomName={groupCall.room.name} />
|
|
<VersionMismatchWarning
|
|
users={unencryptedEventsFromUsers}
|
|
room={groupCall.room}
|
|
/>
|
|
<E2EELock />
|
|
</LeftNav>
|
|
<RightNav>
|
|
<GridLayoutMenu layout={layout} setLayout={setLayout} />
|
|
{joinRule === JoinRule.Public && (
|
|
<InviteButton variant="icon" onClick={openInvite} />
|
|
)}
|
|
</RightNav>
|
|
</Header>
|
|
)}
|
|
<div className={styles.controlsOverlay}>
|
|
<RoomAudioRenderer />
|
|
{renderContent()}
|
|
{footer}
|
|
</div>
|
|
{otelGroupCallMembership && (
|
|
<GroupCallInspector
|
|
client={client}
|
|
groupCall={groupCall}
|
|
otelGroupCallMembership={otelGroupCallMembership}
|
|
show={showInspector}
|
|
/>
|
|
)}
|
|
{rageshakeRequestModalState.isOpen && !noControls && (
|
|
<RageshakeRequestModal
|
|
{...rageshakeRequestModalProps}
|
|
roomId={groupCall.room.roomId}
|
|
/>
|
|
)}
|
|
{settingsModalState.isOpen && (
|
|
<SettingsModal
|
|
client={client}
|
|
roomId={groupCall.room.roomId}
|
|
{...settingsModalProps}
|
|
/>
|
|
)}
|
|
{inviteModalState.isOpen && (
|
|
<InviteModal
|
|
roomIdOrAlias={
|
|
groupCall.room.getCanonicalAlias() ?? groupCall.room.roomId
|
|
}
|
|
{...inviteModalProps}
|
|
/>
|
|
)}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
function useParticipantTiles(
|
|
livekitRoom: Room,
|
|
participants: Map<RoomMember, Map<string, ParticipantInfo>>
|
|
): TileDescriptor<ItemData>[] {
|
|
const sfuParticipants = useParticipants({
|
|
room: livekitRoom,
|
|
});
|
|
|
|
const items = useMemo(() => {
|
|
// The IDs of the participants who published membership event to the room (i.e. are present from Matrix perspective).
|
|
const matrixParticipants: Map<string, RoomMember> = new Map(
|
|
[...participants.entries()].flatMap(([user, devicesMap]) => {
|
|
return [...devicesMap.keys()].map((deviceId) => [
|
|
`${user.userId}:${deviceId}`,
|
|
user,
|
|
]);
|
|
})
|
|
);
|
|
|
|
const hasPresenter =
|
|
sfuParticipants.find((p) => p.isScreenShareEnabled) !== undefined;
|
|
let allGhosts = true;
|
|
|
|
const speakActiveTime = new Date();
|
|
speakActiveTime.setSeconds(speakActiveTime.getSeconds() - 10);
|
|
// Iterate over SFU participants (those who actually are present from the SFU perspective) and create tiles for them.
|
|
const tiles: TileDescriptor<ItemData>[] = sfuParticipants.flatMap(
|
|
(sfuParticipant) => {
|
|
const hadSpokedInTime =
|
|
!hasPresenter && sfuParticipant.lastSpokeAt
|
|
? sfuParticipant.lastSpokeAt > speakActiveTime
|
|
: false;
|
|
|
|
const id = sfuParticipant.identity;
|
|
const member = matrixParticipants.get(id);
|
|
allGhosts &&= member === undefined;
|
|
|
|
const userMediaTile = {
|
|
id,
|
|
focused: false,
|
|
isPresenter: sfuParticipant.isScreenShareEnabled,
|
|
isSpeaker:
|
|
(sfuParticipant.isSpeaking || hadSpokedInTime) &&
|
|
!sfuParticipant.isLocal,
|
|
hasVideo: sfuParticipant.isCameraEnabled,
|
|
local: sfuParticipant.isLocal,
|
|
largeBaseSize: false,
|
|
data: {
|
|
id,
|
|
member,
|
|
sfuParticipant,
|
|
content: TileContent.UserMedia,
|
|
},
|
|
};
|
|
|
|
// If there is a screen sharing enabled for this participant, create a tile for it as well.
|
|
let screenShareTile: TileDescriptor<ItemData> | undefined;
|
|
if (sfuParticipant.isScreenShareEnabled) {
|
|
const screenShareId = `${id}:screen-share`;
|
|
screenShareTile = {
|
|
...userMediaTile,
|
|
id: screenShareId,
|
|
focused: true,
|
|
largeBaseSize: true,
|
|
placeNear: id,
|
|
data: {
|
|
...userMediaTile.data,
|
|
id: screenShareId,
|
|
content: TileContent.ScreenShare,
|
|
},
|
|
};
|
|
}
|
|
|
|
return screenShareTile
|
|
? [userMediaTile, screenShareTile]
|
|
: [userMediaTile];
|
|
}
|
|
);
|
|
|
|
PosthogAnalytics.instance.eventCallEnded.cacheParticipantCountChanged(
|
|
tiles.length
|
|
);
|
|
|
|
// If every item is a ghost, that probably means we're still connecting and
|
|
// shouldn't bother showing anything yet
|
|
return allGhosts ? [] : tiles;
|
|
}, [participants, sfuParticipants]);
|
|
|
|
return items;
|
|
}
|