@voltkit-rtc/client 0.4.0 → 0.6.0

package/src/index.ts

@@ -1,3 +1,4 @@
+import { CameraRecording, type RecordingOptions, type RecordingFile } from './recording.js';
 /**
  * Thin client SDK over the orchestrator's signaling protocol.
  *
@@ -34,6 +35,12 @@ import {
   allowedQuality,
   DEFAULT_VIDEO_POLICY,
   sameLayout,
+  describeVideoLayers,
+  receiveSpatialLayer,
+  screenEncodings,
+  type ScreenMode,
+  type ReceiveQuality,
+  type VideoLayer,
   topLayerSize,
   videoEncodings,
   type LayerCount,
@@ -52,13 +59,15 @@ import {
   type VideoSendStats,
 } from './stats.js';
 
+export { CameraRecording, RecordingUploader, RecordingError } from './recording.js';
+export type { RecordingOptions, RecordingEvent, RecordingState, RecordingSession, RecordingFile } from './recording.js';
 export { BroadcastPublisher, WhipError, whipEnd, whipOffer } from './broadcast.js';
 export { AudioMixer, MusicSource } from './music.js';
 export type { MusicInput, MusicOptions, TrackSource } from './music.js';
 export type { BroadcastEvents, BroadcastStartOptions, BroadcastState } from './broadcast.js';
 export { ChatClient, ChatRpcError } from './chat.js';
 export { allowedQuality, layerBitrate, videoEncodings, VIDEO_QUALITIES } from './quality.js';
-export type { LayerCount, VideoEncoding, VideoPolicy, VideoQuality } from './quality.js';
+export type { LayerCount, VideoEncoding, VideoPolicy, VideoQuality, VideoLayer, ReceiveQuality, ScreenMode } from './quality.js';
 export type { CodecPreference } from './device.js';
 export type { VideoLayerStats, VideoLimitedEvent, VideoLimitReason, VideoReceiveStats, VideoSendStats } from './stats.js';
 export type {
@@ -98,12 +107,14 @@ export interface JoinResult {
   blockedSlots?: string[];
   /**
    * The highest video quality this project may publish, and the server's cap
-   * on a publisher's incoming bitrate. Absent from older servers: 720p.
+   * on a publisher's incoming bitrate. Absent from older servers: 1080p.
    */
   video?: VideoPolicy;
 }
 
 export interface PublishOptions {
+  /** 30 by default. Only the top layer uses 60; capture at 60 too. */
+  frameRate?: 30 | 60;
   /**
    * The video quality to send: 1080p, 720p or 480p. Defaults to the highest
    * the project allows (`videoPolicy.maxQuality`), and is lowered to it if
@@ -140,6 +151,13 @@ export interface PublishOptions {
   degradationPreference?: 'maintain-resolution' | 'maintain-framerate' | 'balanced';
 }
 
+export interface ScreenPublishOptions {
+  mode?: ScreenMode;
+  audio?: boolean;
+  /** An existing screen stream; otherwise capture is requested from this user gesture. */
+  stream?: MediaStream;
+}
+
 export interface SlotClaim {
   key: string;
   identity: string;
@@ -153,7 +171,9 @@ export interface ParticipantInfo {
   identity: string;
   role: Role;
   handRaised: boolean;
+  handMetadata?: Record<string, unknown>;
   muted: boolean;
+  videoBlocked?: boolean;
   metadata?: unknown;
 }
 
@@ -164,6 +184,8 @@ export interface RemoteProducer {
   paused: boolean;
   /** What the track carries. A host playing music publishes two audio tracks: `mic` and `music`. */
   source?: TrackSource;
+  videoLayers?: VideoLayer[];
+  appData?: { videoLayers?: VideoLayer[] };
 }
 
 const defaultSource = (kind: 'audio' | 'video'): TrackSource => (kind === 'audio' ? 'mic' : 'camera');
@@ -185,8 +207,9 @@ export interface ClientEvents extends ChatEvents {
   trackMuted: (info: { identity: string; kind: 'audio' | 'video'; source: TrackSource; producerId: string; paused: boolean }) => void;
   participantJoined: (p: ParticipantInfo) => void;
   participantLeft: (p: { identity: string; reason?: string }) => void;
+  participantMuted: (e: { identity: string; kind?: 'audio' | 'video' | ''; paused: boolean }) => void;
   roleChanged: (e: { identity: string; role: Role }) => void;
-  handRaised: (e: { identity: string; handRaised: boolean }) => void;
+  handRaised: (e: { identity: string; handRaised: boolean; metadata?: Record<string, unknown>; reason?: string }) => void;
   /**
    * A moderator switched your microphone (`audio`), camera (`video`) or both
    * (no kind) off, or released it (`paused: false`). While paused you cannot
@@ -196,6 +219,8 @@ export interface ClientEvents extends ChatEvents {
   mustReconnect: (e: { reason: string; token?: string; retry: boolean }) => void;
   roomClosed: (e: { reason: string }) => void;
   kicked: (e: { by: string; reason?: string }) => void;
+  screenShareStarted: (e: { stream: MediaStream; mode: ScreenMode }) => void;
+  screenShareEnded: (e: { reason: 'stopped' | 'track-ended' }) => void;
   error: (err: Error) => void;
   localMediaChanged: (state: { micEnabled: boolean; camEnabled: boolean; musicEnabled: boolean }) => void;
   /** The local stream was replaced, typically after reacquiring devices on a reconnect. */
@@ -278,7 +303,7 @@ const isLayer = (value: unknown): value is number => Number.isInteger(value) &&
  * Where a new camera stream's bandwidth estimate starts, in kbps. Chrome
  * otherwise starts low and takes many seconds to climb to the top layer.
  */
-const VIDEO_START_BITRATE_KBPS = 1500;
+const VIDEO_START_BITRATE_KBPS = 2000;
 
 /** Why a publish gave up: unpublish() ran while it was under way, and unpublish wins. */
 const unpublishedWhile = (what: string) => `the ${what} was unpublished while it was being published`;
@@ -302,6 +327,7 @@ export class StreamClient {
   private token: string;
   private joinResult: JoinResult | null = null;
   private localStream: MediaStream | null = null;
+  private recording: CameraRecording | null = null;
   // A reconnect tears down every transport and producer. Without remembering
   // that this client was publishing -- and what it was publishing with -- a
   // broadcaster that reconnects rejoins silently, which is worse than being
@@ -312,6 +338,20 @@ export class StreamClient {
   /** In-app music being published, kept across reconnects so it can be published again. */
   private music: MusicSource | null = null;
   private musicProducerId: string | null = null;
+  private screenStream: MediaStream | null = null;
+  private screenMode: ScreenMode = 'detail';
+  private screenAudioEnabled = true;
+  private screenGeneration = 0;
+  private screenPending = false;
+  private screenStarted = false;
+  private screenEndedListener: (() => void) | null = null;
+  private readonly screenProducerIds = new Set<string>();
+  private readonly remoteVideoLayers = new Map<string, VideoLayer[]>();
+  private readonly receiveQualities = new Map<string, ReceiveQuality>();
+  private cameraFrameRate: 30 | 60 = 30;
+  private frameRateFallback = false;
+  private frameRateLowSamples = 0;
+  private frameRateWarmupSamples = 2;
   /** What each remote producer carries, so a pause can say "music" rather than just "audio". */
   private readonly remoteSources = new Map<string, TrackSource>();
   /**
@@ -339,7 +379,7 @@ export class StreamClient {
   private readonly sendStatsBaseline: StatsBaseline = new Map();
   private readonly recvStatsBaseline: StatsBaseline = new Map();
   private readonly limitWatch = new VideoLimitWatch(
-    (baseline) => this.collectVideoStats(baseline),
+    (baseline) => this.sampleCamera(baseline),
     (event) => this.emit('videoLimited', event),
   );
 
@@ -401,15 +441,29 @@ export class StreamClient {
     this.reconnectAttempt = 0;
     this.joinedOnce = true;
 
+    // A role or mute can change while the socket is away. The fresh roster
+    // decides what may return; reconnecting never turns a blocked device on.
+    if (result.role !== 'host' && result.role !== 'cohost' && (this.wasPublishing || this.screenPending)) {
+      await this.unpublish();
+    }
+    const own = result.participants.find((p) => p.identity === result.identity);
+    if (own?.muted) this.applyLocalModeration('audio');
+    if (own?.videoBlocked) this.applyLocalModeration('video');
     this.emit('joined', result);
 
     // A video that ended while this client was away sends it no
     // producerClosed: forget the layers asked for it.
     const present = new Set(result.producers.map((p) => p.producerId));
     for (const producerId of this.preferredLayers.keys()) {
-      if (!present.has(producerId)) this.preferredLayers.delete(producerId);
+      if (!present.has(producerId)) {
+        this.preferredLayers.delete(producerId);
+        this.receiveQualities.delete(producerId);
+        this.remoteVideoLayers.delete(producerId);
+      }
     }
 
+    for (const producerId of this.remoteVideoLayers.keys()) if (!present.has(producerId)) this.remoteVideoLayers.delete(producerId);
+
     // Subscribe to everything already publishing before we announce readiness.
     for (const p of result.producers) {
       await this.consume(p).catch((err) => this.emit('error', err as Error));
@@ -549,13 +603,20 @@ export class StreamClient {
   }
 
   close(): void {
+    void this.stopRecording().catch(() => undefined);
     // Only an app closing a live session is 'left'; kicked, room-closed and the
     // others have already reported themselves and set closedByUs.
     const wasOpen = !this.closedByUs;
     this.closedByUs = true;
+    this.publishGeneration += 1;
     this.wasPublishing = false;
     this.teardownMedia();
     this.preferredLayers.clear();
+    this.receiveQualities.clear();
+    this.remoteVideoLayers.clear();
+    this.releaseScreen();
+    this.music?.close();
+    this.music = null;
     // Nothing is emitted after closing, so not even a clearing videoLimited.
     this.limitWatch.reset();
     // Producers no longer stop their tracks, so releasing the camera and
@@ -574,6 +635,7 @@ export class StreamClient {
     for (const p of this.producers.values()) p.close();
     this.producers.clear();
     this.musicProducerId = null;
+    this.screenProducerIds.clear();
     this.cameraEncodings = null;
     // Paused, not reset: a reconnect's republish starts it again, and a
     // limitation already reported is not reported twice.
@@ -651,6 +713,8 @@ export class StreamClient {
       case 'producerClosed': {
         const { producerId, identity } = data as { producerId: string; identity: string };
         this.preferredLayers.delete(producerId);
+        this.receiveQualities.delete(producerId);
+        this.remoteVideoLayers.delete(producerId);
         const consumer = this.consumers.get(producerId);
         if (!consumer) break; // never consumed it, or already cleaned up
         consumer.close();
@@ -673,16 +737,28 @@ export class StreamClient {
       case 'participantJoined':
         this.emit('participantJoined', data as ParticipantInfo);
         break;
+      case 'participantMuted': {
+        const wire = data as { identity: string; kind?: 'audio' | 'video' | ''; muted?: boolean; paused?: boolean };
+        const e = { identity: wire.identity, kind: wire.kind, paused: wire.paused ?? wire.muted ?? false };
+        if (this.joinResult) this.joinResult.participants = this.joinResult.participants.map((p) =>
+          p.identity !== e.identity ? p : { ...p,
+            ...(!e.kind || e.kind === 'audio' ? { muted: e.paused } : {}),
+            ...(!e.kind || e.kind === 'video' ? { videoBlocked: e.paused } : {}),
+          });
+        this.emit('participantMuted', e);
+        break;
+      }
       case 'participantLeft':
         this.emit('participantLeft', data as { identity: string; reason?: string });
         break;
       case 'roleChanged': {
         const e = data as { identity: string; role: Role };
+        if (e.identity === this.joinResult?.identity) this.joinResult.role = e.role;
         this.emit('roleChanged', e);
         // Demoted: the server has already closed our producers. Release the
         // camera and microphone too, instead of capturing for nobody.
         const canPublish = e.role === 'host' || e.role === 'cohost';
-        if (e.identity === this.joinResult?.identity && !canPublish && this.producers.size > 0) {
+        if (e.identity === this.joinResult?.identity && !canPublish && (this.wasPublishing || this.screenPending)) {
           void this.unpublish().catch(() => undefined);
         }
         break;
@@ -697,9 +773,7 @@ export class StreamClient {
         // changes nothing here -- switching back on is the user's choice.
         const e = data as { by: string; kind?: 'audio' | 'video' | ''; paused: boolean };
         if (e.paused) {
-          for (const p of this.producers.values()) {
-            if (!e.kind || p.kind === e.kind) p.pause();
-          }
+          this.applyLocalModeration(e.kind);
           this.emitLocalMedia();
         }
         this.emit('forceMuted', e);
@@ -787,7 +861,7 @@ export class StreamClient {
         .catch(fail);
     });
     transport.on('produce', ({ kind, rtpParameters, appData }, ok, fail) => {
-      this.rpc('produce', { transportId: transport.id, kind, rtpParameters, appData, source: appData.source })
+      this.rpc('produce', { transportId: transport.id, kind, rtpParameters, appData, source: appData.source, videoLayers: appData.videoLayers })
         .then((res) => ok({ id: (res as { producerId: string }).producerId }))
         .catch(fail);
     });
@@ -844,7 +918,11 @@ export class StreamClient {
     this.localStream = stream;
     this.wasPublishing = true;
     if (constraints) this.publishConstraints = constraints;
-    if (options) this.publishOptions = { ...options };
+    if (options) {
+      this.publishOptions = { ...options };
+      this.frameRateFallback = false;
+      this.frameRateLowSamples = 0;
+    }
 
     const audio = stream.getAudioTracks()[0];
     if (audio) {
@@ -869,7 +947,7 @@ export class StreamClient {
     }
   }
 
-  /** What this project may publish. Known once joined; 720p before that. */
+  /** What this project may publish. Known once joined; 1080p before that. */
   get videoPolicy(): VideoPolicy {
     return this.joinResult?.video ?? DEFAULT_VIDEO_POLICY;
   }
@@ -896,11 +974,27 @@ export class StreamClient {
     return this.videoQuality;
   }
 
+  /** Change the camera frame rate without stopping screen, microphone or music. */
+  async setVideoFrameRate(frameRate: 30 | 60): Promise<30 | 60> {
+    if (frameRate !== 30 && frameRate !== 60) throw new RangeError('setVideoFrameRate: expected 30 or 60');
+    this.publishOptions = { ...this.publishOptions, frameRate };
+    this.frameRateFallback = false;
+    this.frameRateLowSamples = 0;
+    await this.cameraTask(async () => {
+      const current = this.cameraProducer();
+      const track = current?.track;
+      if (!current || !track || track.readyState !== 'live') return;
+      try { await track.applyConstraints?.({ frameRate: { ideal: frameRate, max: frameRate } }); }
+      catch { /* Existing capture settings decide whether 60 fps is possible. */ }
+      await this.reproduceCamera(current, track);
+    });
+    return this.cameraProducer() ? this.cameraFrameRate : this.videoPolicy.maxFrameRate === 30 ? 30 : frameRate;
+  }
+
   /**
    * Send a different video track from now on: a canvas with effects drawn on
    * it, the raw camera again, another camera. When the new track needs the
-   * same layers as the current one (the same size, or another size the
-   * project's quality scales alike), viewers see no pause, and the layers
+   * same dimensions and layers as the current one, viewers see no pause, and the layers
    * take the new picture's bitrates. Otherwise the camera producer is
    * replaced, as `setVideoQuality` does. Either way a paused camera stays
    * paused.
@@ -937,8 +1031,10 @@ export class StreamClient {
       const paused = current.paused;
       try {
         const { width = 0, height = 0 } = track.getSettings();
-        const next = videoEncodings(width, height, this.videoQuality, this.layerCount());
-        if (this.cameraEncodings && sameLayout(this.cameraEncodings, next)) {
+        const next = videoEncodings(width, height, this.videoQuality, this.layerCount(), this.frameRateFor(track));
+        const previousSize = current.track?.getSettings();
+        if (this.cameraEncodings && sameLayout(this.cameraEncodings, next) &&
+            previousSize?.width === width && previousSize?.height === height) {
           await current.replaceTrack({ track });
           await this.applyLayerBitrates(current, next);
           return;
@@ -1036,6 +1132,7 @@ export class StreamClient {
       throw new Error(`setPreferredLayers: this client is not receiving a video with producerId ${producerId}`);
     }
     const layers: PreferredLayers = temporalLayer === undefined ? { spatialLayer } : { spatialLayer, temporalLayer };
+    this.receiveQualities.delete(producerId);
     // Kept first: a reconnect that interrupts the request still applies it.
     this.preferredLayers.set(producerId, layers);
     await this.rpc('setPreferredLayers', { consumerId: consumer.id, ...layers });
@@ -1056,6 +1153,22 @@ export class StreamClient {
     return parseSendStats(report.values(), { quality: this.videoQuality, baseline, keyPrefix: prefix });
   }
 
+  /** Friendly receive ceiling using this producer's real layer sizes; auto restores adaptation. */
+  async setReceiveQuality(producerId: string, quality: ReceiveQuality): Promise<void> {
+    if (!['auto', '1080p', '720p', '480p'].includes(quality)) throw new RangeError('setReceiveQuality: unsupported quality');
+    const consumer = this.consumers.get(producerId);
+    if (!consumer || consumer.kind !== 'video') throw new Error('setReceiveQuality: this client is not receiving that video');
+    let layers: PreferredLayers;
+    if (quality === 'auto') layers = { spatialLayer: -1, temporalLayer: -1 };
+    else {
+      try { layers = { spatialLayer: receiveSpatialLayer(this.remoteVideoLayers.get(producerId) ?? [], quality) }; }
+      catch { throw new RpcError('quality-unavailable', 'this publisher does not describe its video layers; use Auto'); }
+    }
+    this.receiveQualities.set(producerId, quality);
+    this.preferredLayers.set(producerId, layers);
+    await this.rpc('setPreferredLayers', { consumerId: consumer.id, ...layers });
+  }
+
   private cameraProducer(): Producer | undefined {
     for (const p of this.producers.values()) {
       if (p.kind === 'video' && (p.appData as { source?: string }).source === 'camera') return p;
@@ -1119,7 +1232,8 @@ export class StreamClient {
     // videoEncodings).
     const { width = 0, height = 0 } = track.getSettings();
     const quality = this.videoQuality;
-    const encodings = videoEncodings(width, height, quality, this.layerCount());
+    this.cameraFrameRate = this.frameRateFor(track);
+    const encodings = videoEncodings(width, height, quality, this.layerCount(), this.cameraFrameRate);
     let codecs: RtpCodecCapability[] | undefined;
     try {
       codecs = this.device?.sendRtpCapabilities.codecs;
@@ -1134,7 +1248,7 @@ export class StreamClient {
         encodings,
         codecOptions: { videoGoogleStartBitrate: VIDEO_START_BITRATE_KBPS },
         ...(codec ? { codec } : {}),
-        appData: { source: 'camera' },
+        appData: { source: 'camera', videoLayers: describeVideoLayers(width, height, encodings, quality) },
       });
     let producer: Producer;
     try {
@@ -1150,6 +1264,8 @@ export class StreamClient {
     // quality change or a track swap under way).
     await this.keepProducer(producer, generation, 'camera');
     this.cameraEncodings = encodings;
+    this.frameRateLowSamples = 0;
+    this.frameRateWarmupSamples = 2;
     await this.pauseOnServer(producer);
     await this.applyDegradationPreference(producer);
     this.syncLimitWatch();
@@ -1233,7 +1349,7 @@ export class StreamClient {
 
   /** videoLimited sampling runs while a camera is published and someone listens. */
   private syncLimitWatch(): void {
-    this.limitWatch.set(!this.closedByUs && this.cameraProducer() !== undefined && this.listenerCount('videoLimited') > 0);
+    this.limitWatch.set(!this.closedByUs && this.cameraProducer() !== undefined && (this.listenerCount('videoLimited') > 0 || this.cameraFrameRate === 60));
   }
 
   /**
@@ -1249,6 +1365,11 @@ export class StreamClient {
     const generation = this.publishGeneration;
     // Music is not a device and cannot be "gone": publish it again whatever
     // happens to the camera and microphone below.
+    const screen = this.screenStream;
+    if (screen) await this.restoreScreen().catch(async (err) => {
+      if (this.screenStream === screen) await this.stopScreen('stopped');
+      this.emit('error', err as Error);
+    });
     if (this.music) await this.produceMusic(this.music, generation).catch((err) => this.emit('error', err as Error));
     if (generation !== this.publishGeneration) return;
 
@@ -1281,6 +1402,150 @@ export class StreamClient {
     await this.publish(stream);
   }
 
+  // ------------------------------------------------------------- screen sharing
+
+  /** Publish a screen beside the camera. Call from a click so capture permission can open. */
+  async publishScreen(options: ScreenPublishOptions = {}): Promise<MediaStream> {
+    if (this.joinResult?.role !== 'host' && this.joinResult?.role !== 'cohost') throw new RpcError('forbidden', 'only hosts and cohosts can share a screen');
+    if (this.screenStream || this.screenPending) throw new RpcError('screen-share-active', 'a screen share is already active');
+    if (options.mode !== undefined && options.mode !== 'detail' && options.mode !== 'motion') throw new TypeError('publishScreen: mode must be detail or motion');
+    const mode = options.mode ?? 'detail';
+    if (!options.stream && (typeof navigator === 'undefined' || !navigator.mediaDevices?.getDisplayMedia)) {
+      throw new RpcError('screen-share-unsupported', 'screen capture is not supported by this browser; use a supported desktop browser');
+    }
+    const generation = this.screenGeneration;
+    this.screenPending = true;
+    let stream: MediaStream | undefined;
+    try {
+      stream = options.stream ?? await navigator.mediaDevices.getDisplayMedia({
+        video: { width: { ideal: 1920, max: 1920 }, height: { ideal: 1080, max: 1080 }, frameRate: { ideal: mode === 'motion' ? 30 : 15, max: mode === 'motion' ? 30 : 15 } },
+        audio: options.audio ?? false,
+      });
+      const video = stream.getVideoTracks()[0];
+      if (!video || video.readyState !== 'live') throw new RpcError('screen-share-no-video', 'screen capture did not provide a live video track');
+      if (generation !== this.screenGeneration || this.closedByUs) throw new Error(unpublishedWhile('screen'));
+      this.screenStream = stream;
+      this.screenMode = mode;
+      this.screenAudioEnabled = options.audio !== false;
+      video.contentHint = mode;
+      const onEnded = () => { void this.stopScreen('track-ended').catch((err) => this.emit('error', err as Error)); };
+      this.screenEndedListener = onEnded;
+      video.addEventListener('ended', onEnded, { once: true });
+      await this.restoreScreen();
+      if (generation !== this.screenGeneration || video.readyState !== 'live') throw new Error(unpublishedWhile('screen'));
+      this.screenStarted = true;
+      this.wasPublishing = true;
+      this.emit('screenShareStarted', { stream, mode });
+      return stream;
+    } catch (error) {
+      if (generation === this.screenGeneration) await this.stopScreen('stopped');
+      stream?.getTracks().forEach((track) => track.stop());
+      throw error;
+    } finally {
+      if (generation === this.screenGeneration) this.screenPending = false;
+    }
+  }
+
+  /** Stop only the screen and its tab/system audio; keep camera, microphone and music. */
+  async unpublishScreen(): Promise<void> {
+    await this.stopScreen('stopped');
+  }
+
+  private releaseScreen(): void {
+    this.screenGeneration += 1;
+    this.screenPending = false;
+    const stream = this.screenStream;
+    if (this.screenEndedListener) stream?.getVideoTracks()[0]?.removeEventListener('ended', this.screenEndedListener);
+    this.screenEndedListener = null;
+    this.screenStream = null;
+    this.screenStarted = false;
+    stream?.getTracks().forEach((track) => track.stop());
+  }
+
+  private async stopScreen(reason: 'stopped' | 'track-ended'): Promise<void> {
+    const started = this.screenStarted;
+    const ids = [...this.screenProducerIds];
+    this.screenProducerIds.clear();
+    this.releaseScreen();
+    for (const id of ids) { this.producers.get(id)?.close(); this.producers.delete(id); }
+    if (!this.localStream && !this.music) this.wasPublishing = false;
+    if (started && !this.closedByUs) this.emit('screenShareEnded', { reason });
+    await Promise.all(ids.map((producerId) => this.rpc('closeProducer', { producerId }).catch(() => undefined)));
+  }
+
+  private async restoreScreen(): Promise<void> {
+    const stream = this.screenStream;
+    const video = stream?.getVideoTracks()[0];
+    if (!stream || !video) return;
+    if (video.readyState !== 'live') { await this.stopScreen('track-ended'); return; }
+    const generation = this.screenGeneration;
+    const publishing = this.publishGeneration;
+    const transport = await this.ensureSendTransport();
+    if (generation !== this.screenGeneration) return;
+    const { width = 0, height = 0 } = video.getSettings();
+    const encodings = screenEncodings(width, height, this.screenMode);
+    // A project's explicit safety restriction also applies to screen video.
+    const cap = topLayerSize(width, height, this.videoPolicy.maxQuality);
+    const screenScale = encodings.at(-1)!.scaleResolutionDownBy;
+    if (cap.scale > screenScale) encodings.forEach((e) => { e.scaleResolutionDownBy *= cap.scale / screenScale; });
+    const keep = async (producer: Producer) => {
+      if (generation !== this.screenGeneration || publishing !== this.publishGeneration || video.readyState !== 'live') {
+        producer.close();
+        await this.rpc('closeProducer', { producerId: producer.id }).catch(() => undefined);
+        throw new Error(unpublishedWhile('screen'));
+      }
+      this.producers.set(producer.id, producer);
+      this.screenProducerIds.add(producer.id);
+      await this.pauseOnServer(producer);
+    };
+    await keep(await transport.produce({
+      track: video, stopTracks: false, encodings,
+      codecOptions: { videoGoogleStartBitrate: VIDEO_START_BITRATE_KBPS },
+      appData: { source: 'screen', videoLayers: describeVideoLayers(width, height, encodings) },
+    }));
+    const audio = stream.getAudioTracks().find((track) => track.readyState === 'live');
+    if (audio && this.screenAudioEnabled && generation === this.screenGeneration) await keep(await transport.produce({
+      track: audio, stopTracks: false,
+      codecOptions: { opusStereo: true, opusDtx: false, opusFec: true, opusMaxAverageBitrate: 128000 },
+      appData: { source: 'screen-audio' },
+    }));
+  }
+
+  private frameRateFor(track: MediaStreamTrack): 30 | 60 {
+    if (this.publishOptions.frameRate !== 60 || this.frameRateFallback) return 30;
+    const captured = track.getSettings().frameRate;
+    if (this.videoPolicy.maxFrameRate === 30 || (typeof captured === 'number' && captured < 50)) {
+      this.frameRateFallback = true;
+      this.emit('error', new RpcError('frame-rate-fallback', '60 fps is unavailable from this camera or project; publishing at 30 fps'));
+      return 30;
+    }
+    return 60;
+  }
+
+  private async sampleCamera(baseline: StatsBaseline): Promise<VideoSendStats | null> {
+    const stats = await this.collectVideoStats(baseline);
+    if (this.cameraFrameRate !== 60 || this.frameRateFallback || !stats) return stats;
+    if (this.cameraProducer()?.paused) return stats;
+    // The lower simulcast copies intentionally run at 30 fps. During the
+    // initial bandwidth ramp they may be the only active copies, which does
+    // not establish that the camera cannot sustain 60. Match native warm-up:
+    // two 2-second samples, then require three consecutive limited samples.
+    if (this.frameRateWarmupSamples-- > 0) return stats;
+    const limited = stats.layers.some((layer) => layer.active && (layer.qualityLimitation === 'cpu' || layer.qualityLimitation === 'bandwidth'));
+    this.frameRateLowSamples = limited && stats.fps > 0 && stats.fps < 50 ? this.frameRateLowSamples + 1 : 0;
+    if (this.frameRateLowSamples >= 3) {
+      this.frameRateFallback = true;
+      void this.cameraTask(async () => {
+        const producer = this.cameraProducer();
+        if (!producer?.track || producer.closed) return;
+        await producer.track.applyConstraints?.({ frameRate: { ideal: 30, max: 30 } }).catch(() => undefined);
+        await this.reproduceCamera(producer, producer.track);
+        this.emit('error', new RpcError('frame-rate-fallback', 'this device or upload cannot sustain 60 fps; publishing at 30 fps'));
+      }).catch((error) => this.emit('error', error as Error));
+    }
+    return stats;
+  }
+
   // ------------------------------------------------------------------ music
 
   /**
@@ -1392,11 +1657,17 @@ export class StreamClient {
 
     const consumer = await transport.consume(params);
     this.consumers.set(remote.producerId, consumer);
+    this.remoteVideoLayers.set(remote.producerId, remote.videoLayers ?? remote.appData?.videoLayers ?? (params as { videoLayers?: VideoLayer[] }).videoLayers ?? []);
 
     // Layers asked for before a reconnect: the new consumer gets them before
     // its first frame instead of starting at the full picture. Not getting
     // them costs data, not the track, so a refusal is only reported.
-    const layers = this.preferredLayers.get(remote.producerId);
+    let layers = this.preferredLayers.get(remote.producerId);
+    const receiveQuality = this.receiveQualities.get(remote.producerId);
+    if (receiveQuality && receiveQuality !== 'auto') {
+      try { layers = { spatialLayer: receiveSpatialLayer(this.remoteVideoLayers.get(remote.producerId) ?? [], receiveQuality) }; }
+      catch { layers = undefined; this.emit('error', new RpcError('quality-unavailable', 'this publisher no longer describes its video layers; using Auto')); }
+    }
     if (layers) {
       await this.rpc('setPreferredLayers', { consumerId: consumer.id, ...layers }).catch((err) => this.emit('error', err as Error));
     }
@@ -1436,7 +1707,7 @@ export class StreamClient {
 
   private trackEnabled(kind: 'audio' | 'video'): boolean {
     for (const p of this.producers.values()) {
-      if (p.kind === kind && p.id !== this.musicProducerId) return !p.paused;
+      if (p.kind === kind && p.appData.source === defaultSource(kind)) return !p.paused;
     }
     return false;
   }
@@ -1454,24 +1725,40 @@ export class StreamClient {
     await this.setKindEnabled('video', enabled);
   }
 
+  private applyLocalModeration(kind?: 'audio' | 'video' | ''): void {
+    for (const producer of this.producers.values()) {
+      if (!kind || producer.kind === kind) producer.pause();
+    }
+    // During reconnect there are no producers, but the retained tracks still
+    // capture. Keep their muted state for republish as well.
+    for (const stream of [this.localStream, this.screenStream]) {
+      for (const track of stream?.getTracks() ?? []) if (!kind || track.kind === kind) track.enabled = false;
+    }
+    if (!kind || kind === 'audio') this.music?.setEnabled(false);
+  }
+
   private async setKindEnabled(kind: 'audio' | 'video', enabled: boolean): Promise<void> {
     for (const producer of this.producers.values()) {
       // The music has its own switch. Muting the microphone must not stop the song.
-      if (producer.kind !== kind || producer.id === this.musicProducerId) continue;
-      if (enabled) producer.resume();
-      else producer.pause();
+      if (producer.kind !== kind || producer.appData.source !== defaultSource(kind)) continue;
+      if (!enabled) producer.pause();
       await this.rpc('pauseProducer', { producerId: producer.id, paused: !enabled });
+      if (enabled) producer.resume();
     }
     this.emitLocalMedia();
   }
 
   /** Stop publishing entirely and release the local devices. */
   async unpublish(): Promise<void> {
+    void this.stopRecording().catch(error => this.emit('error', error as Error));
     // All of it takes effect now; only telling the server is waited for. So
     // publish() and unpublish() act in the order they are called: a publish
     // called while this still waits is not undone by it, and one already
     // under way stops at its next step (keepProducer).
     this.publishGeneration += 1;
+    const screenWasStarted = this.screenStarted;
+    this.releaseScreen();
+    if (screenWasStarted) this.emit('screenShareEnded', { reason: 'stopped' });
     const ids = [...this.producers.keys()];
     for (const producer of this.producers.values()) producer.close();
     this.producers.clear();
@@ -1496,14 +1783,27 @@ export class StreamClient {
     }
   }
 
+  /** Paid camera recording; project opt-in, quotas and quality are checked by the backend. */
+  async startRecording(options: RecordingOptions): Promise<void> {
+    if (this.recording) throw new Error('Recording is already active');
+    if (!this.localStream || !this.joinResult || !['host', 'cohost'].includes(this.joinResult.role)) throw new Error('Publish your camera before recording');
+    const recording = new CameraRecording(() => this.camEnabled ? this.localStream : null, () => this.token, options);
+    this.recording = recording;
+    try { await recording.start(); } catch (error) { if (this.recording === recording) this.recording = null; throw error; }
+  }
+  async stopRecording(): Promise<RecordingFile[]> {
+    const recording = this.recording; this.recording = null;
+    return recording ? recording.stop() : [];
+  }
+
   get local(): MediaStream | null {
     return this.localStream;
   }
 
   // ------------------------------------------------------------- moderation
 
-  raiseHand(): Promise<unknown> { return this.rpc('raiseHand'); }
-  lowerHand(): Promise<unknown> { return this.rpc('lowerHand'); }
+  raiseHand(metadata?: Record<string, unknown>): Promise<unknown> { return this.rpc('raiseHand', metadata ? { metadata } : {}); }
+  lowerHand(identity?: string): Promise<unknown> { return this.rpc('lowerHand', identity ? { identity } : {}); }
   muteParticipant(identity: string): Promise<unknown> { return this.rpc('requestMute', { identity }); }
   /**
    * Moderating roles: switch someone's microphone (`audio`), camera (`video`)

package/src/music.ts

@@ -22,7 +22,7 @@ export interface MusicOptions {
   monitor?: boolean;
 }
 
-export type TrackSource = 'mic' | 'music' | 'camera' | 'screen';
+export type TrackSource = 'mic' | 'music' | 'camera' | 'screen' | 'screen-audio';
 
 let shared: AudioContext | null = null;
 /** A media element can be wired to one audio graph, once, for its whole life. */