@100mslive/react-sdk 0.0.5-alpha.1 → 0.0.5-alpha.6

package/dist/hooks/useVideo.d.ts

@@ -1,2 +1,7 @@
-import { HMSPeerID } from '@100mslive/hms-video-store';
-export declare const useVideo: (trackId: HMSPeerID) => (node: any) => void;
+import { HMSTrackID } from '@100mslive/hms-video-store';
+/**
+ *
+ * @param trackId {HMSTrackID}
+ * the returned ref can be used to set on a video element meant to display the video for the passed in track id. The hook will take care of attaching and detaching video, and will automatically detach when the video goes out of view to save on bandwidth.
+ */
+export declare const useVideo: (trackId: HMSTrackID) => (node: any) => void;

package/dist/hooks/useVideoList.d.ts

@@ -7,6 +7,9 @@ interface UseVideoListProps {
     maxTileCount?: number;
     maxRowCount?: number;
     maxColCount?: number;
+    /**
+     * Given a screensharing peer the function should return true if their screenshare should be included for the video tile, and false otherwise. This can be useful if there are multiple screenshares in the room where you may want to show one in the center view and others in video list along side other tiles.
+     */
     showScreenFn?: (peer: HMSPeer) => boolean;
     peers: HMSPeer[];
     overflow?: 'scroll-x' | 'scroll-y' | 'hidden';
@@ -24,7 +27,7 @@ interface UseVideoListProps {
     filterNonPublishingPeers?: boolean;
 }
 export declare const useVideoList: ({ maxTileCount, maxColCount, maxRowCount, showScreenFn, peers, overflow, aspectRatio, filterNonPublishingPeers, }: UseVideoListProps) => {
-    chunkedTracksWithPeer: (TrackWithPeer & {
+    pagesWithTiles: (TrackWithPeer & {
         width: number;
         height: number;
     })[][];