@sanseng/livekit-ws-sdk 0.1.17 → 0.1.20

package/dist/index.d.ts

@@ -130,6 +130,7 @@ interface AudioEvents {
      */
     frameSize: number;
   };
+  'inner:audio:speaking:changed': { participantId: string; isSpeaking: boolean };
   'inner:audio:track:added': { trackId: string; participantId: string };
   'inner:audio:track:removed': { trackId: string };
   'inner:audio:volume:changed': { volume: number };
@@ -762,6 +763,14 @@ interface ClientOptions extends BaseOptions {
      */
     headers?: Record<string, string>;
   };
+  /**
+   * Indicates if sandbox is enabled
+   *
+   * @type {boolean}
+   * @default undefined
+   * @author sansen
+   */
+  sandbox?: boolean;
 }
 
 /**
@@ -807,6 +816,43 @@ declare class SDKError extends Error {
     static fromError(error: unknown, code?: string): SDKError;
 }
 
+/**
+ * SDK connection state (lifecycle FSM state).
+ * Single source of truth for SDK lifecycle; used in connection snapshot overall state.
+ *
+ * @author sansen
+ */
+type SDKConnectionState = 'idle' | 'connecting' | 'connected' | 'partial' | 'reconnecting:auto' | 'reconnecting:manual' | 'disconnecting' | 'disconnected' | 'disposed' | 'error';
+/**
+ * Read-only connection snapshot.
+ * Derived from aggregated internal facts (rtc:* / ws:* events), not from LiveKit Room or Track objects.
+ * Used for user-driven reconnect UX: available synchronously when user triggers manual reconnect.
+ *
+ * @remarks
+ * - ws.connected: whether WebSocket (conversation) is currently connected.
+ * - rtc.connected: whether RTC (LiveKit) is currently connected.
+ * - rtc.hasVideoTrack: whether at least one video track is available (from rtc:video:available / rtc:video:unavailable).
+ * - overall.state: current SDK lifecycle state from SDKConnectionFSM.
+ *
+ * @author sansen
+ */
+interface ConnectionSnapshot {
+    readonly ws: {
+        /** True when WebSocket connection is open. */
+        readonly connected: boolean;
+    };
+    readonly rtc: {
+        /** True when LiveKit room is connected. */
+        readonly connected: boolean;
+        /** True when at least one video track is available (subscribed and usable). */
+        readonly hasVideoTrack: boolean;
+    };
+    readonly overall: {
+        /** Current lifecycle state from SDKConnectionFSM. */
+        readonly state: SDKConnectionState;
+    };
+}
+
 /**
  * SDK Context
  * Contains all shared states and event bus
@@ -841,6 +887,8 @@ declare class SDKContext {
     private _roomId;
     private _wsUrl;
     private _httpToken;
+    /** The function to return the current SDK connection FSM state by the coordinator */
+    private _connectionStateGetter;
     /**
      * Creates an SDK context instance
      *
@@ -919,6 +967,21 @@ declare class SDKContext {
         livekitUrl: string;
         token: string;
     };
+    /**
+     * Bind connection state getter to get the current SDK connection FSM state by the coordinator
+     * @param getter - The function to return the current SDK connection FSM state
+     * @author sansen
+     */
+    bindConnectionState(getter: () => SDKConnectionState): void;
+    /**
+     * The current SDK connection FSM state; undefined if not connected or not bound to the coordinator
+     */
+    get connectionState(): SDKConnectionState | undefined;
+    /**
+     * Clear connection state binding when dispose
+     * @author sansen
+     */
+    clearConnectionStateBinding(): void;
     /**
      * Disposes all resources and cleans up states
      *
@@ -927,43 +990,6 @@ declare class SDKContext {
     dispose(): void;
 }
 
-/**
- * SDK connection state (lifecycle FSM state).
- * Single source of truth for SDK lifecycle; used in connection snapshot overall state.
- *
- * @author sansen
- */
-type SDKConnectionState = 'idle' | 'connecting' | 'connected' | 'partial' | 'reconnecting:auto' | 'reconnecting:manual' | 'disconnecting' | 'disconnected' | 'disposed' | 'error';
-/**
- * Read-only connection snapshot.
- * Derived from aggregated internal facts (rtc:* / ws:* events), not from LiveKit Room or Track objects.
- * Used for user-driven reconnect UX: available synchronously when user triggers manual reconnect.
- *
- * @remarks
- * - ws.connected: whether WebSocket (conversation) is currently connected.
- * - rtc.connected: whether RTC (LiveKit) is currently connected.
- * - rtc.hasVideoTrack: whether at least one video track is available (from rtc:video:available / rtc:video:unavailable).
- * - overall.state: current SDK lifecycle state from SDKConnectionFSM.
- *
- * @author sansen
- */
-interface ConnectionSnapshot {
-    readonly ws: {
-        /** True when WebSocket connection is open. */
-        readonly connected: boolean;
-    };
-    readonly rtc: {
-        /** True when LiveKit room is connected. */
-        readonly connected: boolean;
-        /** True when at least one video track is available (subscribed and usable). */
-        readonly hasVideoTrack: boolean;
-    };
-    readonly overall: {
-        /** Current lifecycle state from SDKConnectionFSM. */
-        readonly state: SDKConnectionState;
-    };
-}
-
 interface PublicEmitterAPI {
     on<K extends keyof PublicSDKEvents>(event: K, listener: (data: PublicSDKEvents[K]) => void): () => void;
     off<K extends keyof PublicSDKEvents>(event: K, listener: (data: PublicSDKEvents[K]) => void): void;