livekit-client 2.15.4 → 2.15.6

package/src/room/track/Track.ts

@@ -37,6 +37,8 @@ export abstract class Track<
 
   source: Track.Source;
 
+  private _streamState: Track.StreamState = Track.StreamState.Active;
+
   /**
    * sid is set after track is published to server, or if it's a remote track
    */
@@ -51,7 +53,14 @@ export abstract class Track<
    * indicates current state of stream, it'll indicate `paused` if the track
    * has been paused by congestion controller
    */
-  streamState: Track.StreamState = Track.StreamState.Active;
+  get streamState(): Track.StreamState {
+    return this._streamState;
+  }
+
+  /** @internal */
+  setStreamState(value: Track.StreamState) {
+    this._streamState = value;
+  }
 
   /** @internal */
   rtpTimestamp: number | undefined;

package/src/room/types.ts

@@ -1,4 +1,5 @@
-import type { DataStream_Chunk } from '@livekit/protocol';
+import type { DataStream_Chunk, Encryption_Type } from '@livekit/protocol';
+import type { Future } from './utils';
 
 export type SimulationOptions = {
   publish?: {
@@ -35,6 +36,24 @@ export interface StreamTextOptions {
   attributes?: Record<string, string>;
 }
 
+export type StreamBytesOptions = {
+  name?: string;
+  topic?: string;
+  attributes?: Record<string, string>;
+  destinationIdentities?: Array<string>;
+  streamId?: string;
+  mimeType?: string;
+  totalSize?: number;
+};
+
+export type SendFileOptions = Pick<
+  StreamBytesOptions,
+  'topic' | 'mimeType' | 'destinationIdentities'
+> & {
+  onProgress?: (progress: number) => void;
+  encryptionType?: Encryption_Type.NONE;
+};
+
 export type DataPublishOptions = {
   /**
    * whether to send this as reliable or lossy.
@@ -105,6 +124,8 @@ export interface StreamController<T extends DataStream_Chunk> {
   controller: ReadableStreamDefaultController<T>;
   startTime: number;
   endTime?: number;
+  sendingParticipantIdentity: string;
+  outOfBandFailureRejectingFuture: Future<never>;
 }
 
 export interface BaseStreamInfo {

package/src/room/utils.ts

@@ -64,8 +64,9 @@ export function supportsAV1(): boolean {
   if (!('getCapabilities' in RTCRtpSender)) {
     return false;
   }
-  if (isSafari()) {
+  if (isSafari() || isFireFox()) {
     // Safari 17 on iPhone14 reports AV1 capability, but does not actually support it
+    // Firefox does support AV1, but SVC publishing is not supported
     return false;
   }
   const capabilities = RTCRtpSender.getCapabilities('video');
@@ -214,12 +215,12 @@ export function isE2EESimulcastSupported() {
     } else if (
       browser.os === 'iOS' &&
       browser.osVersion &&
-      compareVersions(supportedSafariVersion, browser.osVersion) >= 0
+      compareVersions(browser.osVersion, supportedSafariVersion) >= 0
     ) {
       return true;
     } else if (
       browser.name === 'Safari' &&
-      compareVersions(supportedSafariVersion, browser.version) >= 0
+      compareVersions(browser.version, supportedSafariVersion) >= 0
     ) {
       return true;
     } else {
@@ -282,6 +283,14 @@ export function getDevicePixelRatio(): number {
   return 1;
 }
 
+/**
+ * @param v1 - The first version string to compare.
+ * @param v2 - The second version string to compare.
+ * @returns A number indicating the order of the versions:
+ *   - 1 if v1 is greater than v2
+ *   - -1 if v1 is less than v2
+ *   - 0 if v1 and v2 are equal
+ */
 export function compareVersions(v1: string, v2: string): number {
   const parts1 = v1.split('.');
   const parts2 = v2.split('.');
@@ -538,13 +547,13 @@ export function unwrapConstraint(constraint: ConstrainDOMString | ConstrainULong
   if (Array.isArray(constraint)) {
     return constraint[0];
   }
-  if (constraint.exact) {
+  if (constraint.exact !== undefined) {
     if (Array.isArray(constraint.exact)) {
       return constraint.exact[0];
     }
     return constraint.exact;
   }
-  if (constraint.ideal) {
+  if (constraint.ideal !== undefined) {
     if (Array.isArray(constraint.ideal)) {
       return constraint.ideal[0];
     }

package/dist/src/e2ee/worker/SifGuard.d.ts

@@ -1,11 +0,0 @@
-export declare class SifGuard {
-    private consecutiveSifCount;
-    private sifSequenceStartedAt;
-    private lastSifReceivedAt;
-    private userFramesSinceSif;
-    recordSif(): void;
-    recordUserFrame(): void;
-    isSifAllowed(): boolean;
-    reset(): void;
-}
-//# sourceMappingURL=SifGuard.d.ts.map

package/dist/src/e2ee/worker/SifGuard.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SifGuard.d.ts","sourceRoot":"","sources":["../../../../src/e2ee/worker/SifGuard.ts"],"names":[],"mappings":"AAEA,qBAAa,QAAQ;IACnB,OAAO,CAAC,mBAAmB,CAAK;IAEhC,OAAO,CAAC,oBAAoB,CAAqB;IAEjD,OAAO,CAAC,iBAAiB,CAAa;IAEtC,OAAO,CAAC,kBAAkB,CAAa;IAEvC,SAAS;IAMT,eAAe;IAgBf,YAAY;IAQZ,KAAK;CAKN"}

package/dist/src/room/StreamReader.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StreamReader.d.ts","sourceRoot":"","sources":["../../../src/room/StreamReader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAG9E,uBAAe,gBAAgB,CAAC,CAAC,SAAS,cAAc;IACtD,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAEnD,SAAS,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEjC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;IAEnB,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC;IAEhC,IAAI,IAAI,MAEP;gBAEW,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,gBAAgB,CAAC,EAAE,aAAa,CAAC,EAAE,MAAM;IAOrF,SAAS,CAAC,QAAQ,CAAC,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,GAAG,IAAI;IAErE,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;IAEpD,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;CACxD;AAED,qBAAa,gBAAiB,SAAQ,gBAAgB,CAAC,cAAc,CAAC;IACpE,SAAS,CAAC,mBAAmB,CAAC,KAAK,EAAE,gBAAgB;IAQrD,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;IAEpD,CAAC,MAAM,CAAC,aAAa,CAAC;oBAIF,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;kBAenC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;;IAOjD,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;CAO5C;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,gBAAgB,CAAC,cAAc,CAAC;IACpE,OAAO,CAAC,cAAc,CAAgC;IAEtD;;;OAGG;gBAED,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,cAAc,CAAC,gBAAgB,CAAC,EACxC,eAAe,CAAC,EAAE,MAAM;IAM1B,SAAS,CAAC,mBAAmB,CAAC,KAAK,EAAE,gBAAgB;IAerD;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;IAEpD;;;;OAIG;IACH,CAAC,MAAM,CAAC,aAAa,CAAC;oBAKF,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;kBAmB/B,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;;IAO7C,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;CAOjC;AAED,MAAM,MAAM,iBAAiB,GAAG,CAC9B,MAAM,EAAE,gBAAgB,EACxB,eAAe,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,KAClC,IAAI,CAAC;AAEV,MAAM,MAAM,iBAAiB,GAAG,CAC9B,MAAM,EAAE,gBAAgB,EACxB,eAAe,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,KAClC,IAAI,CAAC"}

package/dist/src/room/StreamWriter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StreamWriter.d.ts","sourceRoot":"","sources":["../../../src/room/StreamWriter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9E,cAAM,gBAAgB,CAAC,CAAC,EAAE,QAAQ,SAAS,cAAc;IACvD,SAAS,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IAE5C,SAAS,CAAC,aAAa,EAAE,2BAA2B,CAAC,CAAC,CAAC,CAAC;IAExD,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAE/B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;gBAEZ,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,MAAM,IAAI;IAOnF,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxB,KAAK;CAKZ;AAED,qBAAa,gBAAiB,SAAQ,gBAAgB,CAAC,MAAM,EAAE,cAAc,CAAC;CAAG;AAEjF,qBAAa,gBAAiB,SAAQ,gBAAgB,CAAC,UAAU,EAAE,cAAc,CAAC;CAAG"}

package/dist/ts4.2/src/e2ee/worker/SifGuard.d.ts

@@ -1,11 +0,0 @@
-export declare class SifGuard {
-    private consecutiveSifCount;
-    private sifSequenceStartedAt;
-    private lastSifReceivedAt;
-    private userFramesSinceSif;
-    recordSif(): void;
-    recordUserFrame(): void;
-    isSifAllowed(): boolean;
-    reset(): void;
-}
-//# sourceMappingURL=SifGuard.d.ts.map

package/src/e2ee/worker/SifGuard.ts

@@ -1,47 +0,0 @@
-import { MAX_SIF_COUNT, MAX_SIF_DURATION } from '../constants';
-
-export class SifGuard {
-  private consecutiveSifCount = 0;
-
-  private sifSequenceStartedAt: number | undefined;
-
-  private lastSifReceivedAt: number = 0;
-
-  private userFramesSinceSif: number = 0;
-
-  recordSif() {
-    this.consecutiveSifCount += 1;
-    this.sifSequenceStartedAt ??= Date.now();
-    this.lastSifReceivedAt = Date.now();
-  }
-
-  recordUserFrame() {
-    if (this.sifSequenceStartedAt === undefined) {
-      return;
-    } else {
-      this.userFramesSinceSif += 1;
-    }
-    if (
-      // reset if we received more user frames than SIFs
-      this.userFramesSinceSif > this.consecutiveSifCount ||
-      // also reset if we got a new user frame and the latest SIF frame hasn't been updated in a while
-      Date.now() - this.lastSifReceivedAt > MAX_SIF_DURATION
-    ) {
-      this.reset();
-    }
-  }
-
-  isSifAllowed() {
-    return (
-      this.consecutiveSifCount < MAX_SIF_COUNT &&
-      (this.sifSequenceStartedAt === undefined ||
-        Date.now() - this.sifSequenceStartedAt < MAX_SIF_DURATION)
-    );
-  }
-
-  reset() {
-    this.userFramesSinceSif = 0;
-    this.consecutiveSifCount = 0;
-    this.sifSequenceStartedAt = undefined;
-  }
-}

package/src/room/StreamReader.ts

@@ -1,170 +0,0 @@
-import type { DataStream_Chunk } from '@livekit/protocol';
-import type { BaseStreamInfo, ByteStreamInfo, TextStreamInfo } from './types';
-import { bigIntToNumber } from './utils';
-
-abstract class BaseStreamReader<T extends BaseStreamInfo> {
-  protected reader: ReadableStream<DataStream_Chunk>;
-
-  protected totalByteSize?: number;
-
-  protected _info: T;
-
-  protected bytesReceived: number;
-
-  get info() {
-    return this._info;
-  }
-
-  constructor(info: T, stream: ReadableStream<DataStream_Chunk>, totalByteSize?: number) {
-    this.reader = stream;
-    this.totalByteSize = totalByteSize;
-    this._info = info;
-    this.bytesReceived = 0;
-  }
-
-  protected abstract handleChunkReceived(chunk: DataStream_Chunk): void;
-
-  onProgress?: (progress: number | undefined) => void;
-
-  abstract readAll(): Promise<string | Array<Uint8Array>>;
-}
-
-export class ByteStreamReader extends BaseStreamReader<ByteStreamInfo> {
-  protected handleChunkReceived(chunk: DataStream_Chunk) {
-    this.bytesReceived += chunk.content.byteLength;
-    const currentProgress = this.totalByteSize
-      ? this.bytesReceived / this.totalByteSize
-      : undefined;
-    this.onProgress?.(currentProgress);
-  }
-
-  onProgress?: (progress: number | undefined) => void;
-
-  [Symbol.asyncIterator]() {
-    const reader = this.reader.getReader();
-
-    return {
-      next: async (): Promise<IteratorResult<Uint8Array>> => {
-        try {
-          const { done, value } = await reader.read();
-          if (done) {
-            return { done: true, value: undefined as any };
-          } else {
-            this.handleChunkReceived(value);
-            return { done: false, value: value.content };
-          }
-        } catch (error) {
-          // TODO handle errors
-          return { done: true, value: undefined };
-        }
-      },
-
-      async return(): Promise<IteratorResult<Uint8Array>> {
-        reader.releaseLock();
-        return { done: true, value: undefined };
-      },
-    };
-  }
-
-  async readAll(): Promise<Array<Uint8Array>> {
-    let chunks: Set<Uint8Array> = new Set();
-    for await (const chunk of this) {
-      chunks.add(chunk);
-    }
-    return Array.from(chunks);
-  }
-}
-
-/**
- * A class to read chunks from a ReadableStream and provide them in a structured format.
- */
-export class TextStreamReader extends BaseStreamReader<TextStreamInfo> {
-  private receivedChunks: Map<number, DataStream_Chunk>;
-
-  /**
-   * A TextStreamReader instance can be used as an AsyncIterator that returns the entire string
-   * that has been received up to the current point in time.
-   */
-  constructor(
-    info: TextStreamInfo,
-    stream: ReadableStream<DataStream_Chunk>,
-    totalChunkCount?: number,
-  ) {
-    super(info, stream, totalChunkCount);
-    this.receivedChunks = new Map();
-  }
-
-  protected handleChunkReceived(chunk: DataStream_Chunk) {
-    const index = bigIntToNumber(chunk.chunkIndex);
-    const previousChunkAtIndex = this.receivedChunks.get(index);
-    if (previousChunkAtIndex && previousChunkAtIndex.version > chunk.version) {
-      // we have a newer version already, dropping the old one
-      return;
-    }
-    this.receivedChunks.set(index, chunk);
-    this.bytesReceived += chunk.content.byteLength;
-    const currentProgress = this.totalByteSize
-      ? this.bytesReceived / this.totalByteSize
-      : undefined;
-    this.onProgress?.(currentProgress);
-  }
-
-  /**
-   * @param progress - progress of the stream between 0 and 1. Undefined for streams of unknown size
-   */
-  onProgress?: (progress: number | undefined) => void;
-
-  /**
-   * Async iterator implementation to allow usage of `for await...of` syntax.
-   * Yields structured chunks from the stream.
-   *
-   */
-  [Symbol.asyncIterator]() {
-    const reader = this.reader.getReader();
-    const decoder = new TextDecoder();
-
-    return {
-      next: async (): Promise<IteratorResult<string>> => {
-        try {
-          const { done, value } = await reader.read();
-          if (done) {
-            return { done: true, value: undefined };
-          } else {
-            this.handleChunkReceived(value);
-
-            return {
-              done: false,
-              value: decoder.decode(value.content),
-            };
-          }
-        } catch (error) {
-          // TODO handle errors
-          return { done: true, value: undefined };
-        }
-      },
-
-      async return(): Promise<IteratorResult<string>> {
-        reader.releaseLock();
-        return { done: true, value: undefined };
-      },
-    };
-  }
-
-  async readAll(): Promise<string> {
-    let finalString: string = '';
-    for await (const chunk of this) {
-      finalString += chunk;
-    }
-    return finalString;
-  }
-}
-
-export type ByteStreamHandler = (
-  reader: ByteStreamReader,
-  participantInfo: { identity: string },
-) => void;
-
-export type TextStreamHandler = (
-  reader: TextStreamReader,
-  participantInfo: { identity: string },
-) => void;