Class ByteStreamReader

A class to read chunks from a ReadableStream and provide them in a structured format.

Hierarchy

BaseStreamReader<ByteStreamInfo>
- ByteStreamReader

Index

Constructors

Properties

_info bytesReceived onProgress? reader totalByteSize?

Accessors

Methods

[asyncIterator] handleChunkReceived readAll

Constructors

constructor

new ByteStreamReader(
    info: ByteStreamInfo,
    stream: ReadableStream<DataStream_Chunk>,
    totalByteSize?: number,
): ByteStreamReader
Parameters
- info: ByteStreamInfo
- stream: ReadableStream<DataStream_Chunk>
- OptionaltotalByteSize: number
Returns ByteStreamReader
Inherited from BaseStreamReader<ByteStreamInfo>.constructor
- Defined in packages/livekit-rtc/src/data_streams/stream_reader.ts:22

Properties

`Protected`_info

_info: ByteStreamInfo

`Protected`bytesReceived

bytesReceived: number

`Optional`onProgress

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

`Protected`reader

reader: ReadableStream<DataStream_Chunk>

`Protected` `Optional`totalByteSize

totalByteSize?: number

Accessors

info

get info(): T
Returns T
Inherited from BaseStreamReader.info
- Defined in packages/livekit-rtc/src/data_streams/stream_reader.ts:18

Methods

[asyncIterator]

"[asyncIterator]"(): {
next: () => Promise<IteratorResult<Uint8Array<ArrayBufferLike>, any>>;
return(): IteratorResult<Uint8Array<ArrayBufferLike>>;
}
Returns {
next: () => Promise<IteratorResult<Uint8Array<ArrayBufferLike>, any>>;
return(): IteratorResult<Uint8Array<ArrayBufferLike>>;
}
- Defined in packages/livekit-rtc/src/data_streams/stream_reader.ts:48

`Protected`handleChunkReceived

handleChunkReceived(chunk: DataStream_Chunk): void
Parameters
- chunk: DataStream_Chunk
Returns void
Overrides BaseStreamReader.handleChunkReceived
- Defined in packages/livekit-rtc/src/data_streams/stream_reader.ts:40

readAll

readAll(): Promise<Uint8Array<ArrayBufferLike>[]>
Returns Promise<Uint8Array<ArrayBufferLike>[]>
Overrides BaseStreamReader.readAll
- Defined in packages/livekit-rtc/src/data_streams/stream_reader.ts:74