Class VBANPacket

Hierarchy (View Summary)

VBANPacket

Index

Constructors

Properties

frameCounter sr streamName subProtocol frameCounters

Methods

toUDPPacket checkFrameCounter convertToUDPPacket getSampleRate parsePacket parsePacketHeader prepareFromUDPPacket

Constructors

constructor

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

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

toUDPPacket

toUDPPacket(): Buffer
Returns Buffer
- Defined in src/packets/VBANPacket.ts:190

`Static`checkFrameCounter

checkFrameCounter(headers: VBANPacket): void
Experimental
EXPERIMENTAL - DO NOT USE
Parameters
- headers: VBANPacket
Returns void
- 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
- Defined in src/packets/VBANPacket.ts:119

`Static`getSampleRate

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

`Static`parsePacket

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

`Static`parsePacketHeader

parsePacketHeader(headersBuffer: Buffer): IVBANHeaderCommon
Parameters
- headersBuffer: Buffer
Returns IVBANHeaderCommon
- 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
- Defined in src/packets/VBANPacket.ts:97