@selfcommunity/react-ui 0.10.2-alpha.8 → 0.10.2-courses.100

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/PreJoin.d.ts

@@ -0,0 +1,58 @@
+import type { CreateLocalTracksOptions, LocalAudioTrack, LocalTrack, LocalVideoTrack } from 'livekit-client';
+import { Track } from 'livekit-client';
+import * as React from 'react';
+import type { LocalUserChoices } from '@livekit/components-core';
+/**
+ * Props for the PreJoin component.
+ * @public
+ */
+export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'onSubmit' | 'onError'> {
+    /** This function is called with the `LocalUserChoices` if validation is passed. */
+    onSubmit?: (values: LocalUserChoices) => void;
+    /**
+     * Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback.
+     */
+    onValidate?: (values: LocalUserChoices) => boolean;
+    onError?: (error: Error) => void;
+    /** Prefill the input form with initial values. */
+    defaults?: Partial<LocalUserChoices>;
+    /** Display a debug window for your convenience. */
+    debug?: boolean;
+    joinLabel?: string;
+    micLabel?: string;
+    camLabel?: string;
+    userLabel?: string;
+    /**
+     * If true, user choices are persisted across sessions.
+     * @defaultValue true
+     * @alpha
+     */
+    persistUserChoices?: boolean;
+}
+/** @alpha */
+export declare function usePreviewTracks(options: CreateLocalTracksOptions, onError?: (err: Error) => void): {
+    tracks: LocalTrack<Track.Kind>[];
+    error: boolean;
+};
+/** @public */
+export declare function usePreviewDevice<T extends LocalVideoTrack | LocalAudioTrack>(enabled: boolean, deviceId: string, kind: 'videoinput' | 'audioinput'): {
+    selectedDevice: MediaDeviceInfo;
+    localTrack: T;
+    deviceError: Error;
+};
+/**
+ * The `PreJoin` prefab component is normally presented to the user before he enters a room.
+ * This component allows the user to check and select the preferred media device (camera und microphone).
+ * On submit the user decisions are returned, which can then be passed on to the `LiveKitRoom` so that the user enters the room with the correct media devices.
+ *
+ * @remarks
+ * This component is independent of the `LiveKitRoom` component and should not be nested within it.
+ * Because it only accesses the local media tracks this component is self-contained and works without connection to the LiveKit server.
+ *
+ * @example
+ * ```tsx
+ * <PreJoin />
+ * ```
+ * @public
+ */
+export declare function PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, persistUserChoices, ...htmlProps }: PreJoinProps): JSX.Element;

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/PreJoin.js

@@ -0,0 +1,251 @@
+import { __awaiter, __rest } from "tslib";
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+import { createLocalAudioTrack, createLocalTracks, createLocalVideoTrack, facingModeFromLocalTrack, Track, VideoPresets, Mutex } from 'livekit-client';
+import * as React from 'react';
+import { log } from '@livekit/components-core';
+import { defaultUserChoices } from '@livekit/components-core';
+import { MediaDeviceMenu, useMediaDevices, usePersistentUserChoices } from '@livekit/components-react';
+import { useSCUser } from '@selfcommunity/react-core';
+import ParticipantTileAvatar from './ParticipantTileAvatar';
+import { useEffect, useMemo } from 'react';
+import { TrackToggle } from './TrackToggle';
+import { useLiveStream } from './LiveStreamProvider';
+/** @alpha */
+export function usePreviewTracks(options, onError) {
+    const [tracks, setTracks] = React.useState();
+    const [error, setError] = React.useState(false);
+    const trackLock = React.useMemo(() => new Mutex(), []);
+    React.useEffect(() => {
+        let needsCleanup = false;
+        let localTracks = [];
+        trackLock.lock().then((unlock) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (options.audio || options.video) {
+                    localTracks = yield createLocalTracks(options);
+                    if (needsCleanup) {
+                        localTracks.forEach((tr) => tr.stop());
+                    }
+                    else {
+                        setTracks(localTracks);
+                    }
+                    setError(false);
+                }
+            }
+            catch (e) {
+                if (onError && e instanceof Error) {
+                    onError(e);
+                }
+                else {
+                    log.error(e);
+                }
+                setError(true);
+            }
+            finally {
+                unlock();
+            }
+        }));
+        return () => {
+            needsCleanup = true;
+            localTracks.forEach((track) => {
+                track.stop();
+            });
+            setError(false);
+        };
+    }, [JSON.stringify(options), onError, trackLock]);
+    return { tracks, error };
+}
+/** @public */
+export function usePreviewDevice(enabled, deviceId, kind) {
+    const [deviceError, setDeviceError] = React.useState(null);
+    const [isCreatingTrack, setIsCreatingTrack] = React.useState(false);
+    const devices = useMediaDevices({ kind });
+    const [selectedDevice, setSelectedDevice] = React.useState(undefined);
+    const [localTrack, setLocalTrack] = React.useState();
+    const [localDeviceId, setLocalDeviceId] = React.useState(deviceId);
+    React.useEffect(() => {
+        setLocalDeviceId(deviceId);
+    }, [deviceId]);
+    const createTrack = (deviceId, kind) => __awaiter(this, void 0, void 0, function* () {
+        try {
+            const track = kind === 'videoinput'
+                ? yield createLocalVideoTrack({
+                    deviceId: deviceId,
+                    resolution: VideoPresets.h720.resolution
+                })
+                : yield createLocalAudioTrack({ deviceId });
+            const newDeviceId = yield track.getDeviceId();
+            if (newDeviceId && deviceId !== newDeviceId) {
+                prevDeviceId.current = newDeviceId;
+                setLocalDeviceId(newDeviceId);
+            }
+            setLocalTrack(track);
+        }
+        catch (e) {
+            if (e instanceof Error) {
+                setDeviceError(e);
+            }
+        }
+    });
+    const switchDevice = (track, id) => __awaiter(this, void 0, void 0, function* () {
+        yield track.setDeviceId(id);
+        prevDeviceId.current = id;
+    });
+    const prevDeviceId = React.useRef(localDeviceId);
+    React.useEffect(() => {
+        if (enabled && !localTrack && !deviceError && !isCreatingTrack) {
+            log.debug('creating track', kind);
+            setIsCreatingTrack(true);
+            createTrack(localDeviceId, kind).finally(() => {
+                setIsCreatingTrack(false);
+            });
+        }
+    }, [enabled, localTrack, deviceError, isCreatingTrack]);
+    // switch camera device
+    React.useEffect(() => {
+        if (!localTrack) {
+            return;
+        }
+        if (!enabled) {
+            log.debug(`muting ${kind} track`);
+            localTrack.mute().then(() => log.debug(localTrack.mediaStreamTrack));
+        }
+        else if ((selectedDevice === null || selectedDevice === void 0 ? void 0 : selectedDevice.deviceId) && prevDeviceId.current !== (selectedDevice === null || selectedDevice === void 0 ? void 0 : selectedDevice.deviceId)) {
+            log.debug(`switching ${kind} device from`, prevDeviceId.current, selectedDevice.deviceId);
+            switchDevice(localTrack, selectedDevice.deviceId);
+        }
+        else {
+            log.debug(`unmuting local ${kind} track`);
+            localTrack.unmute();
+        }
+    }, [localTrack, selectedDevice, enabled, kind]);
+    React.useEffect(() => {
+        return () => {
+            if (localTrack) {
+                log.debug(`stopping local ${kind} track`);
+                localTrack.stop();
+                localTrack.mute();
+            }
+        };
+    }, []);
+    React.useEffect(() => {
+        setSelectedDevice(devices === null || devices === void 0 ? void 0 : devices.find((dev) => dev.deviceId === localDeviceId));
+    }, [localDeviceId, devices]);
+    return {
+        selectedDevice,
+        localTrack,
+        deviceError
+    };
+}
+/**
+ * The `PreJoin` prefab component is normally presented to the user before he enters a room.
+ * This component allows the user to check and select the preferred media device (camera und microphone).
+ * On submit the user decisions are returned, which can then be passed on to the `LiveKitRoom` so that the user enters the room with the correct media devices.
+ *
+ * @remarks
+ * This component is independent of the `LiveKitRoom` component and should not be nested within it.
+ * Because it only accesses the local media tracks this component is self-contained and works without connection to the LiveKit server.
+ *
+ * @example
+ * ```tsx
+ * <PreJoin />
+ * ```
+ * @public
+ */
+export function PreJoin(_a) {
+    var { defaults = {}, onValidate, onSubmit, onError, debug, joinLabel = 'Join Room', micLabel = 'Microphone', camLabel = 'Camera', userLabel = 'Username', persistUserChoices = true } = _a, htmlProps = __rest(_a, ["defaults", "onValidate", "onSubmit", "onError", "debug", "joinLabel", "micLabel", "camLabel", "userLabel", "persistUserChoices"]);
+    const { liveStream } = useLiveStream();
+    const scUserContext = useSCUser();
+    const [userChoices, setUserChoices] = React.useState(defaultUserChoices);
+    const canUseAudio = useMemo(() => { var _a; return scUserContext.user && liveStream && (liveStream.host.id === scUserContext.user.id || (liveStream && !((_a = liveStream === null || liveStream === void 0 ? void 0 : liveStream.settings) === null || _a === void 0 ? void 0 : _a.muteParticipants))); }, [scUserContext, liveStream]);
+    const canUseVideo = useMemo(() => { var _a; return scUserContext.user && liveStream && (liveStream.host.id === scUserContext.user.id || (liveStream && !((_a = liveStream === null || liveStream === void 0 ? void 0 : liveStream.settings) === null || _a === void 0 ? void 0 : _a.disableVideo))); }, [scUserContext, liveStream]);
+    // TODO: Remove and pipe `defaults` object directly into `usePersistentUserChoices` once we fully switch from type `LocalUserChoices` to `UserChoices`.
+    const partialDefaults = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, (defaults.audioDeviceId !== undefined && { audioDeviceId: defaults.audioDeviceId })), (defaults.videoDeviceId !== undefined && { videoDeviceId: defaults.videoDeviceId })), (defaults.audioEnabled !== undefined && { audioEnabled: defaults.audioEnabled })), (defaults.videoEnabled !== undefined && { videoEnabled: defaults.videoEnabled })), (defaults.username !== undefined && { username: defaults.username }));
+    const { userChoices: initialUserChoices, saveAudioInputDeviceId, saveAudioInputEnabled, saveVideoInputDeviceId, saveVideoInputEnabled, saveUsername } = usePersistentUserChoices({
+        defaults: partialDefaults,
+        preventSave: !persistUserChoices,
+        preventLoad: !persistUserChoices
+    });
+    // Initialize device settings
+    const [audioEnabled, setAudioEnabled] = React.useState(initialUserChoices.audioEnabled && canUseAudio);
+    const [videoEnabled, setVideoEnabled] = React.useState(initialUserChoices.videoEnabled && canUseVideo);
+    const [audioDeviceId, setAudioDeviceId] = React.useState(initialUserChoices.audioDeviceId);
+    const [videoDeviceId, setVideoDeviceId] = React.useState(initialUserChoices.videoDeviceId);
+    const [username, setUsername] = React.useState(initialUserChoices.username);
+    // Save user choices to persistent storage.
+    React.useEffect(() => {
+        saveAudioInputEnabled(audioEnabled && canUseAudio);
+    }, [audioEnabled, saveAudioInputEnabled, canUseAudio]);
+    React.useEffect(() => {
+        saveVideoInputEnabled(videoEnabled && canUseVideo);
+    }, [videoEnabled, saveVideoInputEnabled, canUseVideo]);
+    React.useEffect(() => {
+        saveAudioInputDeviceId(audioDeviceId);
+    }, [audioDeviceId, saveAudioInputDeviceId]);
+    React.useEffect(() => {
+        saveVideoInputDeviceId(videoDeviceId);
+    }, [videoDeviceId, saveVideoInputDeviceId]);
+    React.useEffect(() => {
+        if (scUserContext.user) {
+            saveUsername(scUserContext.user.username);
+        }
+    }, [username, saveUsername, scUserContext.user]);
+    const { tracks, error } = usePreviewTracks({
+        audio: audioEnabled ? { deviceId: initialUserChoices.audioDeviceId } : false,
+        video: videoEnabled ? { deviceId: initialUserChoices.videoDeviceId } : false
+    }, onError);
+    const videoEl = React.useRef(null);
+    const videoTrack = React.useMemo(() => tracks === null || tracks === void 0 ? void 0 : tracks.filter((track) => track.kind === Track.Kind.Video)[0], [tracks]);
+    const facingMode = React.useMemo(() => {
+        if (videoTrack) {
+            const { facingMode } = facingModeFromLocalTrack(videoTrack);
+            return facingMode;
+        }
+        else {
+            return 'undefined';
+        }
+    }, [videoTrack]);
+    const audioTrack = React.useMemo(() => tracks === null || tracks === void 0 ? void 0 : tracks.filter((track) => track.kind === Track.Kind.Audio)[0], [tracks]);
+    React.useEffect(() => {
+        if (videoEl.current && videoTrack) {
+            videoTrack.unmute();
+            videoTrack.attach(videoEl.current);
+        }
+        return () => {
+            videoTrack === null || videoTrack === void 0 ? void 0 : videoTrack.detach();
+        };
+    }, [videoTrack]);
+    const [isValid, setIsValid] = React.useState();
+    const handleValidation = React.useCallback((values) => {
+        if (typeof onValidate === 'function') {
+            return onValidate(values);
+        }
+        else {
+            return Boolean(values.username !== '' &&
+                ((values.audioEnabled && values.audioDeviceId) || !values.audioEnabled) &&
+                ((values.videoEnabled && values.videoDeviceId) || !values.videoEnabled));
+        }
+    }, [onValidate]);
+    useEffect(() => {
+        const newUserChoices = {
+            username,
+            videoEnabled,
+            videoDeviceId,
+            audioEnabled,
+            audioDeviceId
+        };
+        setUserChoices(newUserChoices);
+        setIsValid(handleValidation(newUserChoices));
+    }, [username, scUserContext.user, videoEnabled, handleValidation, audioEnabled, audioDeviceId, videoDeviceId]);
+    function handleSubmit(event) {
+        event.preventDefault();
+        if (handleValidation(userChoices)) {
+            if (typeof onSubmit === 'function') {
+                onSubmit(userChoices);
+            }
+        }
+        else {
+            log.warn('Validation failed with: ', userChoices);
+        }
+    }
+    return (_jsxs("div", Object.assign({ className: "lk-prejoin" }, htmlProps, { children: [_jsxs("div", Object.assign({ className: "lk-video-container" }, { children: [videoTrack && _jsx("video", { ref: videoEl, width: "1280", height: "720", "data-lk-facing-mode": facingMode }), (!videoTrack || !videoEnabled) && (_jsx("div", Object.assign({ className: "lk-camera-off-note" }, { children: _jsx(ParticipantTileAvatar, { user: scUserContext.user }) })))] })), _jsxs("div", Object.assign({ className: "lk-button-group-container" }, { children: [_jsxs("div", Object.assign({ className: "lk-button-group audio" }, { children: [_jsx(TrackToggle, Object.assign({ disabled: !canUseAudio, initialState: audioEnabled, source: Track.Source.Microphone, onChange: (enabled) => setAudioEnabled(enabled) }, { children: micLabel })), _jsx("div", Object.assign({ className: "lk-button-group-menu" }, { children: _jsx(MediaDeviceMenu, { initialSelection: audioDeviceId, kind: "audioinput", disabled: !audioTrack || !canUseAudio || !audioEnabled, tracks: { audioinput: audioTrack }, onActiveDeviceChange: (_, id) => setAudioDeviceId(id) }) }))] })), _jsxs("div", Object.assign({ className: "lk-button-group video" }, { children: [_jsx(TrackToggle, Object.assign({ disabled: !canUseVideo, initialState: videoEnabled, source: Track.Source.Camera, onChange: (enabled) => setVideoEnabled(enabled) }, { children: camLabel })), _jsx("div", Object.assign({ className: "lk-button-group-menu" }, { children: _jsx(MediaDeviceMenu, { initialSelection: videoDeviceId, kind: "videoinput", disabled: !videoTrack || !canUseVideo || !videoEnabled, tracks: { videoinput: videoTrack }, onActiveDeviceChange: (_, id) => setVideoDeviceId(id) }) }))] }))] })), _jsx("form", Object.assign({ className: "lk-username-container" }, { children: _jsx("button", Object.assign({ className: "lk-button lk-join-button", type: "submit", onClick: handleSubmit, disabled: !isValid || error }, { children: joinLabel })) })), debug && (_jsxs(_Fragment, { children: [_jsx("strong", { children: "User Choices:" }), _jsxs("ul", Object.assign({ className: "lk-list", style: { overflow: 'hidden', maxWidth: '15rem' } }, { children: [_jsxs("li", { children: ["Username: ", `${userChoices.username}`] }), _jsxs("li", { children: ["Video Enabled: ", `${userChoices.videoEnabled}`] }), _jsxs("li", { children: ["Audio Enabled: ", `${userChoices.audioEnabled}`] }), _jsxs("li", { children: ["Video Device: ", `${userChoices.videoDeviceId}`] }), _jsxs("li", { children: ["Audio Device: ", `${userChoices.audioDeviceId}`] })] }))] }))] })));
+}

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/RecordingIndicator.d.ts

@@ -0,0 +1,5 @@
+/**
+ * RecordingIndicator
+ * @alpha
+ */
+export default function RecordingIndicator(): JSX.Element;

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/RecordingIndicator.js

@@ -0,0 +1,29 @@
+'use client';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useIsRecording } from '@livekit/components-react';
+import { useEffect, useState } from 'react';
+/**
+ * RecordingIndicator
+ * @alpha
+ */
+export default function RecordingIndicator() {
+    const isRecording = useIsRecording();
+    const [wasRecording, setWasRecording] = useState(false);
+    useEffect(() => {
+        if (isRecording !== wasRecording) {
+            setWasRecording(isRecording);
+            if (isRecording) {
+                window.alert('This meeting is being recorded');
+            }
+        }
+    }, [isRecording]);
+    return (_jsx("div", { style: {
+            position: 'absolute',
+            top: '0',
+            left: '0',
+            width: '100%',
+            height: '100%',
+            boxShadow: isRecording ? 'red 0px 0px 0px 3px inset' : 'none',
+            pointerEvents: 'none'
+        } }));
+}

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/SettingsMenuToggle.d.ts

@@ -0,0 +1,19 @@
+import * as React from 'react';
+export interface UseSettingsToggleProps {
+    props: React.ButtonHTMLAttributes<HTMLButtonElement>;
+}
+/**
+ * The `useSettingsToggle` hook provides state and functions for toggling the settings menu.
+ */
+export declare function useSettingsToggle({ props }: UseSettingsToggleProps): {
+    mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {
+        className: string;
+        onClick: () => void;
+        'aria-pressed': string;
+    };
+};
+export declare type SettingsMenuToggleProps = React.ButtonHTMLAttributes<HTMLButtonElement>;
+/**
+ * The `SettingsMenuToggle` component is a button that toggles the visibility of the `SettingsMenu` component.
+ */
+export declare const SettingsMenuToggle: (props: SettingsMenuToggleProps & React.RefAttributes<HTMLButtonElement>) => React.ReactNode;

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/SettingsMenuToggle.js

@@ -0,0 +1,30 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import * as React from 'react';
+import { mergePropsReactAria } from './utils';
+import { useLayoutContext } from '@livekit/components-react';
+/**
+ * The `useSettingsToggle` hook provides state and functions for toggling the settings menu.
+ */
+export function useSettingsToggle({ props }) {
+    const { dispatch, state } = useLayoutContext().widget;
+    const className = 'lk-button lk-settings-toggle';
+    const mergedProps = React.useMemo(() => {
+        return mergePropsReactAria(props, {
+            className,
+            onClick: () => {
+                if (dispatch)
+                    dispatch({ msg: 'toggle_settings' });
+            },
+            'aria-pressed': (state === null || state === void 0 ? void 0 : state.showSettings) ? 'true' : 'false'
+        });
+    }, [props, className, dispatch, state]);
+    return { mergedProps };
+}
+/**
+ * The `SettingsMenuToggle` component is a button that toggles the visibility of the `SettingsMenu` component.
+ */
+export const SettingsMenuToggle = 
+/* @__PURE__ */ React.forwardRef(function SettingsMenuToggle(props, ref) {
+    const { mergedProps } = useSettingsToggle({ props });
+    return (_jsx("button", Object.assign({ ref: ref }, mergedProps, { children: props.children })));
+});

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/TrackToggle.d.ts

@@ -0,0 +1,23 @@
+import type { CaptureOptionsBySource, ToggleSource } from '@livekit/components-core';
+import * as React from 'react';
+import { Track, TrackPublishOptions } from 'livekit-client';
+export declare function getSourceIcon(source: Track.Source, enabled: boolean): JSX.Element;
+export interface TrackToggleProps<T extends ToggleSource> extends Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, 'onChange'> {
+    source: T;
+    showIcon?: boolean;
+    initialState?: boolean;
+    disabled?: boolean;
+    /**
+     * Function that is called when the enabled state of the toggle changes.
+     * The second function argument `isUserInitiated` is `true` if the change was initiated by a user interaction, such as a click.
+     */
+    onChange?: (enabled: boolean, isUserInitiated: boolean) => void;
+    captureOptions?: CaptureOptionsBySource<T>;
+    publishOptions?: TrackPublishOptions;
+    onDeviceError?: (error: Error) => void;
+}
+/**
+ * With the `TrackToggle` component it is possible to mute and unmute your camera and microphone.
+ * The component uses an html button element under the hood so you can treat it like a button.
+ */
+export declare const TrackToggle: <T extends ToggleSource>(props: TrackToggleProps<T> & React.RefAttributes<HTMLButtonElement>) => React.ReactNode;

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/TrackToggle.js

@@ -0,0 +1,27 @@
+import { __rest } from "tslib";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import * as React from 'react';
+import { Track } from 'livekit-client';
+import { useTrackToggle, CameraIcon, CameraDisabledIcon, MicDisabledIcon, MicIcon, ScreenShareIcon, ScreenShareStopIcon } from '@livekit/components-react';
+export function getSourceIcon(source, enabled) {
+    switch (source) {
+        case Track.Source.Microphone:
+            return enabled ? _jsx(MicIcon, {}) : _jsx(MicDisabledIcon, {});
+        case Track.Source.Camera:
+            return enabled ? _jsx(CameraIcon, {}) : _jsx(CameraDisabledIcon, {});
+        case Track.Source.ScreenShare:
+            return enabled ? _jsx(ScreenShareStopIcon, {}) : _jsx(ScreenShareIcon, {});
+        default:
+            return undefined;
+    }
+}
+/**
+ * With the `TrackToggle` component it is possible to mute and unmute your camera and microphone.
+ * The component uses an html button element under the hood so you can treat it like a button.
+ */
+export const TrackToggle = 
+/* @__PURE__ */ React.forwardRef(function TrackToggle(_a, ref) {
+    var { showIcon, disabled } = _a, props = __rest(_a, ["showIcon", "disabled"]);
+    const { buttonProps, enabled } = useTrackToggle(props);
+    return (_jsxs("button", Object.assign({ ref: ref }, buttonProps, { disabled: disabled }, { children: [(showIcon !== null && showIcon !== void 0 ? showIcon : true) && getSourceIcon(props.source, enabled && !disabled), props.children] })));
+});

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/VideoConference.d.ts

@@ -0,0 +1,26 @@
+import * as React from 'react';
+import type { MessageDecoder, MessageEncoder } from '@livekit/components-core';
+import { MessageFormatter } from '@livekit/components-react';
+import { SCUserType } from '@selfcommunity/types';
+export interface VideoConferenceProps {
+    className?: string;
+    chatMessageFormatter?: MessageFormatter;
+    chatMessageEncoder?: MessageEncoder;
+    chatMessageDecoder?: MessageDecoder;
+    /** @alpha */
+    SettingsComponent?: React.ComponentType;
+    speakerFocused?: SCUserType;
+    disableChat?: boolean;
+    disableMicrophone?: boolean;
+    disableCamera?: boolean;
+    disableShareScreen?: boolean;
+    hideParticipantsList?: boolean;
+    showSettings?: boolean;
+}
+/**
+ * The `VideoConference` ready-made component is your drop-in solution for a classic video conferencing application.
+ * It provides functionality such as focusing on one participant, grid view with pagination to handle large numbers
+ * of participants, basic non-persistent chat, screen sharing, and more.
+ *
+ */
+export declare function VideoConference(inProps: VideoConferenceProps): JSX.Element;

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/VideoConference.js

@@ -0,0 +1,149 @@
+import { __rest } from "tslib";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import * as React from 'react';
+import { isEqualTrackRef, isTrackReference, isWeb, log } from '@livekit/components-core';
+import { RoomEvent, Track } from 'livekit-client';
+import { CarouselLayout, Chat, ConnectionStateToast, GridLayout, LayoutContextProvider, RoomAudioRenderer, useCreateLayoutContext, useParticipants, usePinnedTracks, useTracks } from '@livekit/components-react';
+import { ParticipantTile } from './ParticipantTile';
+import { ControlBar } from './ControlBar';
+import { useEffect, useMemo } from 'react';
+import { useLivestreamCheck } from './useLiveStreamCheck';
+import { FocusLayout, FocusLayoutContainer, FocusLayoutContainerNoParticipants } from './FocusLayout';
+import { useSCUser } from '@selfcommunity/react-core';
+import classNames from 'classnames';
+import { styled } from '@mui/material/styles';
+import { Box } from '@mui/material';
+import { useThemeProps } from '@mui/system';
+import NoParticipants from './NoParticipants';
+const PREFIX = 'SCVideoConference';
+const classes = {
+    root: `${PREFIX}-root`
+};
+const Root = styled(Box, {
+    name: PREFIX,
+    slot: 'Root',
+    overridesResolver: (props, styles) => styles.root
+})(({ theme }) => ({
+    '& .lk-chat': {
+        height: '100%'
+    }
+}));
+/**
+ * The `VideoConference` ready-made component is your drop-in solution for a classic video conferencing application.
+ * It provides functionality such as focusing on one participant, grid view with pagination to handle large numbers
+ * of participants, basic non-persistent chat, screen sharing, and more.
+ *
+ */
+export function VideoConference(inProps) {
+    var _a, _b;
+    // PROPS
+    const props = useThemeProps({
+        props: inProps,
+        name: PREFIX
+    });
+    const { className, chatMessageFormatter, chatMessageDecoder, chatMessageEncoder, SettingsComponent, speakerFocused, disableChat = false, disableMicrophone = false, disableCamera = false, disableShareScreen = false, hideParticipantsList = false, showSettings } = props, rest = __rest(props, ["className", "chatMessageFormatter", "chatMessageDecoder", "chatMessageEncoder", "SettingsComponent", "speakerFocused", "disableChat", "disableMicrophone", "disableCamera", "disableShareScreen", "hideParticipantsList", "showSettings"]);
+    // STATE
+    const [widgetState, setWidgetState] = React.useState({
+        showChat: false,
+        unreadMessages: 0,
+        showSettings: showSettings || false
+    });
+    const [focusInitialized, setFocusInitialized] = React.useState(false);
+    const lastAutoFocusedScreenShareTrack = React.useRef(null);
+    // HOOKS
+    const scUserContext = useSCUser();
+    const tracks = useTracks([
+        { source: Track.Source.Camera, withPlaceholder: true },
+        { source: Track.Source.ScreenShare, withPlaceholder: false }
+    ], { updateOnlyOn: [RoomEvent.ActiveSpeakersChanged], onlySubscribed: false });
+    const tracksNoParticipants = useMemo(() => tracks.filter((t) => t.participant.name === scUserContext.user.username || t.source === 'screen_share'), [tracks, scUserContext.user]);
+    const participants = useParticipants();
+    const layoutContext = useCreateLayoutContext();
+    const screenShareTracks = tracks.filter(isTrackReference).filter((track) => track.publication.source === Track.Source.ScreenShare);
+    const focusTrack = (_a = usePinnedTracks(layoutContext)) === null || _a === void 0 ? void 0 : _a[0];
+    const carouselTracks = tracks.filter((track) => !isEqualTrackRef(track, focusTrack));
+    useLivestreamCheck();
+    /**
+     * widgetUpdate
+     * @param state
+     */
+    const widgetUpdate = (state) => {
+        log.debug('updating widget state', state);
+        setWidgetState(state);
+    };
+    /**
+     * handleFocusStateChange
+     * @param state
+     */
+    const handleFocusStateChange = (state) => {
+        var _a, _b;
+        log.debug('updating widget state', state);
+        if (state && state.participant) {
+            const updatedFocusTrack = tracks.find((tr) => tr.participant.identity === state.participant.identity);
+            if (updatedFocusTrack) {
+                (_b = (_a = layoutContext.pin).dispatch) === null || _b === void 0 ? void 0 : _b.call(_a, { msg: 'set_pin', trackReference: updatedFocusTrack });
+            }
+        }
+    };
+    useEffect(() => {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        // If screen share tracks are published, and no pin is set explicitly, auto set the screen share.
+        if (screenShareTracks.some((track) => track.publication.isSubscribed) && lastAutoFocusedScreenShareTrack.current === null) {
+            log.debug('Auto set screen share focus:', { newScreenShareTrack: screenShareTracks[0] });
+            (_b = (_a = layoutContext.pin).dispatch) === null || _b === void 0 ? void 0 : _b.call(_a, { msg: 'set_pin', trackReference: screenShareTracks[0] });
+            lastAutoFocusedScreenShareTrack.current = screenShareTracks[0];
+        }
+        else if (lastAutoFocusedScreenShareTrack.current &&
+            !screenShareTracks.some((track) => { var _a, _b; return track.publication.trackSid === ((_b = (_a = lastAutoFocusedScreenShareTrack.current) === null || _a === void 0 ? void 0 : _a.publication) === null || _b === void 0 ? void 0 : _b.trackSid); })) {
+            log.debug('Auto clearing screen share focus.');
+            (_d = (_c = layoutContext.pin).dispatch) === null || _d === void 0 ? void 0 : _d.call(_c, { msg: 'clear_pin' });
+            lastAutoFocusedScreenShareTrack.current = null;
+        }
+        if (focusTrack) {
+            let updatedFocusTrack;
+            const isFocusTrackParticipantExist = participants.find((pt) => pt.identity === focusTrack.participant.identity);
+            if (!isFocusTrackParticipantExist) {
+                // Focus track is relative to a participant that has left the room
+                updatedFocusTrack = tracks.find((tr) => tr.participant.identity === scUserContext.user.id.toString());
+                (_f = (_e = layoutContext.pin).dispatch) === null || _f === void 0 ? void 0 : _f.call(_e, { msg: 'set_pin', trackReference: updatedFocusTrack });
+            }
+            else if (!isTrackReference(focusTrack)) {
+                // You are not subscribet to the track
+                updatedFocusTrack = tracks.find((tr) => tr.participant.identity === focusTrack.participant.identity && tr.source === focusTrack.source);
+                if (updatedFocusTrack !== focusTrack && isTrackReference(updatedFocusTrack)) {
+                    (_h = (_g = layoutContext.pin).dispatch) === null || _h === void 0 ? void 0 : _h.call(_g, { msg: 'set_pin', trackReference: updatedFocusTrack });
+                }
+            }
+        }
+    }, [
+        screenShareTracks.map((ref) => `${ref.publication.trackSid}_${ref.publication.isSubscribed}`).join(),
+        (_b = focusTrack === null || focusTrack === void 0 ? void 0 : focusTrack.publication) === null || _b === void 0 ? void 0 : _b.trackSid,
+        tracks,
+        participants,
+        speakerFocused
+    ]);
+    useEffect(() => {
+        var _a, _b;
+        if (speakerFocused && !focusInitialized) {
+            const speaker = participants.find((pt) => {
+                return pt.name === speakerFocused.username;
+            });
+            if (speaker) {
+                const updatedFocusTrack = tracks.find((tr) => {
+                    if (tr) {
+                        return tr.participant.identity === speaker.identity;
+                    }
+                    return false;
+                });
+                (_b = (_a = layoutContext.pin).dispatch) === null || _b === void 0 ? void 0 : _b.call(_a, { msg: 'set_pin', trackReference: updatedFocusTrack });
+                setFocusInitialized(true);
+            }
+        }
+    }, [tracks, participants, speakerFocused]);
+    return (_jsxs(Root, Object.assign({ className: classNames(className, classes.root, 'lk-video-conference') }, rest, { children: [isWeb() && (_jsxs(LayoutContextProvider, Object.assign({ value: layoutContext, onPinChange: handleFocusStateChange, onWidgetChange: widgetUpdate }, { children: [_jsxs("div", Object.assign({ className: "lk-video-conference-inner" }, { children: [!focusTrack ? (_jsx("div", Object.assign({ className: "lk-grid-layout-wrapper" }, { children: _jsx(GridLayout, Object.assign({ tracks: hideParticipantsList ? tracksNoParticipants : tracks }, { children: _jsx(ParticipantTile, {}) })) }))) : (_jsx("div", Object.assign({ className: "lk-focus-layout-wrapper" }, { children: hideParticipantsList ? (_jsx(FocusLayoutContainerNoParticipants, { children: focusTrack && _jsx(FocusLayout, { trackRef: focusTrack, disableTileFocusToggle: Boolean(tracksNoParticipants.length <= 1) }) })) : (_jsxs(FocusLayoutContainer, { children: [carouselTracks.length > 1 ? (_jsx(CarouselLayout, Object.assign({ tracks: carouselTracks }, { children: _jsx(ParticipantTile, {}) }))) : (_jsx(NoParticipants, {})), focusTrack && _jsx(FocusLayout, { trackRef: focusTrack })] })) }))), _jsx(ControlBar, { controls: Object.assign({
+                                    chat: !disableChat,
+                                    microphone: !disableMicrophone,
+                                    camera: !disableCamera,
+                                    screenShare: !disableShareScreen
+                                }, { settings: !!SettingsComponent }) })] })), !disableChat && (_jsx(Chat, { style: { display: widgetState.showChat ? 'grid' : 'none' }, messageFormatter: chatMessageFormatter, messageEncoder: chatMessageEncoder, messageDecoder: chatMessageDecoder })), SettingsComponent && (_jsx("div", Object.assign({ className: "lk-settings-menu-modal", style: { display: widgetState.showSettings ? 'block' : 'none' } }, { children: _jsx(SettingsComponent, {}) })))] }))), _jsx(RoomAudioRenderer, {}), _jsx(ConnectionStateToast, {})] })));
+}

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const PREFIX = "SCLiveStreamVideoConference";
+export declare const REMOVE_ROOM_USER = "_remove_room_user";
+export declare const BAN_ROOM_USER = "_ban_room_user";

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/constants.js

@@ -0,0 +1,3 @@
+export const PREFIX = 'SCLiveStreamVideoConference';
+export const REMOVE_ROOM_USER = '_remove_room_user';
+export const BAN_ROOM_USER = '_ban_room_user';

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/index.d.ts

@@ -0,0 +1,3 @@
+import LiveStreamVideoConference, { LiveStreamVideoConferenceProps } from './LiveStreamVideoConference';
+export default LiveStreamVideoConference;
+export { LiveStreamVideoConferenceProps };

package/lib/esm/components/LiveStreamRoom/LiveStreamVideoConference/index.js

@@ -0,0 +1,2 @@
+import LiveStreamVideoConference from './LiveStreamVideoConference';
+export default LiveStreamVideoConference;