Gjsify LogoGjsify Logo

#GstBitReader provides a bit reader that can read any number of bits from a memory buffer. It provides functions for reading any number of bits into 8, 16, 32 and 64 bit variables.

record

Hierarchy

  • BitReader

Index

Constructors

Properties

bit: number

Bit position in the current byte

field
byte: number

Current byte position

field
data: Uint8Array

Data from which the bit reader will read

field
size: number

Size of data in bytes

field
name: string

Methods

  • free(): void
  • Frees a #GstBitReader instance, which was previously allocated by gst_bit_reader_new().

    Returns void

  • getBitsUint16(nbits: number): [boolean, number]
  • Read nbits bits into val and update the current position.

    Parameters

    • nbits: number

      number of bits to read

    Returns [boolean, number]

  • getBitsUint32(nbits: number): [boolean, number]
  • Read nbits bits into val and update the current position.

    Parameters

    • nbits: number

      number of bits to read

    Returns [boolean, number]

  • getBitsUint64(nbits: number): [boolean, number]
  • Read nbits bits into val and update the current position.

    Parameters

    • nbits: number

      number of bits to read

    Returns [boolean, number]

  • getBitsUint8(nbits: number): [boolean, number]
  • Read nbits bits into val and update the current position.

    Parameters

    • nbits: number

      number of bits to read

    Returns [boolean, number]

  • getPos(): number
  • Returns the current position of a #GstBitReader instance in bits.

    Returns number

  • getRemaining(): number
  • Returns the remaining number of bits of a #GstBitReader instance.

    Returns number

  • getSize(): number
  • Returns the total number of bits of a #GstBitReader instance.

    Returns number

  • init(data: Uint8Array): void
  • Initializes a #GstBitReader instance to read from data. This function can be called on already initialized instances.

    Parameters

    • data: Uint8Array

      data from which the bit reader should read

    Returns void

  • peekBitsUint16(nbits: number): [boolean, number]
  • Read nbits bits into val but keep the current position.

    Parameters

    • nbits: number

      number of bits to read

    Returns [boolean, number]

  • peekBitsUint32(nbits: number): [boolean, number]
  • Read nbits bits into val but keep the current position.

    Parameters

    • nbits: number

      number of bits to read

    Returns [boolean, number]

  • peekBitsUint64(nbits: number): [boolean, number]
  • Read nbits bits into val but keep the current position.

    Parameters

    • nbits: number

      number of bits to read

    Returns [boolean, number]

  • peekBitsUint8(nbits: number): [boolean, number]
  • Read nbits bits into val but keep the current position.

    Parameters

    • nbits: number

      number of bits to read

    Returns [boolean, number]

  • setPos(pos: number): boolean
  • Sets the new position of a #GstBitReader instance to pos in bits.

    Parameters

    • pos: number

      The new position in bits

    Returns boolean

  • skip(nbits: number): boolean
  • Skips nbits bits of the #GstBitReader instance.

    Parameters

    • nbits: number

      the number of bits to skip

    Returns boolean

  • skipToByte(): boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method