@defcomm/meetingsdk 0.6.8 → 0.7.1

package/README.md

@@ -421,10 +421,26 @@ Toggle the local camera:
 ```tsx
 const { toggleCam } = useMeeting();
 
-<button onClick={toggleCam}>Toggle camera</button>;
-```
-
-The local participant state exposes `media.micEnabled` and `media.camEnabled`, so the button can reflect the current state.
+<button
+  onClick={() =>
+    void toggleCam().catch((error) => {
+      console.error("Unable to toggle camera", error);
+    })
+  }
+>
+  Toggle camera
+</button>;
+```
+
+Camera-off is a privacy action: the SDK detaches and stops the active camera
+`MediaStreamTrack`, releasing the browser's camera capture. It does not merely
+set `track.enabled = false`. Turning the camera back on explicitly requests a
+new camera track and may trigger the browser's permission prompt if access was
+revoked. Joining with `videoMuted: true` does not request camera access at all.
+
+The local participant state exposes `media.micEnabled` and `media.camEnabled`,
+so the button can reflect the current state. `toggleCam()` returns a Promise;
+handle errors if camera permission is denied or the device is unavailable.
 
 ---
 
@@ -811,7 +827,7 @@ export function Meeting() {
     <div>
       <button onClick={() => void join()}>Join</button>
       <button onClick={() => toggleMic()}>Mic</button>
-      <button onClick={() => toggleCam()}>Camera</button>
+      <button onClick={() => void toggleCam()}>Camera</button>
       <button onClick={() => void startScreenShare()}>
         Share screen
       </button>

package/dist/index.d.mts

@@ -112,7 +112,7 @@ type Participant = {
 type ParticipantMedia = {
     stream?: MediaStream | null;
     screenStream?: MediaStream | null;
-    cameraTrack?: MediaStreamTrack;
+    cameraTrack?: MediaStreamTrack | null;
     screenTrack?: MediaStreamTrack;
     audioTrack?: MediaStreamTrack;
     micEnabled: boolean;
@@ -315,6 +315,9 @@ declare class VideoSDKCore {
     private screenStream;
     private isScreenSharing;
     private participantName;
+    private cameraDeviceId?;
+    private cameraEnabled;
+    private cameraToggleInProgress;
     readonly state: MeetingState;
     private intentionalDisconnect;
     private remoteStreams;
@@ -325,6 +328,13 @@ declare class VideoSDKCore {
     private emitError;
     constructor(options: VideoSDKCoreOptions, events?: Events, apiBase?: string, wsBase?: string);
     initLocal(video: HTMLVideoElement, name: string): Promise<void>;
+    private hasLiveCameraTrack;
+    private getLiveCameraTrack;
+    /**
+     * Stop every locally captured camera track and remove it from the stream.
+     * Track.enabled=false only emits black frames; stop() releases camera capture.
+     */
+    private stopCameraCapture;
     private updateLocalMedia;
     createRoom(input: {
         name: string;
@@ -339,6 +349,13 @@ declare class VideoSDKCore {
     getMeetingSummary(roomCode: string, sessionId: string): Promise<{
         summary: MeetingSummary | null;
     }>;
+    private acquireOptionalLocalMedia;
+    private acquireCameraTrack;
+    /**
+     * Wakes the active-speaker Web Audio pipeline. Call this from a user gesture
+     * whenever possible (Join, first click inside the meeting, etc.).
+     */
+    resumeActiveSpeaker(): Promise<boolean>;
     joinMeeting(config: Omit<MeetingConfig, "participantId">): Promise<void>;
     private connect;
     private createSFUClient;
@@ -361,7 +378,7 @@ declare class VideoSDKCore {
     selectCamera(deviceId: string): Promise<MediaStreamTrack>;
     selectMicrophone(deviceId: string): Promise<MediaStreamTrack>;
     toggleMic(): void;
-    toggleCam(): void;
+    toggleCam(): Promise<void>;
     startScreenShare(): Promise<MediaStream | null>;
     stopScreenShare(): Promise<void>;
     startRecording(): Promise<void>;
@@ -426,7 +443,8 @@ type MeetingContextValue = {
         summary: MeetingSummary | null;
     }>;
     toggleMic: () => void;
-    toggleCam: () => void;
+    toggleCam: () => Promise<void>;
+    resumeActiveSpeaker: () => Promise<boolean>;
     startScreenShare: () => Promise<MediaStream | null>;
     stopScreenShare: () => void;
     sendMessage: (input: ChatInput) => void;
@@ -523,7 +541,8 @@ declare const useMeeting: (handlers?: {
         summary: MeetingSummary | null;
     }>;
     toggleMic: () => void;
-    toggleCam: () => void;
+    toggleCam: () => Promise<void>;
+    resumeActiveSpeaker: () => Promise<boolean>;
     startScreenShare: () => Promise<MediaStream | null>;
     stopScreenShare: () => void;
     sendMessage: (input: ChatInput) => void;
@@ -630,6 +649,15 @@ interface ActiveSpeakerDetectorOptions {
     releaseMs?: number;
     onActiveSpeakersChanged?: (participantIds: string[]) => void;
 }
+/**
+ * Detects currently speaking participants from the actual audio tracks that
+ * are being received/published by WebRTC.
+ *
+ * The AudioContext is explicitly resumable so an application can wake it from
+ * a real user gesture (for example, the Join button). This matters in browsers
+ * that create Web Audio contexts in the "suspended" state until the page has
+ * received user interaction.
+ */
 declare class ActiveSpeakerDetector {
     private audioContext;
     private speakers;
@@ -642,7 +670,12 @@ declare class ActiveSpeakerDetector {
     private lastEmitted;
     constructor(options?: ActiveSpeakerDetectorOptions);
     private ensureAudioContext;
-    resume(): Promise<void>;
+    /**
+     * Create/wake the Web Audio context. Call this from a user gesture when
+     * possible. Returns true when the context is running after the call.
+     */
+    resume(): Promise<boolean>;
+    getAudioContextState(): AudioContextState | "unavailable";
     addTrack(participantId: string, track: MediaStreamTrack): void;
     removeParticipant(participantId: string): void;
     removeTrack(track: MediaStreamTrack): void;
@@ -650,6 +683,7 @@ declare class ActiveSpeakerDetector {
     start(): void;
     stop(): void;
     private sample;
+    private getActiveSpeakers;
     private getActiveSpeakerIds;
     private emitIfChanged;
     destroy(): Promise<void>;

package/dist/index.d.ts

@@ -112,7 +112,7 @@ type Participant = {
 type ParticipantMedia = {
     stream?: MediaStream | null;
     screenStream?: MediaStream | null;
-    cameraTrack?: MediaStreamTrack;
+    cameraTrack?: MediaStreamTrack | null;
     screenTrack?: MediaStreamTrack;
     audioTrack?: MediaStreamTrack;
     micEnabled: boolean;
@@ -315,6 +315,9 @@ declare class VideoSDKCore {
     private screenStream;
     private isScreenSharing;
     private participantName;
+    private cameraDeviceId?;
+    private cameraEnabled;
+    private cameraToggleInProgress;
     readonly state: MeetingState;
     private intentionalDisconnect;
     private remoteStreams;
@@ -325,6 +328,13 @@ declare class VideoSDKCore {
     private emitError;
     constructor(options: VideoSDKCoreOptions, events?: Events, apiBase?: string, wsBase?: string);
     initLocal(video: HTMLVideoElement, name: string): Promise<void>;
+    private hasLiveCameraTrack;
+    private getLiveCameraTrack;
+    /**
+     * Stop every locally captured camera track and remove it from the stream.
+     * Track.enabled=false only emits black frames; stop() releases camera capture.
+     */
+    private stopCameraCapture;
     private updateLocalMedia;
     createRoom(input: {
         name: string;
@@ -339,6 +349,13 @@ declare class VideoSDKCore {
     getMeetingSummary(roomCode: string, sessionId: string): Promise<{
         summary: MeetingSummary | null;
     }>;
+    private acquireOptionalLocalMedia;
+    private acquireCameraTrack;
+    /**
+     * Wakes the active-speaker Web Audio pipeline. Call this from a user gesture
+     * whenever possible (Join, first click inside the meeting, etc.).
+     */
+    resumeActiveSpeaker(): Promise<boolean>;
     joinMeeting(config: Omit<MeetingConfig, "participantId">): Promise<void>;
     private connect;
     private createSFUClient;
@@ -361,7 +378,7 @@ declare class VideoSDKCore {
     selectCamera(deviceId: string): Promise<MediaStreamTrack>;
     selectMicrophone(deviceId: string): Promise<MediaStreamTrack>;
     toggleMic(): void;
-    toggleCam(): void;
+    toggleCam(): Promise<void>;
     startScreenShare(): Promise<MediaStream | null>;
     stopScreenShare(): Promise<void>;
     startRecording(): Promise<void>;
@@ -426,7 +443,8 @@ type MeetingContextValue = {
         summary: MeetingSummary | null;
     }>;
     toggleMic: () => void;
-    toggleCam: () => void;
+    toggleCam: () => Promise<void>;
+    resumeActiveSpeaker: () => Promise<boolean>;
     startScreenShare: () => Promise<MediaStream | null>;
     stopScreenShare: () => void;
     sendMessage: (input: ChatInput) => void;
@@ -523,7 +541,8 @@ declare const useMeeting: (handlers?: {
         summary: MeetingSummary | null;
     }>;
     toggleMic: () => void;
-    toggleCam: () => void;
+    toggleCam: () => Promise<void>;
+    resumeActiveSpeaker: () => Promise<boolean>;
     startScreenShare: () => Promise<MediaStream | null>;
     stopScreenShare: () => void;
     sendMessage: (input: ChatInput) => void;
@@ -630,6 +649,15 @@ interface ActiveSpeakerDetectorOptions {
     releaseMs?: number;
     onActiveSpeakersChanged?: (participantIds: string[]) => void;
 }
+/**
+ * Detects currently speaking participants from the actual audio tracks that
+ * are being received/published by WebRTC.
+ *
+ * The AudioContext is explicitly resumable so an application can wake it from
+ * a real user gesture (for example, the Join button). This matters in browsers
+ * that create Web Audio contexts in the "suspended" state until the page has
+ * received user interaction.
+ */
 declare class ActiveSpeakerDetector {
     private audioContext;
     private speakers;
@@ -642,7 +670,12 @@ declare class ActiveSpeakerDetector {
     private lastEmitted;
     constructor(options?: ActiveSpeakerDetectorOptions);
     private ensureAudioContext;
-    resume(): Promise<void>;
+    /**
+     * Create/wake the Web Audio context. Call this from a user gesture when
+     * possible. Returns true when the context is running after the call.
+     */
+    resume(): Promise<boolean>;
+    getAudioContextState(): AudioContextState | "unavailable";
     addTrack(participantId: string, track: MediaStreamTrack): void;
     removeParticipant(participantId: string): void;
     removeTrack(track: MediaStreamTrack): void;
@@ -650,6 +683,7 @@ declare class ActiveSpeakerDetector {
     start(): void;
     stop(): void;
     private sample;
+    private getActiveSpeakers;
     private getActiveSpeakerIds;
     private emitIfChanged;
     destroy(): Promise<void>;