Class VBANUnknownPacket

Hierarchy (View Summary)

VBANPacket
- VBANUnknownPacket

Index

Constructors

Properties

data frameCounter part1 part2 part3 sr streamName subProtocol frameCounters

Methods

toUDPPacket checkFrameCounter convertToUDPPacket fromUDPPacket getSampleRate parsePacket parsePacketHeader prepareFromUDPPacket toUDPPacket

Constructors

constructor

new VBANUnknownPacket(
headers: IVBANHeaderCommon,
data: Buffer,
): VBANUnknownPacket
Parameters
- headers: IVBANHeaderCommon
- data: Buffer
Returns VBANUnknownPacket
Overrides VBANPacket.constructor
- Defined in src/packets/VBANUnknownPacket/VBANUnknownPacket.ts:16

Properties

data

data: Buffer

frameCounter

frameCounter: number

frameCounter allow checking if you receive frame in order, and without losing them

part1

part1: number

part2

part2: number

part3

part3: number

sr

sr: number

Sample Rate for this stream

streamName

streamName: string

the name of the current stream . Voicemeeter rely on it to allow a packet or not

subProtocol

subProtocol: number = -1

the subProtocol of this packet ESubProtocol

`Static` `Readonly`frameCounters

frameCounters: Map<string, number> = ...

Methods

toUDPPacket

toUDPPacket(): Buffer<ArrayBufferLike>
Returns Buffer<ArrayBufferLike>
Overrides VBANPacket.toUDPPacket
- Defined in src/packets/VBANUnknownPacket/VBANUnknownPacket.ts:28

`Static`checkFrameCounter

checkFrameCounter(headers: VBANPacket): void
Experimental
EXPERIMENTAL - DO NOT USE
Parameters
- headers: VBANPacket
Returns void
Inherited from VBANPacket.checkFrameCounter
- Defined in src/packets/VBANPacket.ts:170

`Protected` `Static`convertToUDPPacket

convertToUDPPacket(
    headers: Omit<IVBANHeaderCommon, "srIndex">,
    data: Buffer,
    sampleRate?: number,
): Buffer
Convert a VBANPacket to a UDP packet
Parameters
- headers: Omit<IVBANHeaderCommon, "srIndex">
- data: Buffer
- OptionalsampleRate: number
Returns Buffer
Inherited from VBANPacket.convertToUDPPacket
- Defined in src/packets/VBANPacket.ts:119

`Static`fromUDPPacket

fromUDPPacket(headers: IVBANHeaderCommon, data: Buffer): VBANUnknownPacket
Parameters
- headers: IVBANHeaderCommon
- data: Buffer
Returns VBANUnknownPacket
- Defined in src/packets/VBANUnknownPacket/VBANUnknownPacket.ts:48

`Static`getSampleRate

getSampleRate(srIndex?: number): number
Parameters
- OptionalsrIndex: number
Returns number
Inherited from VBANPacket.getSampleRate
- Defined in src/packets/VBANPacket.ts:37

`Static`parsePacket

parsePacket(packet: Buffer): { data: Buffer; headers: IVBANHeaderCommon }
Parameters
- packet: Buffer
Returns { data: Buffer; headers: IVBANHeaderCommon }
Inherited from VBANPacket.parsePacket
- Defined in src/packets/VBANPacket.ts:78

`Static`parsePacketHeader

parsePacketHeader(headersBuffer: Buffer): IVBANHeaderCommon
Parameters
- headersBuffer: Buffer
Returns IVBANHeaderCommon
Inherited from VBANPacket.parsePacketHeader
- Defined in src/packets/VBANPacket.ts:44

`Static`prepareFromUDPPacket

prepareFromUDPPacket(
headersBuffer: Buffer,
checkSR?: boolean,
): IVBANHeaderCommon
Extract headers and data from UDPPacket, each Packet will continue the process
Parameters
- headersBuffer: Buffer
- checkSR: boolean = true
Returns IVBANHeaderCommon
Deprecated
Inherited from VBANPacket.prepareFromUDPPacket
- Defined in src/packets/VBANPacket.ts:97

`Static`toUDPPacket

toUDPPacket(packet: VBANUnknownPacket): Buffer
Parameters
- packet: VBANUnknownPacket
Returns Buffer
- Defined in src/packets/VBANUnknownPacket/VBANUnknownPacket.ts:32