Class BitStream

Hierarchy

BitStream

Constructors

constructor

new BitStream(view: ArrayBuffer | Buffer | BitView, byteOffset?: number, byteLength?: number): BitStream
Parameters
- view: ArrayBuffer | Buffer | BitView
- Optional byteOffset: number
- Optional byteLength: number
Returns BitStream
- Defined in typings/bit-buffer.d.ts:65

Properties

`Readonly` bitsLeft

bitsLeft: number

The number of bits left in the stream

byteIndex

byteIndex: number

Get/set the current index in bytes

index

index: number

Get/set the current index in bits

`Readonly` length

length: number

Get the length of the stream in bits

`Readonly` view

Underlying BitView

`Static` from

from: ((array: Uint8Array) => BitStream)

Type declaration

- (array: Uint8Array): BitStream
- Parameters
  - array: Uint8Array
  Returns BitStream

Methods

readASCIIString

readASCIIString(maxLength?: number): string
Parameters
- Optional maxLength: number
Returns string
- Defined in typings/bit-buffer.d.ts:90

readArrayBuffer

readArrayBuffer(length: number): ArrayBuffer
Parameters
- length: number
Returns ArrayBuffer
- Defined in typings/bit-buffer.d.ts:95

readBitCellCoordIntegral

readBitCellCoordIntegral(bits: number): number
Parameters
- bits: number
Returns number
- Defined in src/ext/bitbuffer.ts:37

readBitCellCoordLowPrecision

readBitCellCoordLowPrecision(bits: number): number
Parameters
- bits: number
Returns number
- Defined in src/ext/bitbuffer.ts:36

readBitCellCoordNone

readBitCellCoordNone(bits: number): number
Parameters
- bits: number
Returns number
- Defined in src/ext/bitbuffer.ts:35

readBitCoord

readBitCoord(): number
Returns number
- Defined in src/ext/bitbuffer.ts:30

readBitCoordMPIntegral

readBitCoordMPIntegral(): number
Returns number
- Defined in src/ext/bitbuffer.ts:33

readBitCoordMPLowPrecision

readBitCoordMPLowPrecision(): number
Returns number
- Defined in src/ext/bitbuffer.ts:32

readBitCoordMPNone

readBitCoordMPNone(): number
Returns number
- Defined in src/ext/bitbuffer.ts:31

readBitNormal

readBitNormal(): number
Returns number
- Defined in src/ext/bitbuffer.ts:34

readBitStream

readBitStream(length: number): BitStream
Parameters
- length: number
Returns BitStream
- Defined in typings/bit-buffer.d.ts:94

readBits

readBits(bits: number, signed: boolean): number
Parameters
- bits: number
- signed: boolean
Returns number
- Defined in typings/bit-buffer.d.ts:70

readBoolean

readBoolean(): boolean
Returns boolean
- Defined in typings/bit-buffer.d.ts:88

readBytes

readBytes(bytes: number): Buffer
Parameters
- bytes: number
Returns Buffer
- Defined in src/ext/bitbuffer.ts:25

readCString

readCString(): string
Returns string
- Defined in src/ext/bitbuffer.ts:39

readFloat32

readFloat32(): number
Returns number
- Defined in typings/bit-buffer.d.ts:84

readFloat64

readFloat64(): number
Returns number
- Defined in typings/bit-buffer.d.ts:85

readInt16

readInt16(): number
Returns number
- Defined in typings/bit-buffer.d.ts:76

readInt32

readInt32(): number
Returns number
- Defined in typings/bit-buffer.d.ts:77

readInt8

readInt8(): number
Returns number
- Defined in typings/bit-buffer.d.ts:75

readOneBit

readOneBit(): boolean
Returns boolean
- Defined in src/ext/bitbuffer.ts:26

readSBits

readSBits(bits: number): number
Parameters
- bits: number
Returns number
- Defined in src/ext/bitbuffer.ts:28

readString

readString(bytes: number): string
Parameters
- bytes: number
Returns string
- Defined in src/ext/bitbuffer.ts:24

readUBitVar

readUBitVar(): number
Returns number
- Defined in src/ext/bitbuffer.ts:29

readUBits

readUBits(bits: number): number
Parameters
- bits: number
Returns number
- Defined in src/ext/bitbuffer.ts:27

readUInt16

readUInt16(): number
Returns number
- Defined in src/ext/bitbuffer.ts:41

readUInt32

readUInt32(): number
Returns number
- Defined in src/ext/bitbuffer.ts:42

readUInt8

readUInt8(): number
Returns number
- Defined in src/ext/bitbuffer.ts:40

readUTF8String

readUTF8String(maxLength?: number): string
Parameters
- Optional maxLength: number
Returns string
- Defined in typings/bit-buffer.d.ts:91

readUVarInt32

readUVarInt32(): number
Returns number
- Defined in src/ext/bitbuffer.ts:43

readUint16

readUint16(): number
Returns number
- Defined in typings/bit-buffer.d.ts:73

readUint32

readUint32(): number
Returns number
- Defined in typings/bit-buffer.d.ts:74

readUint8

readUint8(): number
Returns number
- Defined in typings/bit-buffer.d.ts:72

readVarInt32

readVarInt32(): number
Returns number
- Defined in src/ext/bitbuffer.ts:44

writeASCIIString

writeASCIIString(str: string, maxLength?: number): string
Parameters
- str: string
- Optional maxLength: number
Returns string
- Defined in typings/bit-buffer.d.ts:92

writeBits

writeBits(value: number, bits: number): void
Parameters
- value: number
- bits: number
Returns void
- Defined in typings/bit-buffer.d.ts:71

writeBoolean

writeBoolean(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in typings/bit-buffer.d.ts:89

writeFloat32

writeFloat32(value: number): void
Parameters
- value: number
Returns void
- Defined in typings/bit-buffer.d.ts:86

writeFloat64

writeFloat64(value: number): void
Parameters
- value: number
Returns void
- Defined in typings/bit-buffer.d.ts:87

writeInt16

writeInt16(value: number): void
Parameters
- value: number
Returns void
- Defined in typings/bit-buffer.d.ts:82

writeInt32

writeInt32(value: number): void
Parameters
- value: number
Returns void
- Defined in typings/bit-buffer.d.ts:83

writeInt8

writeInt8(value: number): void
Parameters
- value: number
Returns void
- Defined in typings/bit-buffer.d.ts:81

writeUInt16

writeUInt16(value: number): void
Parameters
- value: number
Returns void
- Defined in src/ext/bitbuffer.ts:46

writeUInt32

writeUInt32(value: number): void
Parameters
- value: number
Returns void
- Defined in src/ext/bitbuffer.ts:47

writeUInt8

writeUInt8(value: number): void
Parameters
- value: number
Returns void
- Defined in src/ext/bitbuffer.ts:45

writeUTF8String

writeUTF8String(str: string, maxLength?: number): string
Parameters
- str: string
- Optional maxLength: number
Returns string
- Defined in typings/bit-buffer.d.ts:93

writeUint16

writeUint16(value: number): void
Parameters
- value: number
Returns void
- Defined in typings/bit-buffer.d.ts:79

writeUint32

writeUint32(value: number): void
Parameters
- value: number
Returns void
- Defined in typings/bit-buffer.d.ts:80

writeUint8

writeUint8(value: number): void
Parameters
- value: number
Returns void
- Defined in typings/bit-buffer.d.ts:78

Generated using TypeDoc