LiveKit JS Client SDK - v2.17.1
    Preparing search index...

    Interface DataTrackPacketHeader

    A class for serializing / deserializing data track packet header sections.

    interface DataTrackPacketHeader {
        extensions: DataTrackExtensions;
        frameNumber: WrapAroundUnsignedInt<65535>;
        marker: FrameMarker;
        sequence: WrapAroundUnsignedInt<65535>;
        timestamp: DataTrackTimestamp<90000>;
        trackHandle: DataTrackHandle;
        toBinary(): Throws<Uint8Array<ArrayBufferLike>, DataTrackSerializeErrorAll>;
        toBinaryInto(
            dataView: DataView,
        ): Throws<number, DataTrackSerializeError<TooSmallForHeader>>;
        toBinaryLengthBytes(): number;
        toJSON(): {
            extensions: {
                e2ee: | {
                    iv: Uint8Array<ArrayBufferLike>;
                    keyIndex: number;
                    lengthBytes: number;
                    tag: number;
                }
                | null;
                userTimestamp: | { lengthBytes: number; tag: number; timestamp: bigint }
                | null;
            };
            frameNumber: number;
            marker: FrameMarker;
            sequence: number;
            timestamp: number;
            trackHandle: number;
        };
    }

    Hierarchy

    • default
      • DataTrackPacketHeader
    Index

    Properties

    frameNumber: WrapAroundUnsignedInt<65535>
    marker: FrameMarker
    sequence: WrapAroundUnsignedInt<65535>
    timestamp: DataTrackTimestamp<90000>
    trackHandle: DataTrackHandle

    Methods

    • Encodes the instance as binary and returns the data as a Uint8Array.

      Returns Throws<Uint8Array<ArrayBufferLike>, DataTrackSerializeErrorAll>

    • Given a DataView, serialize the instance inside and return the number of bytes written.

      Parameters

      • dataView: DataView

      Returns Throws<number, DataTrackSerializeError<TooSmallForHeader>>

    • Returns the expected length of the serialized output in bytes

      Returns number

    • Returns {
          extensions: {
              e2ee:
                  | {
                      iv: Uint8Array<ArrayBufferLike>;
                      keyIndex: number;
                      lengthBytes: number;
                      tag: number;
                  }
                  | null;
              userTimestamp: | { lengthBytes: number; tag: number; timestamp: bigint }
              | null;
          };
          frameNumber: number;
          marker: FrameMarker;
          sequence: number;
          timestamp: number;
          trackHandle: number;
      }