miva-proctor-sdk 0.0.54 → 0.0.55-socket-v1

package/dist/cjs/src/modules/ProctoringSocketCore.d.ts

@@ -0,0 +1,161 @@
+import { ProctoringSocketConfig } from '../types/socket_types';
+/**
+ * Manages socket-based communication for proctoring sessions
+ * and provides a comprehensive interface for proctoring functionality
+ */
+export declare class ProctoringSocketCore {
+    private socket;
+    private config;
+    private isConnected;
+    private reconnectAttempts;
+    private pingInterval;
+    private lastPingTime;
+    private pingTimeout;
+    private tracking;
+    private screenSharing;
+    private fullscreen;
+    private inFocus;
+    private videoElement?;
+    private stream?;
+    private errorMessage;
+    private errorCode;
+    private audioDetector?;
+    private cameraStream?;
+    private faceDetector?;
+    /**
+     * Creates a new ProctoringManager
+     * @param config Configuration for the proctoring manager
+     */
+    constructor(config: ProctoringSocketConfig);
+    /**
+     * Connects to the proctoring socket server
+     * @returns Promise that resolves when connected
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnects from the proctoring socket server
+     */
+    disconnect(): void;
+    /**
+     * Sends a ping to the server to update the session
+     * @returns Promise that resolves when the ping is sent
+     */
+    pingSession(): Promise<void>;
+    /**
+     * Ends the proctoring session
+     * @returns Promise that resolves when the session is ended
+     */
+    endSession(): Promise<void>;
+    /**
+     * Starts a new proctoring session
+     * @param showFullscreenModal Optional callback to show a fullscreen modal
+     * @returns Promise that resolves to true if the session was started successfully
+     */
+    startSession(showFullscreenModal?: (cb: () => Promise<void>) => Promise<void>): Promise<boolean>;
+    /**
+     * Stops the proctoring session
+     */
+    stopSession(): Promise<void>;
+    /**
+     * Requests media permissions for camera and audio
+     */
+    private requestMediaPermissions;
+    /**
+     * Starts screen sharing
+     * @param isEnableFullScreen Whether to enable fullscreen
+     * @returns Promise that resolves to true if screen sharing was started successfully
+     */
+    private startScreenSharing;
+    /**
+     * Stops screen sharing
+     */
+    private stopScreenSharing;
+    /**
+     * Handles screen sharing ended event
+     */
+    private screenSharingEnded;
+    /**
+     * Starts fullscreen mode
+     */
+    private startFullscreen;
+    /**
+     * Stops fullscreen mode
+     */
+    private stopFullscreen;
+    /**
+     * Registers event listeners for window events
+     */
+    private registerForEvents;
+    /**
+     * Unregisters event listeners for window events
+     */
+    private unregisterEvents;
+    /**
+     * Handles focus event
+     */
+    private focusEvent;
+    /**
+     * Handles blur event
+     */
+    private blurEvent;
+    /**
+     * Checks if the window is in fullscreen mode
+     * @returns True if in fullscreen mode
+     */
+    isFullScreen(): boolean;
+    /**
+     * Handles resize event
+     */
+    private resizeEvent;
+    /**
+     * Takes a screenshot of the provided stream
+     * @param stream The media stream to take a screenshot of
+     * @returns Promise that resolves to a blob containing the screenshot
+     */
+    takeScreenshot(stream: MediaStream): Promise<Blob>;
+    /**
+     * Fallback method for taking screenshots in SEB or when Canvas API is blocked
+     * @param stream The media stream to take a screenshot of
+     * @returns Promise that resolves to a blob containing the screenshot
+     */
+    private takeScreenshotFallback;
+    /**
+     * Detects if running in SEB
+     * @returns True if running in SEB
+     */
+    private isSEB;
+    /**
+     * Checks if there are external monitors
+     * @returns True if there are external monitors
+     */
+    hasExternalMonitors(): boolean;
+    /**
+     * Takes a random screenshot
+     */
+    takeRandomScreenshot(): Promise<void>;
+    /**
+     * Takes a random picture from the camera
+     */
+    takeRandomPicture(): Promise<void>;
+    /**
+     * Calls takeRandomPicture or takeRandomScreenshot randomly
+     */
+    callRandomPictureOrScreenshot(): void;
+    /**
+     * Checks if the socket is connected
+     * @returns True if connected, false otherwise
+     */
+    isSocketConnected(): boolean;
+    /**
+     * Sets up event listeners for the socket
+     */
+    private setupEventListeners;
+    /**
+     * Starts the ping interval to keep the session alive
+     */
+    private startPingInterval;
+    /**
+     * Stops the ping interval
+     */
+    private stopPingInterval;
+}