@whereby.com/browser-sdk 1.8.1 → 2.0.0-alpha1

package/dist/types.d.ts

@@ -0,0 +1,104 @@
+import React from 'react';
+
+interface WherebyEmbedAttributes {
+    audio: string;
+    avatarUrl: string;
+    background: string;
+    cameraAccess: string;
+    chat: string;
+    displayName: string;
+    emptyRoomInvitation: string;
+    floatSelf: string;
+    help: string;
+    leaveButton: string;
+    logo: string;
+    people: string;
+    precallReview: string;
+    recording: string;
+    screenshare: string;
+    video: string;
+    virtualBackgroundUrl: string;
+    room: string;
+    style: {
+        [key: string]: string;
+    };
+}
+declare global {
+    namespace JSX {
+        interface IntrinsicElements {
+            ["whereby-embed"]: Partial<WherebyEmbedAttributes>;
+        }
+    }
+}
+
+interface VideoElProps {
+    stream: MediaStream;
+    style?: React.CSSProperties;
+}
+declare const _default: ({ stream, style }: VideoElProps) => JSX.Element;
+
+interface RoomParticipantData {
+    displayName: string;
+    id: string;
+    stream?: MediaStream;
+    isAudioEnabled: boolean;
+    isVideoEnabled: boolean;
+}
+declare class RoomParticipant {
+    readonly displayName: string;
+    readonly id: string;
+    readonly stream?: MediaStream;
+    readonly isAudioEnabled: boolean;
+    readonly isLocalParticipant: boolean;
+    readonly isVideoEnabled: boolean;
+    constructor({ displayName, id, stream, isAudioEnabled, isVideoEnabled }: RoomParticipantData);
+}
+interface RemoteParticipantData {
+    newJoiner: boolean;
+    streams: string[];
+}
+type StreamState = "new_accept" | "to_accept" | "old_accept" | "done_accept" | "to_unaccept" | "done_unaccept" | "auto";
+interface Stream {
+    id: string;
+    state: StreamState;
+}
+declare class RemoteParticipant extends RoomParticipant {
+    readonly newJoiner: boolean;
+    readonly streams: Stream[];
+    constructor({ displayName, id, newJoiner, streams, isAudioEnabled, isVideoEnabled, }: RoomParticipantData & RemoteParticipantData);
+    updateStreamState(streamId: string, state: StreamState): void;
+}
+declare class LocalParticipant extends RoomParticipant {
+    readonly isLocalParticipant = true;
+    constructor({ displayName, id, stream, isAudioEnabled, isVideoEnabled }: RoomParticipantData);
+}
+
+type Logger = Pick<Console, "debug" | "error" | "log" | "warn">;
+interface RoomConnectionOptions {
+    displayName?: string;
+    localStream?: MediaStream;
+    localMediaConstraints?: MediaStreamConstraints;
+    roomKey?: string;
+    logger?: Logger;
+}
+
+type RemoteParticipantState = Omit<RemoteParticipant, "updateStreamState">;
+interface RoomState {
+    localParticipant?: LocalParticipant;
+    roomConnectionStatus?: "connecting" | "connected" | "disconnected";
+    remoteParticipants: RemoteParticipantState[];
+}
+
+interface RoomConnectionActions {
+    toggleCamera(enabled?: boolean): void;
+    toggleMicrophone(enabled?: boolean): void;
+    setDisplayName(displayName: string): void;
+}
+interface RoomConnectionComponents {
+    VideoView: typeof _default;
+}
+declare function useRoomConnection(roomUrl: string, roomConnectionOptions: RoomConnectionOptions): [state: RoomState, actions: RoomConnectionActions, components: RoomConnectionComponents];
+
+declare const sdkVersion = "2.0.0-alpha1";
+
+export { sdkVersion, useRoomConnection };