@streaming-cdn/rtc-web 1.3.14 → 1.3.15

package/README.md

@@ -1,4 +1,4 @@
-# RTC Web SDK 1.3.14
+# RTC Web SDK 1.3.15
 
 The customer package contains compiled ESM/UMD JavaScript and TypeScript declarations. It intentionally excludes implementation source and source maps. Example source remains available under `examples/`.
 
@@ -169,6 +169,41 @@ the room client (`getNativeClient()`); the publisher keeps sending every
 layer. The React Native adapter has the same transport option and the same
 `setRemoteQuality` on the client.
 
+## Virtual backgrounds and effects
+
+`createVideoEffectsPipeline(cameraTrack)` draws the camera through a canvas
+and hands back a processed track for `setVideoTrack`, so both transports
+publish it unchanged. Backgrounds: `blur`, animated procedural scenes
+(`aurora`, `cybergrid`, `bokeh`, `sunset`), or your own `image`. Overlays:
+`snow`, `confetti`, `vignette`. Person cut-out uses any `Segmenter` you plug
+in (for example a self-hosted MediaPipe selfie model); without one the
+pipeline degrades honestly — `blur` blurs the whole frame, scenes show the
+camera as a floating card.
+
+```ts
+const effects = createVideoEffectsPipeline(cameraTrack, { segmenter });
+effects.setBackground("aurora");
+effects.setOverlay("confetti");
+await media.setVideoTrack(effects.track);
+```
+
+## Call recording
+
+`createCallRecorder(media.getNativeClient(), { credential })` composites every
+participant's video onto a canvas, mixes all audio, records with
+MediaRecorder, and on `stop()` uploads the file with the room signaling token.
+The platform stores it, bills the storage, lists it under
+`GET /v1/rtc/recordings` (Server API), and serves it from
+`GET /v1/rtc/recordings/{id}/download`. Recording happens on this client —
+what is recorded is what this participant saw and heard.
+
+```ts
+const recorder = createCallRecorder(media.getNativeClient(), { credential });
+await recorder.start();
+// ... later
+const { recordingId, durationSeconds } = await recorder.stop();
+```
+
 ## Active speaker
 
 The client samples WebRTC audio levels once a second on both transports and

package/dist/call-recorder.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Client-side call recording.
+ *
+ * The mesh has no server with access to the media, so the first recorder that
+ * can exist lives where the media already is: this client. It composites every
+ * video tile onto a canvas, mixes every audio track, records the result with
+ * MediaRecorder, and uploads the finished file with the room signaling token.
+ * The platform bills and purges the stored file through the same
+ * `rtc_recordings` rows a future server-side recorder will use.
+ */
+export interface RecordableRoomClient {
+    getRemoteStreams(): Array<{
+        participant: {
+            participantId: string;
+            displayName: string;
+        };
+        stream: MediaStream;
+    }>;
+    getLocalStream(): MediaStream | null;
+}
+export interface CallRecorderOptions {
+    credential: {
+        signalingToken: string;
+        signalingUrl: string;
+    };
+    /** Canvas output height; width follows 16:9. Default 720. */
+    height?: number;
+    mimeType?: string;
+    /** Test seams. */
+    document?: Document;
+    mediaRecorderFactory?: (stream: MediaStream, options: {
+        mimeType: string;
+    }) => MediaRecorder;
+    fetchImplementation?: typeof fetch;
+}
+export interface CallRecorderResult {
+    recordingId: string;
+    sizeBytes: number;
+    durationSeconds: number;
+}
+export interface CallRecorder {
+    readonly recording: boolean;
+    start(): Promise<void>;
+    /** Stops, uploads, and marks the recording ready. */
+    stop(): Promise<CallRecorderResult>;
+    dispose(): void;
+}
+export declare function createCallRecorder(client: RecordableRoomClient, options: CallRecorderOptions): CallRecorder;

package/dist/index.d.ts

@@ -2,6 +2,10 @@ export { createPictureInPictureController } from "./picture-in-picture";
 export type { PictureInPictureController, PictureInPictureOptions } from "./picture-in-picture";
 export { pickActiveSpeaker, SPEAKER_NOISE_FLOOR, SPEAKER_TAKEOVER_RATIO } from "./active-speaker";
 export type { SpeakerLevel } from "./active-speaker";
+export { createCallRecorder } from "./call-recorder";
+export type { CallRecorder, CallRecorderOptions, CallRecorderResult } from "./call-recorder";
+export { BACKGROUND_PRESETS, createVideoEffectsPipeline, OVERLAY_EFFECTS, scenePainters } from "./video-effects";
+export type { BackgroundPreset, OverlayEffect, Segmenter, VideoEffectsOptions, VideoEffectsPipeline } from "./video-effects";
 export type RtcMode = "voice" | "video" | "meeting";
 /**
  * How media travels. `mesh` (the default) opens one connection per pair and
@@ -338,4 +342,4 @@ export declare class RtcIncomingClient extends EventTarget {
     private emit;
 }
 export declare function createRtcIncomingClient(options: RtcIncomingClientOptions): RtcIncomingClient;
-export declare const version = "1.3.14";
+export declare const version = "1.3.15";