Class: DataStream

Members

---

byteLength

The size of the data view in bytes.

---

bytesAvailable

The amount of bytes still left in the file until EOF.

Methods

---

getChar()

Reads a single 8-bit string character from the stream.

---

getFloat16()

Reads a half float.

---

getFloat16Array(len)

Reads an array of half floats.

Parameters:

Name	Type	Description
len		The amount of elements to read.

---

getFloat32()

Reads a single float.

---

getFloat32Array(len)

Reads an array of single floats.

Parameters:

Name	Type	Description
len		The amount of elements to read.

---

getFloat64()

Reads a double float.

---

getFloat64Array(len)

Reads an array of double floats.

Parameters:

Name	Type	Description
len		The amount of elements to read.

---

getInt8()

Reads a single signed byte integer from the string.

---

getInt8Array(len)

Reads an array of signed bytes.

Parameters:

Name	Type	Description
len		The amount of elements to read.

---

getInt16()

Reads a single signed short integer from the string.

---

getInt16Array(len)

Reads an array of signed shorts.

Parameters:

Name	Type	Description
len		The amount of elements to read.

---

getInt32()

Reads a single 32 bit integer from the string.

---

getInt32Array(len)

Reads an array of signed 32-bit integers.

Parameters:

Name	Type	Description
len		The amount of elements to read.

---

getInt64AsFloat64()

Reads a 64-bit integer and stores it in a Number. The read value is not necessarily the same as what's stored, but may provide an acceptable approximation.

---

getInt64AsFloat64Array(len)

Reads an array of 64-bit integers into floats.

Parameters:

Name	Type	Description
len		The amount of elements to read.

---

getString( [len])

Reads a string.

Parameters:

Name	Type	Argument	Description
len		<optional>	The amount of characters in the string. If omitted, it reads until (and including) it encounters a "\0" character.

---

getUint8()

Reads a single unsigned byte integer from the string.

---

getUint8Array(len)

Reads an array of unsigned bytes.

Parameters:

Name	Type	Description
len		The amount of elements to read.

---

getUint16()

Reads a single unsigned short integer from the string.

---

getUint16Array(len)

Reads an array of unsigned shorts.

Parameters:

Name	Type	Description
len		The amount of elements to read.

---

getUint32()

Reads a single unsigned 32-bit integer from the string.

---

getUint32Array(len)

Reads an array of unsigned 32-bit integers.

Parameters:

Name	Type	Description
len		The amount of elements to read.

---

skipAlign()

Skips the offset into the buffer so it becomes aligned with the bytes. This allows reading data as a typed array more efficiently.