LiveKit JS Client SDK - v2.22.2
    Preparing search index...

    Class ByteStreamReader

    Hierarchy

    Index
    onProgress?: (progress: number | undefined) => void

    Type Declaration

      • (progress: number | undefined): void
      • Parameters

        • progress: number | undefined

          progress of the stream between 0 and 1. Undefined for streams of unknown size

        Returns void

    signal?: AbortSignal
    • Returns {
          next: () => Promise<IteratorResult<Uint8Array<ArrayBufferLike>, any>>;
          return(): Promise<IteratorResult<Uint8Array<ArrayBufferLike>, any>>;
      }

    • Injects an AbortSignal, which if aborted, will terminate the currently active stream iteration operation.

      Note that when using AbortSignal.timeout(...), the timeout applies across the whole iteration operation, not just one individual chunk read.

      Parameters

      • signal: AbortSignal

      Returns ByteStreamReader