Class VBANPacket

Hierarchy (view full)

VBANPacket

Index

Constructors

Properties

frameCounter sr streamName subProtocol frameCounters

Methods

checkFrameCounter convertToUDPPacket prepareFromUDPPacket

Constructors

constructor

new VBANPacket(headers): VBANPacket
common constructor
Parameters
- headers: IVBANHeader
Returns VBANPacket
- Defined in src/packets/VBANPacket.ts:67

Properties

frameCounter

frameCounter: number

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

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: ESubProtocol = ESubProtocol.AUDIO

the subProtocol of this packet ESubProtocol

`Static` `Readonly` frameCounters

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

Methods

`Static` checkFrameCounter

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

`Static` `Protected` convertToUDPPacket

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

`Static` prepareFromUDPPacket

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