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

    Class DataTrackPacket

    A class for serializing / deserializing data track packets.

    Hierarchy

    • default
      • DataTrackPacket
    Index

    Constructors

    Properties

    payload: ArrayBuffer

    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, DataTrackSerializeErrorAll>

    • Returns the expected length of the serialized output in bytes

      Returns number

    • Returns {
          header: {
              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;
          };
          payload: ArrayBuffer;
      }

    • Type Parameters

      • Input extends ArrayBuffer | Uint8Array<ArrayBufferLike> | DataView<ArrayBufferLike>

      Parameters

      Returns Throws<
          [packet: DataTrackPacket, byteLength: number],
          DataTrackDeserializeErrorAll,
      >