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

    Class ByteStreamReader

    Hierarchy

    • BaseStreamReader<ByteStreamInfo>
      • ByteStreamReader
    Index

    Constructors

    • Parameters

      • info: ByteStreamInfo
      • stream: ReadableStream<DataStream_Chunk>
      • OptionaltotalByteSize: number
      • OptionaloutOfBandFailureRejectingFuture: Future<never>

      Returns ByteStreamReader

    Properties

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

    Accessors

    Methods

    • 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