@whereby.com/browser-sdk 2.13.0 → 3.0.1

package/dist/react/index.d.ts

@@ -1,27 +1,38 @@
 import * as React from 'react';
-import { Store, LocalMediaOptions, RemoteParticipant, LocalParticipant, Screenshare, ConnectionStatus, ChatMessage as ChatMessage$1 } from '@whereby.com/core';
+import { LocalMediaOptions, RemoteParticipant, LocalParticipant, Screenshare, ConnectionStatus, NotificationsEventEmitter, ClientView, ChatMessage as ChatMessage$1 } from '@whereby.com/core';
 import { RoleName } from '@whereby.com/media';
 
+interface ProviderProps {
+    children: React.ReactNode;
+}
+declare function Provider({ children }: ProviderProps): React.JSX.Element;
+
 interface VideoViewSelfProps {
     stream: MediaStream;
     muted?: boolean;
     mirror?: boolean;
     style?: React.CSSProperties;
-    onResize?: ({ width, height, stream }: {
+    onVideoResize?: ({ width, height, stream }: {
         width: number;
         height: number;
         stream: MediaStream;
     }) => void;
-    onSetAspectRatio?: ({ aspectRatio }: {
-        aspectRatio: number;
-    }) => void;
 }
-type VideoViewProps = VideoViewSelfProps & React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>;
-declare const _default: ({ muted, mirror, stream, onResize, onSetAspectRatio, ...rest }: VideoViewProps) => React.JSX.Element;
+type WherebyVideoElement = HTMLVideoElement & {
+    captureAspectRatio: () => number;
+    onVideoResize: ({ width, height, stream }: {
+        width: number;
+        height: number;
+        stream: MediaStream;
+    }) => void;
+};
+type VideoViewProps = VideoViewSelfProps & React.DetailedHTMLProps<React.VideoHTMLAttributes<WherebyVideoElement>, WherebyVideoElement>;
+declare const VideoView: React.ForwardRefExoticComponent<Omit<VideoViewProps, "ref"> & React.RefAttributes<WherebyVideoElement>>;
 
 interface LocalMediaState {
     currentCameraDeviceId?: string;
     currentMicrophoneDeviceId?: string;
+    currentSpeakerDeviceId?: string;
     cameraDeviceError: unknown;
     cameraDevices: MediaDeviceInfo[];
     isSettingCameraDevice: boolean;
@@ -36,6 +47,7 @@ interface LocalMediaState {
 interface LocalMediaActions {
     setCameraDevice: (deviceId: string) => void;
     setMicrophoneDevice: (deviceId: string) => void;
+    setSpeakerDevice: (deviceId: string) => void;
     toggleCameraEnabled: (enabled?: boolean) => void;
     toggleMicrophoneEnabled: (enabled?: boolean) => void;
     toggleLowDataModeEnabled: (enabled?: boolean) => void;
@@ -43,7 +55,6 @@ interface LocalMediaActions {
 type UseLocalMediaResult = {
     state: LocalMediaState;
     actions: LocalMediaActions;
-    store: Store;
 };
 type UseLocalMediaOptions = LocalMediaOptions;
 
@@ -75,15 +86,17 @@ type LiveStreamState = {
     startedAt?: number;
 };
 interface RoomConnectionState {
+    connectionStatus: ConnectionStatus;
     chatMessages: ChatMessage[];
     cloudRecording?: CloudRecordingState;
+    events?: NotificationsEventEmitter;
+    liveStream?: LiveStreamState;
     localScreenshareStatus?: LocalScreenshareStatus;
     localParticipant?: LocalParticipantState;
     remoteParticipants: RemoteParticipantState[];
     screenshares: Screenshare[];
-    connectionStatus: ConnectionStatus;
-    liveStream?: LiveStreamState;
     waitingParticipants: WaitingParticipantState[];
+    spotlightedParticipants: ClientView[];
 }
 interface RoomConnectionOptions {
     displayName?: string;
@@ -97,6 +110,8 @@ interface UseRoomConnectionOptions extends Omit<RoomConnectionOptions, "localMed
 }
 interface RoomConnectionActions {
     toggleLowDataMode(enabled?: boolean): void;
+    toggleRaiseHand(enabled?: boolean): void;
+    askToSpeak(participantId: string): void;
     acceptWaitingParticipant(participantId: string): void;
     knock(): void;
     joinRoom(): void;
@@ -114,20 +129,54 @@ interface RoomConnectionActions {
     stopScreenshare(): void;
     toggleCamera(enabled?: boolean): void;
     toggleMicrophone(enabled?: boolean): void;
+    spotlightParticipant(clientId: string): void;
+    removeSpotlight(clientId: string): void;
 }
 
-type VideoViewComponentProps = Omit<React.ComponentProps<typeof _default>, "onResize">;
-interface RoomConnectionComponents {
-    VideoView: (props: VideoViewComponentProps) => ReturnType<typeof _default>;
-}
 type RoomConnectionRef = {
-    state: RoomConnectionState;
+    state: Omit<RoomConnectionState, "events">;
     actions: RoomConnectionActions;
-    components: RoomConnectionComponents;
-    _ref: Store;
+    events?: NotificationsEventEmitter;
 };
 declare function useRoomConnection(roomUrl: string, roomConnectionOptions?: UseRoomConnectionOptions): RoomConnectionRef;
 
 declare function useLocalMedia(optionsOrStream?: UseLocalMediaOptions | MediaStream): UseLocalMediaResult;
 
-export { type ChatMessageState as ChatMessage, type LocalParticipantState as LocalParticipant, type RemoteParticipantState as RemoteParticipant, type RoomConnectionState as RoomConnection, type ScreenshareState as Screenshare, type UseLocalMediaResult, _default as VideoView, type WaitingParticipantState as WaitingParticipant, useLocalMedia, useRoomConnection };
+type Origin = {
+    top: number;
+    left: number;
+};
+type Bounds = {
+    width: number;
+    height: number;
+};
+type CellView = {
+    aspectRatio?: number;
+    avatarSize?: number;
+    cellPaddings?: {
+        top: number;
+        right: number;
+    };
+    client?: ClientView;
+    clientId: string;
+    isDraggable?: boolean;
+    isPlaceholder?: boolean;
+    isSubgrid?: boolean;
+    type: string;
+};
+
+interface GridProps {
+    renderParticipant?: ({ cell, participant, }: {
+        cell: {
+            clientId: string;
+            bounds: Bounds;
+            origin: Origin;
+        };
+        participant: CellView["client"];
+    }) => React.ReactNode;
+    videoGridGap?: number;
+    stageParticipantLimit?: number;
+}
+declare function Grid({ renderParticipant, stageParticipantLimit, videoGridGap }: GridProps): React.JSX.Element;
+
+export { type ChatMessageState as ChatMessage, type LocalParticipantState as LocalParticipant, type RemoteParticipantState as RemoteParticipant, type RoomConnectionState as RoomConnection, type ScreenshareState as Screenshare, type UseLocalMediaResult, Grid as VideoGrid, VideoView, type WaitingParticipantState as WaitingParticipant, Provider as WherebyProvider, useLocalMedia, useRoomConnection };