@100mslive/react-sdk 0.0.5-alpha.0 → 0.0.5-alpha.5

package/dist/hooks/HmsRoomProvider.d.ts

@@ -1,10 +1,14 @@
 import React from 'react';
-import { HMSStore, HMSActions, HMSNotification, HMSNotifications, HMSStatsStore, HMSStats, HMSStoreWrapper } from '@100mslive/hms-video-store';
+import { HMSStore, HMSActions, HMSNotification, HMSNotifications, HMSStatsStore, IStoreReadOnly, HMSStats, HMSStoreWrapper } from '@100mslive/hms-video-store';
+import { EqualityChecker, StateSelector } from 'zustand';
+export interface IHMSReactStore<S extends HMSStore | HMSStatsStore> extends IStoreReadOnly<S> {
+    <U>(selector: StateSelector<S, U>, equalityFn?: EqualityChecker<U>): U;
+}
 export interface HMSRoomProviderProps {
     actions?: HMSActions;
     store?: HMSStoreWrapper;
     notifications?: HMSNotifications;
-    webrtcInternals?: HMSStats;
+    stats?: HMSStats;
     isHMSStatsOn?: boolean;
 }
 export declare const HMSRoomProvider: React.FC<HMSRoomProviderProps>;
@@ -12,8 +16,8 @@ export declare const HMSRoomProvider: React.FC<HMSRoomProviderProps>;
  * `useHMSStore` is a read only hook which can be passed a selector to read data.
  * The hook can only be used in a component if HMSRoomProvider is present in its ancestors.
  */
-export declare const useHMSStore: <StateSlice>(selector: import("zustand").StateSelector<HMSStore, StateSlice>, equalityFn?: import("zustand").EqualityChecker<StateSlice>) => StateSlice;
-export declare const useHMSStatsStore: <StateSlice>(selector: import("zustand").StateSelector<HMSStatsStore, StateSlice>, equalityFn?: import("zustand").EqualityChecker<StateSlice>) => StateSlice | undefined;
+export declare const useHMSStore: <StateSlice>(selector: StateSelector<HMSStore, StateSlice>, equalityFn?: EqualityChecker<StateSlice>) => StateSlice;
+export declare const useHMSStatsStore: <StateSlice>(selector: StateSelector<HMSStatsStore, StateSlice>, equalityFn?: EqualityChecker<StateSlice>) => StateSlice | undefined;
 /**
  * `useHMSVanillaStore` is a read only hook which returns the vanilla HMSStore.
  * Usage:
@@ -32,3 +36,4 @@ export declare const useHMSActions: () => HMSActions;
  * `useHMSNotifications` is a read only hook which gives the latest notification(HMSNotification) received.
  */
 export declare const useHMSNotifications: () => HMSNotification | null;
+export declare const useIsHMSStatsOn: () => boolean;

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

@@ -4,14 +4,18 @@ interface UseVideoListProps {
     /**
      * Max tiles in a  page. Overrides maxRowCount and maxColCount
      */
-    maxTileCount: number;
-    maxRowCount: number;
-    maxColCount: number;
-    width: number;
-    height: number;
+    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';
+    /**
+     * Aspect ratio of VideoTiles
+     */
     aspectRatio?: {
         width: number;
         height: number;
@@ -22,10 +26,11 @@ interface UseVideoListProps {
      */
     filterNonPublishingPeers?: boolean;
 }
-export declare const useVideoList: ({ maxTileCount, maxColCount, maxRowCount, width, height, showScreenFn, peers, overflow, aspectRatio, filterNonPublishingPeers, }: UseVideoListProps) => {
-    chunkedTracksWithPeer: (TrackWithPeer & {
+export declare const useVideoList: ({ maxTileCount, maxColCount, maxRowCount, showScreenFn, peers, overflow, aspectRatio, filterNonPublishingPeers, }: UseVideoListProps) => {
+    pagesWithTiles: (TrackWithPeer & {
         width: number;
         height: number;
     })[][];
+    ref: React.MutableRefObject<any>;
 };
 export {};