Class: IsoBoxReadableStream

Defined in: libs/iso-bmff/src/IsoBoxReadableStream.ts:27

A readable stream of ISO BMFF boxes as Uint8Arrays.

Extends

• ReadableStreamBase<Uint8Array>

Constructors

Constructor

new IsoBoxReadableStream(boxes, config): IsoBoxReadableStream;

Defined in: libs/iso-bmff/src/IsoBoxReadableStream.ts:34

Constructs a new IsoBoxReadableStream.

Parameters

boxes

Iterable<IsoBoxStreamable>

The boxes to stream.

config

IsoBoxWriteViewConfig

The configuration for the stream.

Returns

IsoBoxReadableStream

Overrides

ReadableStreamBase<Uint8Array>.constructor

Properties

locked

readonly locked: boolean;

Defined in: node_modules/typescript/lib/lib.dom.d.ts:30248

The locked read-only property of the ReadableStream interface returns whether or not the readable stream is locked to a reader.

MDN Reference

Inherited from

ReadableStreamBase.locked

Methods

[asyncIterator]()

[asyncIterator](options?): ReadableStreamAsyncIterator<Uint8Array<ArrayBufferLike>>;

Defined in: node_modules/typescript/lib/lib.dom.d.ts:45123

Parameters

options?

ReadableStreamIteratorOptions

Returns

ReadableStreamAsyncIterator<Uint8Array<ArrayBufferLike>>

Inherited from

ReadableStreamBase.[asyncIterator]

---

cancel()

cancel(reason?): Promise<void>;

Defined in: node_modules/typescript/lib/lib.dom.d.ts:30254

The cancel() method of the ReadableStream interface returns a Promise that resolves when the stream is canceled.

MDN Reference

Parameters

reason?

any

Returns

Promise<void>

Inherited from

ReadableStreamBase.cancel

---

getReader()

Call Signature

getReader(options): ReadableStreamBYOBReader;

Defined in: node_modules/typescript/lib/lib.dom.d.ts:30260

The getReader() method of the ReadableStream interface creates a reader and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.

MDN Reference

Parameters

options

mode

"byob"

Returns

ReadableStreamBYOBReader

Inherited from

ReadableStreamBase.getReader

Call Signature

getReader(): ReadableStreamDefaultReader<Uint8Array<ArrayBufferLike>>;

Defined in: node_modules/typescript/lib/lib.dom.d.ts:30261

Returns

ReadableStreamDefaultReader<Uint8Array<ArrayBufferLike>>

Inherited from

ReadableStreamBase.getReader

Call Signature

getReader(options?): ReadableStreamReader<Uint8Array<ArrayBufferLike>>;

Defined in: node_modules/typescript/lib/lib.dom.d.ts:30262

Parameters

options?

ReadableStreamGetReaderOptions

Returns

ReadableStreamReader<Uint8Array<ArrayBufferLike>>

Inherited from

ReadableStreamBase.getReader

---

pipeThrough()

pipeThrough<T>(transform, options?): ReadableStream<T>;

Defined in: node_modules/typescript/lib/lib.dom.d.ts:30268

The pipeThrough() method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair.

MDN Reference

Type Parameters

T

T

Parameters

transform

ReadableWritablePair<T, Uint8Array<ArrayBufferLike>>

options?

StreamPipeOptions

Returns

ReadableStream<T>

Inherited from

ReadableStreamBase.pipeThrough

---

pipeTo()

pipeTo(destination, options?): Promise<void>;

Defined in: node_modules/typescript/lib/lib.dom.d.ts:30274

The pipeTo() method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.

MDN Reference

Parameters

destination

WritableStream<Uint8Array<ArrayBufferLike>>

options?

StreamPipeOptions

Returns

Promise<void>

Inherited from

ReadableStreamBase.pipeTo

---

tee()

tee(): [ReadableStream<Uint8Array<ArrayBufferLike>>, ReadableStream<Uint8Array<ArrayBufferLike>>];

Defined in: node_modules/typescript/lib/lib.dom.d.ts:30280

The tee() method of the ReadableStream interface tees the current readable stream, returning a two-element array containing the two resulting branches as new ReadableStream instances.

MDN Reference

Returns

[ReadableStream<Uint8Array<ArrayBufferLike>>, ReadableStream<Uint8Array<ArrayBufferLike>>]

Inherited from

ReadableStreamBase.tee

---

values()

values(options?): ReadableStreamAsyncIterator<Uint8Array<ArrayBufferLike>>;

Defined in: node_modules/typescript/lib/lib.dom.d.ts:45124

Parameters

options?

ReadableStreamIteratorOptions

Returns

ReadableStreamAsyncIterator<Uint8Array<ArrayBufferLike>>

Inherited from

ReadableStreamBase.values