Class: IsoBoxReadView

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:26

ISO BMFF data view. Similar to DataView, but with additional methods for reading ISO BMFF data. It implements the iterator protocol, so it can be used in a for...of loop.

Constructors

Constructor

new IsoBoxReadView(raw, config?): IsoBoxReadView;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:40

Creates a new IsoView instance. Similar to DataView, but with additional methods for reading ISO BMFF data. It implements the iterator protocol, so it can be used in a for...of loop.

Parameters

raw

IsoBoxData

The raw data to view.

config?

IsoBoxReadViewConfig

The configuration for the IsoView.

Returns

IsoBoxReadView

Accessors

buffer

Get Signature

get buffer(): ArrayBufferLike;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:53

The buffer of the data view.

Returns

ArrayBufferLike

---

byteLength

Get Signature

get byteLength(): number;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:67

The byte length of the data view.

Returns

number

---

byteOffset

Get Signature

get byteOffset(): number;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:60

The byte offset of the data view.

Returns

number

---

bytesRemaining

Get Signature

get bytesRemaining(): number;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:88

The number of bytes remaining in the data view.

Returns

number

---

cursor

Get Signature

get cursor(): number;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:74

The current byteoffset in the data view.

Returns

number

---

done

Get Signature

get done(): boolean;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:81

Whether the end of the data view has been reached.

Returns

boolean

Methods

[iterator]()

[iterator](): Generator<ParsedIsoBox>;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:349

Iterates over the boxes in the data view.

Returns

Generator<ParsedIsoBox>

A generator of boxes.

---

jump()

jump(size): void;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:265

Skips a number of bytes in the view.

Parameters

size

number

The number of bytes to skip.

Returns

void

---

readArray()

readArray<T>(
   type, 
   size, 
   length
): IsoFieldTypeMap[T][];

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:246

Reads an array of values from the data view.

Type Parameters

T

T extends keyof IsoFieldTypeMap

Parameters

type

T

The type of the values.

size

number

The size of the values in bytes.

length

number

The number of values to read.

Returns

IsoFieldTypeMap[T][]

The array of values.

---

readBox()

readBox(): ParsedBox;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:274

Reads a raw box from the data view.

Returns

ParsedBox

The box.

---

readBoxes()

readBoxes<T>(length?): T[];

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:313

Reads a number of boxes from the data view.

Type Parameters

T

T = IsoBox

Parameters

length?

number = -1

The number of boxes to read.

Returns

T[]

The boxes.

---

readData()

readData(size): Uint8Array;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:212

Reads a byte array from the data view.

Parameters

size

number

The size of the data in bytes.

Returns

Uint8Array

The data.

---

readEntries()

readEntries<T>(length, map): T[];

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:334

Reads a number of entries from the data view.

Type Parameters

T

T

Parameters

length

number

The number of entries to read.

map

() => T

The function to map the entries.

Returns

T[]

The entries.

---

readFullBox()

readFullBox(): FullBox;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:231

Reads a full box from the data view.

Returns

FullBox

The full box.

---

readInt()

readInt(size): number;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:182

Reads a signed integer from the data view.

Parameters

size

number

The size of the integer in bytes.

Returns

number

The signed integer.

---

readString()

readString(size): string;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:192

Reads a string from the data view.

Parameters

size

number

The size of the string in bytes.

Returns

string

The string.

---

readTemplate()

readTemplate(size): number;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:202

Reads a template from the data view.

Parameters

size

number

The size of the template in bytes.

Returns

number

The template.

---

readUint()

readUint(size): number;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:172

Reads a unsigned integer from the data view.

Parameters

size

number

The size of the integer in bytes.

Returns

number

The unsigned integer.

---

readUtf8()

readUtf8(size?): string;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:222

Reads a UTF-8 string from the data view.

Parameters

size?

number

The size of the string in bytes.

Returns

string

The UTF-8 string.

---

slice()

slice(offset, size): IsoBoxReadView;

Defined in: libs/iso-bmff/src/IsoBoxReadView.ts:98

Creates a new IsoView instance with a slice of the current data view.

Parameters

offset

number

size

number

The size of the slice.

Returns

IsoBoxReadView

A new IsoView instance.