@streaming-cdn/rtc-web 1.3.12 → 1.3.14

package/dist/picture-in-picture.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Browser picture-in-picture for a call.
+ *
+ * The familiar shape: the call keeps playing in a small always-on-top window
+ * while the user works in another tab or application. This controller owns a
+ * hidden video element, feeds it the chosen participant's stream (or the
+ * local preview as a fallback), and drives the browser's PiP API. Browsers
+ * only honour `requestPictureInPicture` from a user gesture, so `enter()`
+ * belongs in a click handler; calling it elsewhere reports the browser's
+ * refusal rather than pretending.
+ */
+export interface RtcRemoteStreamSource {
+    getRemoteStreams(): Array<{
+        participant: {
+            participantId: string;
+        };
+        stream: MediaStream;
+    }>;
+    getLocalStream(): MediaStream | null;
+}
+export interface PictureInPictureOptions {
+    /** Called when the browser closes the floating window. */
+    onLeave?: () => void;
+    /** Test seam; defaults to globalThis.document. */
+    document?: Document;
+}
+export interface PictureInPictureController {
+    /** Whether this browser can do picture-in-picture at all. */
+    readonly supported: boolean;
+    /**
+     * Opens the floating window with the given participant's video, the first
+     * remote participant when omitted, or the local preview when nobody else
+     * has video yet. Must be called from a user gesture.
+     */
+    enter(participantId?: string): Promise<void>;
+    exit(): Promise<void>;
+    /** Releases the hidden video element and listeners. */
+    dispose(): void;
+}
+export declare function createPictureInPictureController(client: RtcRemoteStreamSource, options?: PictureInPictureOptions): PictureInPictureController;