@stream-io/video-react-sdk 1.17.1 → 1.18.0

package/dist/index.es.js

@@ -80,75 +80,189 @@ const defaultDevice = 'default';
  * @param key the key to use for local storage.
  */
 const usePersistedDevicePreferences = (key = '@stream-io/device-preferences') => {
-    const { useCallSettings, useCameraState, useMicrophoneState, useSpeakerState, } = useCallStateHooks();
+    const { useCallSettings, useCallCallingState, useMicrophoneState, useCameraState, useSpeakerState, } = useCallStateHooks();
     const settings = useCallSettings();
-    usePersistedDevicePreference(key, 'camera', useCameraState(), settings ? !settings.video.camera_default_on : undefined);
-    usePersistedDevicePreference(key, 'microphone', useMicrophoneState(), settings ? !settings.audio.mic_default_on : undefined);
-    usePersistedDevicePreference(key, 'speaker', useSpeakerState(), false);
-};
-const usePersistedDevicePreference = (key, deviceKey, state, defaultMuted) => {
-    const { useCallCallingState } = useCallStateHooks();
     const callingState = useCallCallingState();
+    const microphoneState = useMicrophoneState();
+    const cameraState = useCameraState();
+    const speakerState = useSpeakerState();
     const [applyingState, setApplyingState] = useState('idle');
-    const manager = state[deviceKey];
     useEffect(function apply() {
         if (callingState === CallingState.LEFT ||
-            !state.devices?.length ||
-            typeof defaultMuted !== 'boolean' ||
+            !microphoneState.devices.length ||
+            !cameraState.devices.length ||
+            !speakerState.devices ||
+            !settings ||
             applyingState !== 'idle') {
             return;
         }
-        const preferences = parseLocalDevicePreferences(key);
-        const preference = preferences[deviceKey];
         setApplyingState('applying');
-        if (!manager.state.selectedDevice) {
-            const applyPromise = preference
-                ? applyLocalDevicePreference(manager, [preference].flat(), state.devices)
-                : applyMutedState(manager, defaultMuted);
-            applyPromise
-                .catch((err) => {
-                console.warn(`Failed to apply ${deviceKey} device preferences`, err);
-            })
-                .finally(() => setApplyingState('applied'));
-        }
-        else {
-            setApplyingState('applied');
-        }
+        (async () => {
+            for (const [deviceKey, state, defaultMuted] of [
+                ['microphone', microphoneState, !settings.audio.mic_default_on],
+                ['camera', cameraState, !settings.video.camera_default_on],
+                ['speaker', speakerState, false],
+            ]) {
+                const preferences = parseLocalDevicePreferences(key);
+                const preference = preferences[deviceKey];
+                const manager = state[deviceKey];
+                if (!manager.state.selectedDevice) {
+                    const applyPromise = preference
+                        ? applyLocalDevicePreference(manager, [preference].flat(), state.devices)
+                        : applyMutedState(manager, defaultMuted);
+                    await applyPromise.catch((err) => {
+                        console.warn(`Failed to apply ${deviceKey} device preferences`, err);
+                    });
+                }
+            }
+        })().finally(() => setApplyingState((state) => (state === 'applying' ? 'applied' : state)));
     }, [
         applyingState,
         callingState,
-        defaultMuted,
-        deviceKey,
+        cameraState,
+        cameraState.devices,
         key,
-        manager,
-        state.devices,
+        microphoneState,
+        microphoneState.devices,
+        settings,
+        speakerState,
+        speakerState.devices,
     ]);
     useEffect(function persist() {
-        if (callingState === CallingState.LEFT ||
-            !state.devices?.length ||
-            applyingState !== 'applied') {
+        if (callingState === CallingState.LEFT || applyingState !== 'applied') {
             return;
         }
-        try {
-            patchLocalDevicePreference(key, deviceKey, {
-                devices: state.devices,
-                selectedDevice: state.selectedDevice,
-                isMute: state.isMute,
-            });
-        }
-        catch (err) {
-            console.warn(`Failed to save ${deviceKey} device preferences`, err);
+        for (const [deviceKey, devices, selectedDevice, isMute] of [
+            [
+                'camera',
+                cameraState.devices,
+                cameraState.selectedDevice,
+                cameraState.isMute,
+            ],
+            [
+                'microphone',
+                microphoneState.devices,
+                microphoneState.selectedDevice,
+                microphoneState.isMute,
+            ],
+            [
+                'speaker',
+                speakerState.devices,
+                speakerState.selectedDevice,
+                speakerState.isMute,
+            ],
+        ]) {
+            try {
+                patchLocalDevicePreference(key, deviceKey, {
+                    devices,
+                    selectedDevice,
+                    isMute,
+                });
+            }
+            catch (err) {
+                console.warn(`Failed to save ${deviceKey} device preferences`, err);
+            }
         }
     }, [
         applyingState,
         callingState,
-        deviceKey,
+        cameraState.devices,
+        cameraState.isMute,
+        cameraState.selectedDevice,
         key,
-        state.devices,
-        state.isMute,
-        state.selectedDevice,
+        microphoneState.devices,
+        microphoneState.isMute,
+        microphoneState.selectedDevice,
+        speakerState.devices,
+        speakerState.isMute,
+        speakerState.selectedDevice,
     ]);
 };
+// const usePersistedDevicePreference = <K extends DeviceKey>(
+//   key: string,
+//   deviceKey: K,
+//   state: DeviceState<K>,
+//   defaultMuted?: boolean,
+// ): void => {
+//   const { useCallCallingState } = useCallStateHooks();
+//   const callingState = useCallCallingState();
+//   const [applyingState, setApplyingState] = useState<
+//     'idle' | 'applying' | 'applied'
+//   >('idle');
+//   const manager = state[deviceKey];
+//   useEffect(
+//     function apply() {
+//       if (
+//         callingState === CallingState.LEFT ||
+//         !state.devices?.length ||
+//         typeof defaultMuted !== 'boolean' ||
+//         applyingState !== 'idle'
+//       ) {
+//         return;
+//       }
+//       const preferences = parseLocalDevicePreferences(key);
+//       const preference = preferences[deviceKey];
+//       setApplyingState('applying');
+//       if (!manager.state.selectedDevice) {
+//         const applyPromise = preference
+//           ? applyLocalDevicePreference(
+//               manager,
+//               [preference].flat(),
+//               state.devices,
+//             )
+//           : applyMutedState(manager, defaultMuted);
+//         applyPromise
+//           .catch((err) => {
+//             console.warn(
+//               `Failed to apply ${deviceKey} device preferences`,
+//               err,
+//             );
+//           })
+//           .finally(() => setApplyingState('applied'));
+//       } else {
+//         setApplyingState('applied');
+//       }
+//     },
+//     [
+//       applyingState,
+//       callingState,
+//       defaultMuted,
+//       deviceKey,
+//       key,
+//       manager,
+//       state.devices,
+//     ],
+//   );
+//   useEffect(
+//     function persist() {
+//       if (
+//         callingState === CallingState.LEFT ||
+//         !state.devices?.length ||
+//         applyingState !== 'applied'
+//       ) {
+//         return;
+//       }
+//       try {
+//         patchLocalDevicePreference(key, deviceKey, {
+//           devices: state.devices,
+//           selectedDevice: state.selectedDevice,
+//           isMute: state.isMute,
+//         });
+//       } catch (err) {
+//         console.warn(`Failed to save ${deviceKey} device preferences`, err);
+//       }
+//     },
+//     [
+//       applyingState,
+//       callingState,
+//       deviceKey,
+//       key,
+//       state.devices,
+//       state.isMute,
+//       state.selectedDevice,
+//     ],
+//   );
+// };
 const parseLocalDevicePreferences = (key) => {
     const preferencesStr = window.localStorage.getItem(key);
     let preferences = {};
@@ -2228,6 +2342,10 @@ var en = {
 	Video: Video,
 	"You are muted. Unmute to speak.": "You are muted. Unmute to speak.",
 	Live: Live,
+	"Livestream starts soon": "Livestream starts soon",
+	"Livestream starts at {{ startsAt }}": "Livestream starts at {{ startsAt, datetime }}",
+	"{{ count }} participants joined early_one": "{{ count }} participant joined early",
+	"{{ count }} participants joined early_other": "{{ count }} participants joined early",
 	"You can now speak.": "You can now speak.",
 	"Awaiting for an approval to speak.": "Awaiting for an approval to speak.",
 	"You can no longer speak.": "You can no longer speak.",
@@ -2445,18 +2563,32 @@ const LivestreamLayout = (props) => {
         ? participants.find(hasScreenShare)
         : undefined;
     usePaginatedLayoutSortPreset(call);
-    const Overlay = (jsx(ParticipantOverlay, { showParticipantCount: props.showParticipantCount, showDuration: props.showDuration, showLiveBadge: props.showLiveBadge, showSpeakerName: props.showSpeakerName }));
+    const overlay = (jsx(ParticipantOverlay, { showParticipantCount: props.showParticipantCount, showDuration: props.showDuration, showLiveBadge: props.showLiveBadge, showSpeakerName: props.showSpeakerName }));
     const { floatingParticipantProps, muted } = props;
-    const FloatingParticipantOverlay = hasOngoingScreenShare && (jsx(ParticipantOverlay
+    const floatingParticipantOverlay = hasOngoingScreenShare && (jsx(ParticipantOverlay
     // these elements aren't needed for the video feed
     , { 
         // these elements aren't needed for the video feed
         showParticipantCount: floatingParticipantProps?.showParticipantCount ?? false, showDuration: floatingParticipantProps?.showDuration ?? false, showLiveBadge: floatingParticipantProps?.showLiveBadge ?? false, showSpeakerName: floatingParticipantProps?.showSpeakerName ?? true }));
-    return (jsxs("div", { className: "str-video__livestream-layout__wrapper", children: [!muted && jsx(ParticipantsAudio, { participants: remoteParticipants }), hasOngoingScreenShare && presenter && (jsx(ParticipantView, { className: "str-video__livestream-layout__screen-share", participant: presenter, ParticipantViewUI: Overlay, trackType: "screenShareTrack", muteAudio // audio is rendered by ParticipantsAudio
+    return (jsxs("div", { className: "str-video__livestream-layout__wrapper", children: [!muted && jsx(ParticipantsAudio, { participants: remoteParticipants }), hasOngoingScreenShare && presenter && (jsx(ParticipantView, { className: "str-video__livestream-layout__screen-share", participant: presenter, ParticipantViewUI: overlay, trackType: "screenShareTrack", muteAudio // audio is rendered by ParticipantsAudio
                 : true })), currentSpeaker && (jsx(ParticipantView, { className: clsx(hasOngoingScreenShare &&
-                    clsx('str-video__livestream-layout__floating-participant', `str-video__livestream-layout__floating-participant--${floatingParticipantProps?.position ?? 'top-right'}`)), participant: currentSpeaker, ParticipantViewUI: FloatingParticipantOverlay || Overlay, mirror: props.mirrorLocalParticipantVideo !== false ? undefined : false, muteAudio // audio is rendered by ParticipantsAudio
+                    clsx('str-video__livestream-layout__floating-participant', `str-video__livestream-layout__floating-participant--${floatingParticipantProps?.position ?? 'top-right'}`)), participant: currentSpeaker, ParticipantViewUI: floatingParticipantOverlay || overlay, mirror: props.mirrorLocalParticipantVideo !== false ? undefined : false, muteAudio // audio is rendered by ParticipantsAudio
                 : true }))] }));
 };
+LivestreamLayout.displayName = 'LivestreamLayout';
+const BackstageLayout = (props) => {
+    const { showEarlyParticipantCount = true } = props;
+    const { useParticipantCount, useCallStartsAt } = useCallStateHooks();
+    const participantCount = useParticipantCount();
+    const startsAt = useCallStartsAt();
+    const { t } = useI18n();
+    return (jsx("div", { className: "str-video__livestream-layout__wrapper", children: jsxs("div", { className: "str-video__livestream-layout__backstage", children: [startsAt && (jsx("span", { className: "str-video__livestream-layout__starts-at", children: startsAt.getTime() < Date.now()
+                        ? t('Livestream starts soon')
+                        : t('Livestream starts at {{ startsAt }}', { startsAt }) })), showEarlyParticipantCount && (jsx("span", { className: "str-video__livestream-layout__early-viewers-count", children: t('{{ count }} participants joined early', {
+                        count: participantCount,
+                    }) }))] }) }));
+};
+BackstageLayout.displayName = 'BackstageLayout';
 const ParticipantOverlay = (props) => {
     const { enableFullScreen = true, showParticipantCount = true, showDuration = true, showLiveBadge = true, showSpeakerName = false, } = props;
     const { participant } = useParticipantViewContext();
@@ -2467,7 +2599,6 @@ const ParticipantOverlay = (props) => {
     const { t } = useI18n();
     return (jsx("div", { className: "str-video__livestream-layout__overlay", children: jsxs("div", { className: "str-video__livestream-layout__overlay__bar", children: [showLiveBadge && (jsx("span", { className: "str-video__livestream-layout__live-badge", children: t('Live') })), showParticipantCount && (jsx("span", { className: "str-video__livestream-layout__viewers-count", children: participantCount })), showSpeakerName && (jsx("span", { className: "str-video__livestream-layout__speaker-name", title: participant.name || participant.userId || '', children: participant.name || participant.userId || '' })), showDuration && (jsx("span", { className: "str-video__livestream-layout__duration", children: formatDuration(duration) })), enableFullScreen && (jsx("span", { className: "str-video__livestream-layout__go-fullscreen", onClick: toggleFullScreen }))] }) }));
 };
-LivestreamLayout.displayName = 'LivestreamLayout';
 const useUpdateCallDuration = () => {
     const { useIsCallLive, useCallSession } = useCallStateHooks();
     const isCallLive = useIsCallLive();
@@ -2709,17 +2840,30 @@ const Host = () => {
 Host.displayName = 'PipLayout.Host';
 const PipLayout = { Pip, Host };
 
+function useEffectEvent(cb) {
+    const cbRef = useRef(undefined);
+    useLayoutEffect(() => {
+        cbRef.current = cb;
+    }, [cb]);
+    return useCallback((...args) => {
+        const callback = cbRef.current;
+        callback?.(...args);
+    }, []);
+}
+
 const LivestreamPlayer = (props) => {
-    const { callType, callId, layoutProps } = props;
+    const { callType, callId, ...restProps } = props;
     const client = useStreamVideoClient();
     const [call, setCall] = useState();
+    const onError = useEffectEvent(props.onError);
     useEffect(() => {
         if (!client)
             return;
         const myCall = client.call(callType, callId);
         setCall(myCall);
-        myCall.join().catch((e) => {
-            console.error('Failed to join call', e);
+        myCall.get().catch((e) => {
+            console.error('Failed to fetch call', e);
+            onError(e);
         });
         return () => {
             myCall.leave().catch((e) => {
@@ -2727,13 +2871,67 @@ const LivestreamPlayer = (props) => {
             });
             setCall(undefined);
         };
-    }, [callId, callType, client]);
+    }, [callId, callType, client, onError]);
+    if (!call) {
+        return null;
+    }
+    return (jsx(StreamCall, { call: call, children: jsx(LivestreamCall, { ...restProps }) }));
+};
+const LivestreamCall = (props) => {
+    const call = useLivestreamCall(props);
+    const { useIsCallLive } = useCallStateHooks();
+    const isLive = useIsCallLive();
     if (!call)
         return null;
-    return (jsx(StreamCall, { call: call, children: jsx(LivestreamLayout, { ...layoutProps }) }));
+    if (isLive) {
+        return jsx(LivestreamLayout, { ...props.layoutProps });
+    }
+    return jsx(BackstageLayout, { ...props.backstageProps });
+};
+const useLivestreamCall = (props) => {
+    const call = useCall();
+    const { useIsCallLive, useOwnCapabilities } = useCallStateHooks();
+    const canJoinLive = useIsCallLive();
+    const canJoinEarly = useCanJoinEearly();
+    const canJoinBackstage = useOwnCapabilities()?.includes('join-backstage') ?? false;
+    const canJoinAsap = canJoinLive || canJoinEarly || canJoinBackstage;
+    const joinBehavior = props.joinBehavior ?? 'asap';
+    const canJoin = (joinBehavior === 'asap' && canJoinAsap) ||
+        (joinBehavior === 'live' && canJoinLive);
+    const onError = useEffectEvent(props.onError);
+    useEffect(() => {
+        if (call && call.state.callingState === CallingState.IDLE && canJoin) {
+            call.join().catch((e) => {
+                console.error('Failed to join call', e);
+                onError(e);
+            });
+        }
+    }, [call, canJoin, onError]);
+    return call;
+};
+const useCanJoinEearly = () => {
+    const { useCallStartsAt, useCallSettings } = useCallStateHooks();
+    const startsAt = useCallStartsAt();
+    const settings = useCallSettings();
+    const joinAheadTimeSeconds = settings?.backstage.join_ahead_time_seconds;
+    const [canJoinEarly, setCanJoinEearly] = useState(() => checkCanJoinEarly(startsAt, joinAheadTimeSeconds));
+    useEffect(() => {
+        if (!canJoinEarly) {
+            const handle = setInterval(() => {
+                setCanJoinEearly(checkCanJoinEarly(startsAt, joinAheadTimeSeconds));
+            }, 1000);
+            return () => clearInterval(handle);
+        }
+    }, [canJoinEarly, startsAt, joinAheadTimeSeconds]);
+};
+const checkCanJoinEarly = (startsAt, joinAheadTimeSeconds) => {
+    if (!startsAt) {
+        return false;
+    }
+    return Date.now() >= +startsAt - (joinAheadTimeSeconds ?? 0) * 1000;
 };
 
-const [major, minor, patch] = ("1.17.1").split('.');
+const [major, minor, patch] = ("1.18.0").split('.');
 setSdkInfo({
     type: SfuModels.SdkType.REACT,
     major,
@@ -2741,5 +2939,5 @@ setSdkInfo({
     patch,
 });
 
-export { AcceptCallButton, Audio, Avatar, AvatarFallback, BackgroundFiltersProvider, BaseVideo, CallControls, CallParticipantListing, CallParticipantListingItem, CallParticipantsList, CallPreview, CallRecordingList, CallRecordingListHeader, CallRecordingListItem, CallStats, CallStatsButton, CancelCallButton, CancelCallConfirmButton, CompositeButton, DefaultParticipantViewUI, DefaultReactionsMenu, DefaultScreenShareOverlay, DefaultVideoPlaceholder, DeviceSelector, DeviceSelectorAudioInput, DeviceSelectorAudioOutput, DeviceSelectorVideo, DeviceSettings, DropDownSelect, DropDownSelectOption, EmptyCallRecordingListing, GenericMenu, GenericMenuButtonItem, Icon, IconButton, LivestreamLayout, LivestreamPlayer, LoadingCallRecordingListing, LoadingIndicator, MenuToggle, MenuVisualType, NoiseCancellationProvider, Notification, PaginatedGridLayout, ParticipantActionsContextMenu, ParticipantDetails, ParticipantView, ParticipantViewContext, ParticipantsAudio, PermissionNotification, PermissionRequestList, PermissionRequests, PipLayout, ReactionsButton, RecordCallButton, RecordCallConfirmationButton, RecordingInProgressNotification, RingingCall, RingingCallControls, ScreenShareButton, SearchInput, SearchResults, SpeakerLayout, SpeakingWhileMutedNotification, SpeechIndicator, StatCard, StreamCall, StreamTheme, StreamVideo, TextButton, ToggleAudioOutputButton, ToggleAudioPreviewButton, ToggleAudioPublishingButton, ToggleVideoPreviewButton, ToggleVideoPublishingButton, Tooltip, Video$1 as Video, VideoPreview, WithTooltip, defaultReactions, translations, useBackgroundFilters, useDeviceList, useFilteredParticipants, useHorizontalScrollPosition, useMenuContext, useNoiseCancellation, useParticipantViewContext, usePersistedDevicePreferences, useRequestPermission, useTrackElementVisibility, useVerticalScrollPosition };
+export { AcceptCallButton, Audio, Avatar, AvatarFallback, BackgroundFiltersProvider, BackstageLayout, BaseVideo, CallControls, CallParticipantListing, CallParticipantListingItem, CallParticipantsList, CallPreview, CallRecordingList, CallRecordingListHeader, CallRecordingListItem, CallStats, CallStatsButton, CancelCallButton, CancelCallConfirmButton, CompositeButton, DefaultParticipantViewUI, DefaultReactionsMenu, DefaultScreenShareOverlay, DefaultVideoPlaceholder, DeviceSelector, DeviceSelectorAudioInput, DeviceSelectorAudioOutput, DeviceSelectorVideo, DeviceSettings, DropDownSelect, DropDownSelectOption, EmptyCallRecordingListing, GenericMenu, GenericMenuButtonItem, Icon, IconButton, LivestreamLayout, LivestreamPlayer, LoadingCallRecordingListing, LoadingIndicator, MenuToggle, MenuVisualType, NoiseCancellationProvider, Notification, PaginatedGridLayout, ParticipantActionsContextMenu, ParticipantDetails, ParticipantView, ParticipantViewContext, ParticipantsAudio, PermissionNotification, PermissionRequestList, PermissionRequests, PipLayout, ReactionsButton, RecordCallButton, RecordCallConfirmationButton, RecordingInProgressNotification, RingingCall, RingingCallControls, ScreenShareButton, SearchInput, SearchResults, SpeakerLayout, SpeakingWhileMutedNotification, SpeechIndicator, StatCard, StreamCall, StreamTheme, StreamVideo, TextButton, ToggleAudioOutputButton, ToggleAudioPreviewButton, ToggleAudioPublishingButton, ToggleVideoPreviewButton, ToggleVideoPublishingButton, Tooltip, Video$1 as Video, VideoPreview, WithTooltip, defaultReactions, translations, useBackgroundFilters, useDeviceList, useFilteredParticipants, useHorizontalScrollPosition, useMenuContext, useNoiseCancellation, useParticipantViewContext, usePersistedDevicePreferences, useRequestPermission, useTrackElementVisibility, useVerticalScrollPosition };
 //# sourceMappingURL=index.es.js.map