Skip to content

Function: traverseIsoBoxes() ​

ts
function traverseIsoBoxes<T>(boxes, config?): Generator<T>;

Defined in: libs/iso-bmff/src/traverseIsoBoxes.ts:18

Traverse ISO boxes

Type Parameters ​

T ​

T

Parameters ​

boxes ​

Iterable<T>

The boxes to traverse

config? ​

TraverseIsoBoxesConfig

Configuration options for traversal

Returns ​

Generator<T>

A generator of boxes

Example ​

ts
const isoFile = await readFile(new URL('./fixtures/captions.mp4', import.meta.url))
const boxes = readIsoBoxes(new Uint8Array(isoFile))

for (const box of traverseIsoBoxes(boxes)) {
	equal(box.type, 'ftyp')
	break
}

A Streaming Video Technology Alliance project.