Class VBANTEXTPacket

Hierarchy (view full)

Constructors

Properties

bps: number

Bit rate is given in bps for information only. But it can be used internally to limit the bandwidth of the stream and for example gives more priority to audio stream or RT MIDI stream. It can be set to ZERO if there is no particular bit rate.

channelsIdents: number

Can be used to define a sub channel (sub text channel) and then manage up to 256 different virtual pipes (ZERO by default).

dataBuffer?: Buffer

you can access the raw dataBuffer (if available) to try another decoding

encoding: ETextEncoding

Text format

Data type used to store data in the packet (ZERO/VBAN_DATATYPE_BYTE8 per default).

frameCounter: number

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

sr: number

not used . Replaced by VBANTEXTPacket.bps

streamName: string

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

subProtocol: ESubProtocol = VBANTEXTPacket.subProtocol

the subProtocol of this packet ESubProtocol

text: string

if data can be decoded, it will be decoded in text

frameCounters: Map<string, number> = ...
subProtocol: ESubProtocol = ESubProtocol.TEXT

Methods