Class KeyValuePair

Represents a key-value pair for MOQT protocol parameters.

If typeValue is even, the value is a varint (bigint).
If typeValue is odd, the value is a binary blob (Uint8Array) with a maximum length of 65535 bytes.

Use KeyValuePair.tryNewVarInt for varint pairs and KeyValuePair.tryNewBytes for blob pairs.

Index

Properties

typeValue value

Methods

equals serialize deserialize tryNewBytes tryNewVarInt

Properties

`Readonly`typeValue

typeValue: bigint

The key/type identifier for this pair.

Even: value is a varint.
Odd: value is a blob.

`Readonly`value

value: bigint | Uint8Array<ArrayBufferLike>

The value for this pair.

If typeValue is even: a varint (bigint).
If typeValue is odd: a binary blob (Uint8Array).

Methods

equals

equals(other: KeyValuePair): boolean
Checks if this pair is equal to another.
Parameters
- other: KeyValuePair
  The other KeyValuePair.
Returns boolean
True if both type and value are equal.
- Defined in libs/moqtail-ts/src/model/common/pair.ts:135

serialize

serialize(): FrozenByteBuffer
Serializes this key-value pair to a frozen byte buffer.

Returns FrozenByteBuffer
The serialized buffer.
- Defined in libs/moqtail-ts/src/model/common/pair.ts:97

`Static`deserialize

deserialize(buf: BaseByteBuffer): KeyValuePair
Deserializes a KeyValuePair from a buffer.
Parameters
- buf: BaseByteBuffer
  The buffer to read from.
Returns KeyValuePair
The deserialized KeyValuePair.

Throws
LengthExceedsMaxError if blob length exceeds 65535 bytes.

Throws
NotEnoughBytesError if buffer does not contain enough bytes.
- Defined in libs/moqtail-ts/src/model/common/pair.ts:115

`Static`tryNewBytes

tryNewBytes(typeValue: number | bigint, value: Uint8Array): KeyValuePair
Creates a new blob KeyValuePair.
Parameters
- typeValue: number | bigint
  Must be odd.
- value: Uint8Array
  The binary blob value.
Returns KeyValuePair
A KeyValuePair with blob value.

Throws
KeyValueFormattingError if typeValue is not odd.

Throws
LengthExceedsMaxError if value length exceeds 65535 bytes.
- Defined in libs/moqtail-ts/src/model/common/pair.ts:81

`Static`tryNewVarInt

tryNewVarInt(typeValue: number | bigint, value: number | bigint): KeyValuePair
Creates a new varint KeyValuePair.
Parameters
- typeValue: number | bigint
  Must be even.
- value: number | bigint
  The varint value.
Returns KeyValuePair
A KeyValuePair with varint value.

Throws
KeyValueFormattingError if typeValue is not even.
- Defined in libs/moqtail-ts/src/model/common/pair.ts:64