@100mslive/roomkit-react 0.3.8-alpha.2 → 0.3.8-alpha.4

package/package.json

@@ -10,7 +10,7 @@
     "prebuilt",
     "roomkit"
   ],
-  "version": "0.3.8-alpha.2",
+  "version": "0.3.8-alpha.4",
   "author": "100ms",
   "license": "MIT",
   "repository": {
@@ -82,11 +82,11 @@
     "react": ">=17.0.2 <19.0.0"
   },
   "dependencies": {
-    "@100mslive/hls-player": "0.3.8-alpha.2",
+    "@100mslive/hls-player": "0.3.8-alpha.4",
     "@100mslive/hms-noise-cancellation": "0.0.1",
-    "@100mslive/hms-virtual-background": "1.13.8-alpha.2",
-    "@100mslive/react-icons": "0.10.8-alpha.2",
-    "@100mslive/react-sdk": "0.10.8-alpha.2",
+    "@100mslive/hms-virtual-background": "1.13.8-alpha.4",
+    "@100mslive/react-icons": "0.10.8-alpha.4",
+    "@100mslive/react-sdk": "0.10.8-alpha.4",
     "@100mslive/types-prebuilt": "0.12.8",
     "@emoji-mart/data": "^1.0.6",
     "@emoji-mart/react": "^1.0.1",
@@ -122,5 +122,5 @@
     "uuid": "^8.3.2",
     "worker-timers": "^7.0.40"
   },
-  "gitHead": "43ee35cc85faabb5a827f7f41a5affebffcfca18"
+  "gitHead": "1ac0f11a034d8e0aed06479e20671c86bffd77f8"
 }

package/src/Prebuilt/components/AppData/AppData.tsx

@@ -68,7 +68,8 @@ const initialAppData = {
     [POLL_STATE.pollInView]: '',
     [POLL_STATE.view]: '',
   },
-  [APP_DATA.caption]: true,
+  // by default off, so it will not appear in beam bots
+  [APP_DATA.caption]: false,
 };
 
 export const AppData = React.memo(() => {

package/src/Prebuilt/components/ConferenceScreen.tsx

@@ -1,5 +1,4 @@
 import React, { useEffect, useRef, useState } from 'react';
-import { useMedia } from 'react-use';
 import { DefaultConferencingScreen_Elements } from '@100mslive/types-prebuilt';
 import { v4 as uuid } from 'uuid';
 import {
@@ -19,7 +18,6 @@ import { ActivatedPIP } from './PIP/PIPComponent';
 import { PictureInPicture } from './PIP/PIPManager';
 import { RoleChangeRequestModal } from './RoleChangeRequest/RoleChangeRequestModal';
 import { Box, Flex } from '../../Layout';
-import { config } from '../../Theme';
 import { useHMSPrebuiltContext } from '../AppContext';
 import { VideoStreamingSection } from '../layouts/VideoStreamingSection';
 // @ts-ignore: No implicit Any
@@ -28,21 +26,17 @@ import FullPageProgress from './FullPageProgress';
 import { Header } from './Header';
 import { PreviousRoleInMetadata } from './PreviousRoleInMetadata';
 import { RaiseHand } from './RaiseHand';
-import { CaptionsViewer } from '../plugins/CaptionsViewer';
 import {
   useRoomLayoutConferencingScreen,
   useRoomLayoutPreviewScreen,
 } from '../provider/roomLayoutProvider/hooks/useRoomLayoutScreen';
 // @ts-ignore: No implicit Any
-import { useIsSidepaneTypeOpen } from './AppData/useSidepane';
-// @ts-ignore: No implicit Any
-import { useAuthToken, useIsCaptionEnabled, useSetAppDataByKey } from './AppData/useUISettings';
+import { useAuthToken, useSetAppDataByKey } from './AppData/useUISettings';
 import { useLandscapeHLSStream, useMobileHLSStream } from '../common/hooks';
-import { APP_DATA, isAndroid, isIOS, isIPadOS, SIDE_PANE_OPTIONS } from '../common/constants';
+import { APP_DATA, isAndroid, isIOS, isIPadOS } from '../common/constants';
 
 export const ConferenceScreen = () => {
   const { userName, endpoints, onJoin: onJoinFunc } = useHMSPrebuiltContext();
-  const isMobile = useMedia(config.media.md);
   const screenProps = useRoomLayoutConferencingScreen();
   const { isPreviewScreenEnabled } = useRoomLayoutPreviewScreen();
   const roomState = useHMSStore(selectRoomState);
@@ -63,10 +57,6 @@ export const ConferenceScreen = () => {
   const isMobileHLSStream = useMobileHLSStream();
   const isLandscapeHLSStream = useLandscapeHLSStream();
   const isMwebHLSStream = isMobileHLSStream || isLandscapeHLSStream;
-  const isCaptionEnabled = useIsCaptionEnabled();
-  const isChatOpen = useIsSidepaneTypeOpen(SIDE_PANE_OPTIONS.CHAT);
-
-  const showCaptionAtTop = screenProps.elements?.chat?.is_overlay && isChatOpen;
 
   const toggleControls = () => {
     if (dropdownListRef.current?.length === 0 && isMobileDevice && !isMwebHLSStream) {
@@ -134,28 +124,6 @@ export const ConferenceScreen = () => {
           <FullPageProgress text="Starting live stream..." css={{ opacity: 0.8, bg: '$background_dim' }} />
         </Box>
       ) : null}
-      {isCaptionEnabled && screenProps.screenType !== 'hls_live_streaming' && (
-        <Box
-          css={{
-            position: 'fixed',
-            maxWidth: isMobile ? '100%' : '40%',
-            bottom: showCaptionAtTop ? '' : hideControlsForStreaming ? '5%' : '10%',
-            top: showCaptionAtTop ? (hideControlsForStreaming ? '5%' : '10%') : '',
-            left: isMobile ? 0 : '50%',
-            transform: isMobile ? '' : 'translateX(-50%)',
-            background: '#000000A3',
-            overflow: 'clip',
-            zIndex: 10,
-            height: 'fit-content',
-            r: '$1',
-            p: '$6',
-            transition: 'bottom 0.3s ease-in-out',
-            '&:empty': { display: 'none' },
-          }}
-        >
-          <CaptionsViewer />
-        </Box>
-      )}
       <Flex css={{ size: '100%', overflow: 'hidden' }} direction="column">
         {!(screenProps.hideSections.includes('header') || isMwebHLSStream) && (
           <Box

package/src/Prebuilt/layouts/VideoStreamingSection.tsx

@@ -16,6 +16,8 @@ import { PDFView } from './PDFView';
 import SidePane from './SidePane';
 // @ts-ignore: No implicit Any
 import { WaitingView } from './WaitingView';
+import { CaptionsViewer } from '../plugins/CaptionsViewer';
+// @ts-ignore: No implicit Any
 import {
   usePDFConfig,
   useUrlToEmbed,
@@ -25,7 +27,6 @@ import {
 import { useCloseScreenshareWhiteboard } from '../components/hooks/useCloseScreenshareWhiteboard';
 import { useLandscapeHLSStream, useMobileHLSStream } from '../common/hooks';
 import { SESSION_STORE_KEY } from '../common/constants';
-
 // @ts-ignore: No implicit Any
 const HLSView = React.lazy(() => import('./HLSView'));
 
@@ -105,6 +106,7 @@ export const VideoStreamingSection = ({
             // @ts-ignore
             return <GridLayout {...(elements as DefaultConferencingScreen_Elements)?.video_tile_layout?.grid} />;
           })}
+        <CaptionsViewer />
         <Box
           css={{
             flex: match({ isLandscapeHLSStream, isMobileHLSStream })

package/src/Prebuilt/plugins/CaptionsViewer.tsx

@@ -1,8 +1,15 @@
 import React, { useEffect, useState } from 'react';
+import { useMedia } from 'react-use';
 import { HMSTranscript, selectPeerNameByID, useHMSStore, useTranscript } from '@100mslive/react-sdk';
-import { Flex } from '../../Layout';
+import { Box, Flex } from '../../Layout';
 import { Text } from '../../Text';
-
+import { config } from '../../Theme';
+// @ts-ignore: No implicit Any
+import { useIsSidepaneTypeOpen } from '../components/AppData/useSidepane';
+// @ts-ignore: No implicit Any
+import { useIsCaptionEnabled } from '../components/AppData/useUISettings';
+import { useRoomLayoutConferencingScreen } from '../provider/roomLayoutProvider/hooks/useRoomLayoutScreen';
+import { SIDE_PANE_OPTIONS } from '../common/constants';
 interface CaptionQueueData extends HMSTranscript {
   transcriptQueue: SimpleQueue;
 }
@@ -135,7 +142,7 @@ class CaptionMaintainerQueue {
   }
 }
 const TranscriptView = ({ peer_id, data }: { peer_id: string; data: string }) => {
-  const peerName = useHMSStore(selectPeerNameByID(peer_id));
+  const peerName = useHMSStore(selectPeerNameByID(peer_id)) || 'Participant';
   data = data.trim();
   if (!data) return null;
   return (
@@ -145,15 +152,24 @@ const TranscriptView = ({ peer_id, data }: { peer_id: string; data: string }) =>
         fontWeight: '$normal',
       }}
     >
-      {`${peerName}: ${data}`}
+      <b>{peerName}: </b>
+      {data}
     </Text>
   );
 };
 
 export const CaptionsViewer = () => {
+  const { elements, screenType } = useRoomLayoutConferencingScreen();
+  const isMobile = useMedia(config.media.md);
+  const isChatOpen = useIsSidepaneTypeOpen(SIDE_PANE_OPTIONS.CHAT);
+
+  const showCaptionAtTop = elements?.chat?.is_overlay && isChatOpen && isMobile;
+
   const [captionQueue] = useState<CaptionMaintainerQueue>(new CaptionMaintainerQueue());
   const [currentData, setCurrentData] = useState<{ [key: string]: string }[]>([]);
 
+  const isCaptionEnabled = useIsCaptionEnabled();
+
   useEffect(() => {
     const timeInterval = setInterval(() => {
       if (!captionQueue) {
@@ -177,15 +193,34 @@ export const CaptionsViewer = () => {
     }
     return false;
   });
-  if (dataToShow.length <= 0) {
+  if (dataToShow.length <= 0 || screenType === 'hls_live_streaming' || !isCaptionEnabled) {
     return null;
   }
   return (
-    <Flex direction="column" gap={1}>
-      {dataToShow.map((data: { [key: string]: string }, index: number) => {
-        const key = Object.keys(data)[0];
-        return <TranscriptView key={index} peer_id={key} data={data[key]} />;
-      })}
-    </Flex>
+    <Box
+      css={{
+        position: 'absolute',
+        w: isMobile ? '100%' : '40%',
+        bottom: showCaptionAtTop ? '' : '0',
+        top: showCaptionAtTop ? '0' : '',
+        left: isMobile ? 0 : '50%',
+        transform: isMobile ? '' : 'translateX(-50%)',
+        background: '#000000A3',
+        overflow: 'clip',
+        zIndex: 10,
+        height: 'fit-content',
+        r: '$1',
+        p: '$6',
+        transition: 'bottom 0.3s ease-in-out',
+        '&:empty': { display: 'none' },
+      }}
+    >
+      <Flex direction="column">
+        {dataToShow.map((data: { [key: string]: string }, index: number) => {
+          const key = Object.keys(data)[0];
+          return <TranscriptView key={index} peer_id={key} data={data[key]} />;
+        })}
+      </Flex>
+    </Box>
   );
 };