API Docs for:
Show:

Bitstream Class

Defined in: src/bitstream.js:6

Manages the packing/unpacking of values as a set number of bits

Constructor

Bitstream

(
  • buffer
)

Defined in src/bitstream.js:6

Parameters:

  • buffer Array

    an array of 7-bit integers representing the intial data for this Bitstream

Methods

_advance

(
  • bits
)
private

Defined in src/bitstream.js:425

Advance the head by the specified number of bits and check for overread

Parameters:

  • bits Number

    The number of bits to advance the index by

_extend

(
  • bits
)
private

Defined in src/bitstream.js:438

Extend the buffer size by the specified number of bits. Also advances the index

Parameters:

  • bits Number

    The number of bits to expand the buffer by

_getBits

(
  • offset
  • n
)
Number private

Defined in src/bitstream.js:103

Return the value of the first n bits starting at offset

Parameters:

  • offset Number

    The zero-based bit offset to start at

  • n Number

    The number of bits to unpack the value from

Returns:

Number:

The unsigned value after unpacking

_serializeObject

(
  • obj
  • description
)
private

Defined in src/bitstream.js:382

Calls all serialize methods in this object's prototype chain with description as its argument. This allows packing and unpacking classes which use prototypal inheritance.

Parameters:

  • obj NetObject

    The object to serialize

  • description Description

    The description to serialize through

_setBits

(
  • offset
  • n
  • value
)
private

Defined in src/bitstream.js:59

Set the n bits starting at offset to contain the unsigned integer value

Parameters:

  • offset Number

    The zero-based bit offset to start at

  • n Number

    The number of bits to pack the value in to

  • value Number

    The value to pack. Will be cast to an unsigned integer and truncated or padded to n bits

align

()

Defined in src/bitstream.js:45

Move the _index to the first position >= the current index which is the beginning of a cell. Used to burn off padding when processing data from "appendData" since it pads to the nearest multiple of CELLSIZE

appendChars

()

Defined in src/bitstream.js:186

Append UTF-8 encoded data from a string to this Bitstream

appendData

()

Defined in src/bitstream.js:173

Append data from an ArrayBuffer received over a binary websocket to this Bitstream

bitsLeft

() Number

Defined in src/bitstream.js:26

Returns:

Number:

the number of bits which can be read without causing an overread

empty

()

Defined in src/bitstream.js:35

Empty the buffer and reset the index

equals

(
  • other
)
Boolean

Defined in src/bitstream.js:404

See if the contents and byte length of the buffer of this Bitstream and other are exactly equal

Parameters:

  • other Bitstream

    The bitstream to compare with

Returns:

Boolean:

true if the bistreams are effectively equal

fromArrayBuffer

()

Defined in src/bitstream.js:163

Populate the data in this Bitstream from an ArrayBuffer received over a binary websocket

fromChars

() static

Defined in src/bitstream.js:451

Create a bitstream from a valid UTF-8 string

pack

(
  • obj
)

Defined in src/bitstream.js:354

Pack an object with a .serialize() method into this bitstream

Parameters:

  • obj NetObject

    The object to serialize

peekFloat

(
  • bits
)

Defined in src/bitstream.js:281

Read a normalized float without consuming any bits

Parameters:

  • bits Number

    The number of bits to peek at

peekSInt

(
  • bits
)

Defined in src/bitstream.js:245

Read a signed integer without consuming any bits

Parameters:

  • bits Number

    The number of bits to peek at

peekUInt

(
  • bits
)

Defined in src/bitstream.js:213

Read an unsigned integer without consuming any bits

Parameters:

  • bits Number

    The number of bits to unpack

readFloat

(
  • bits
)

Defined in src/bitstream.js:296

Read a float value, consuming the specified number of bits

Parameters:

  • bits Number

    The number of bits to unpack

readSInt

(
  • bits
)

Defined in src/bitstream.js:256

Read a signed integer consuming the specified number of bits

Parameters:

  • bits Number

    The number of bits to unpack

readString

()

Defined in src/bitstream.js:324

Read a zero-terminated string value

Returns:

the String read from the bitstream

readUInt

(
  • bits
)

Defined in src/bitstream.js:223

Read an unsigned integer consuming the specified number of bits

Parameters:

  • bits Number

    The number of bits to unpack

toArrayBuffer

()

Defined in src/bitstream.js:146

Convert the data in this Bitstream to a Uint8Array containing an ArrayBuffer suitable for transmitting this data over a binary websocket

Returns:

A Uint8Array containing the data in this Bitstream

toChars

()

Defined in src/bitstream.js:200

Convert the data to a valid UTF-8 string

unpack

(
  • obj
)

Defined in src/bitstream.js:367

Unpack an object with a .serialize() method from this bitstream

Parameters:

  • obj NetObject

    The object to deserialize to

writeFloat

(
  • value
  • bits
)

Defined in src/bitstream.js:307

Write a normalized float in the range [0.0, 1.0] using the specified number of bits

Parameters:

  • value Number

    Value to write.

  • bits Number

    The number of bits to unpack

writeSInt

(
  • value
  • bits
)

Defined in src/bitstream.js:267

write a signed integer using the specified number of bits

Parameters:

  • value Number

    Value to write. Will be truncated or padded to the specified number of bits

  • bits Number

    The number of bits to unpack

writeString

(
  • value
)

Defined in src/bitstream.js:340

Write a zero-terminated string number of bits

Parameters:

  • value String

    Value to write.

writeUInt

(
  • value
  • bits
)

Defined in src/bitstream.js:234

Write an unsigned integer using the specified number of bits

Parameters:

  • value Number

    Value to write.

  • bits Number

    The number of bits to unpack