Data type used to store audio sample in the packet Use it to select the correct bitResolution VBANAudioPacket.bitResolutions, or directly use VBANAudioPacket.bitResolutionObject
-Readonly bitthe bit resolution selected by the id in VBANAudioPacket.bitResolution
-Audio codec used
-current audio
-frameCounter allow checking if you receive frame in order, and without losing them
-Number of channel is given by an 8 bits unsigned integer (0 – 255) where 0 means 1 channel +
Readonly bitthe bit resolution selected by the id in VBANAudioPacket.bitResolution
+Audio codec used
+current audio
+frameCounter allow checking if you receive frame in order, and without losing them
+Number of channel is given by an 8 bits unsigned integer (0 – 255) where 0 means 1 channel and 255 means 256 channels.
-Number of sample is given by an 8 bits unsigned integer (0 – 255) where 0 means 1 sample and +
Number of sample is given by an 8 bits unsigned integer (0 – 255) where 0 means 1 sample and 255 means 256 samples
-Sample Rate for this stream
-the name of the current stream . +
Sample Rate for this stream
+the name of the current stream . Voicemeeter rely on it to allow a packet or not
-the subProtocol of this packet +
the subProtocol of this packet ESubProtocol
-Static bitStatic Readonly frameStatic subStatic checkEXPERIMENTAL - DO NOT USE
-Static Protected convertConvert a VBANPacket to a UDP packet
-Optional sampleRate: numberStatic fromUDPPacketStatic prepareExtract headers and data from UDPPacket, each Packet will continue the process
-Static toUDPPacketGenerated using TypeDoc
Static bitStatic Readonly frameStatic subStatic checkEXPERIMENTAL - DO NOT USE
+Static Protected convertConvert a VBANPacket to a UDP packet
+Optional sampleRate: numberStatic fromUDPPacketStatic prepareExtract headers and data from UDPPacket, each Packet will continue the process
+Static toUDPPacketGenerated using TypeDoc
common constructor
-frameCounter allow checking if you receive frame in order, and without losing them
-Sample Rate for this stream
-the name of the current stream . +
frameCounter allow checking if you receive frame in order, and without losing them
+Sample Rate for this stream
+the name of the current stream . Voicemeeter rely on it to allow a packet or not
-the subProtocol of this packet +
the subProtocol of this packet ESubProtocol
-Static Readonly frameStatic checkEXPERIMENTAL - DO NOT USE
-Static Protected convertConvert a VBANPacket to a UDP packet
-Optional sampleRate: numberStatic prepareExtract headers and data from UDPPacket, each Packet will continue the process
-Generated using TypeDoc
Static Readonly frameStatic checkEXPERIMENTAL - DO NOT USE
+Static Protected convertConvert a VBANPacket to a UDP packet
+Optional sampleRate: numberStatic prepareExtract headers and data from UDPPacket, each Packet will continue the process
+Generated using TypeDoc
Static getStatic processStatic toUDPBufferGenerated using TypeDoc
Static getStatic processStatic toUDPBufferGenerated using TypeDoc
This field is used to give possible information on COM port and serial transmission mode related +
This field is used to give possible information on COM port and serial transmission mode related to a Hardware COM port. This is made to possibly emulate COM to COM port connections and let the receiver configure the physical COM port in the right mode.
-SR / bps : Bit rate is given in bps for information only. But it can be useful if serial data come from or go to +
SR / bps : Bit rate is given in bps for information only. But it can be useful if serial data come from or go to a particular COM port. Set to ZERO if there is no particular bit rate.
-Can be used to define a sub channel (sub serial link) and then manage up to 256 different +
Can be used to define a sub channel (sub serial link) and then manage up to 256 different serial virtual pipes (ZERO by default).
-Data type used to store data in the packet (ZERO per default). The index is stored on 3 first bits. +
Data type used to store data in the packet (ZERO per default). The index is stored on 3 first bits. Bit 3 must be ZERO. Bits 4 to 7 gives additional mode
-frameCounter allow checking if you receive frame in order, and without losing them
-not used . Replaced by VBANSerialPacket.bps
-the name of the current stream . +
frameCounter allow checking if you receive frame in order, and without losing them
+not used . Replaced by VBANSerialPacket.bps
+the name of the current stream . Voicemeeter rely on it to allow a packet or not
-type of stream . MIDI or SERIAL ... But in practice, only serial is used (MIDI is serial)
-the subProtocol of this packet +
type of stream . MIDI or SERIAL ... But in practice, only serial is used (MIDI is serial)
+the subProtocol of this packet ESubProtocol
-Static Readonly frameStatic subStatic checkEXPERIMENTAL - DO NOT USE
-Static Protected convertConvert a VBANPacket to a UDP packet
-Optional sampleRate: numberStatic fromUDPPacketStatic prepareExtract headers and data from UDPPacket, each Packet will continue the process
-Static toUDPPacketGenerated using TypeDoc
Static Readonly frameStatic subStatic checkEXPERIMENTAL - DO NOT USE
+Static Protected convertConvert a VBANPacket to a UDP packet
+Optional sampleRate: numberStatic fromUDPPacketStatic prepareExtract headers and data from UDPPacket, each Packet will continue the process
+Static toUDPPacketGenerated using TypeDoc
Optional options: IVBANServerOptionsReadonly UDPServerPrivate framePrivate optionsPrivate osStatic Readonly captureValue: Symbol.for('nodejs.rejection')
Optional options: IVBANServerOptionsReadonly UDPServerPrivate framePrivate optionsPrivate osStatic Readonly captureValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
v13.4.0, v12.16.0
Static captureValue: boolean
@@ -72,12 +72,12 @@v13.6.0, v12.17.0
Optional [captureRest ...args: AnyRestAlias for emitter.on(eventName, listener).
Rest ...args: any[]v0.1.26
-Optional port: numberOptional address: stringOptional callback: (() => void)Optional port: numberOptional callback: (() => void)Optional callback: (() => void)Optional callback: (() => void)Rest ...args: Parameters<VBANServerEvents[U]>Optional port: numberOptional address: stringOptional callback: (() => void)Optional port: numberOptional callback: (() => void)Optional callback: (() => void)Optional callback: (() => void)Rest ...args: Parameters<VBANServerEvents[U]>Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbols.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
v6.0.0
-Private getPrivate getReturns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.
v1.0.0
Returns the number of listeners listening for the event named eventName.
@@ -90,9 +90,9 @@
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
v0.1.26
-Private messageAlias for emitter.removeListener().
Private messageAlias for emitter.removeListener().
Rest ...args: any[]v10.0.0
-Adds a one-timelistener function for the event named eventName. The
+
Adds a one-timelistener function for the event named eventName. The
next time eventName is triggered, this listener is removed and then invoked.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
Rest ...args: any[]v0.1.26
-By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.
frameCounter allow checking if you receive frame in order, and without losing them
-answer is a reply to another request
-Sub Type of the service packet +
frameCounter allow checking if you receive frame in order, and without losing them
+answer is a reply to another request
+Sub Type of the service packet EServiceType
-current function for this function
-not used .
-the name of the current stream . +
current function for this function
+not used .
+the name of the current stream . Voicemeeter rely on it to allow a packet or not
-the subProtocol of this packet +
the subProtocol of this packet ESubProtocol
-Static Readonly frameStatic subStatic checkEXPERIMENTAL - DO NOT USE
-Static Protected convertConvert a VBANPacket to a UDP packet
-Optional sampleRate: numberStatic fromUDPPacketStatic prepareExtract headers and data from UDPPacket, each Packet will continue the process
-Static toUDPPacketGenerated using TypeDoc
Static Readonly frameStatic subStatic checkEXPERIMENTAL - DO NOT USE
+Static Protected convertConvert a VBANPacket to a UDP packet
+Optional sampleRate: numberStatic fromUDPPacketStatic prepareExtract headers and data from UDPPacket, each Packet will continue the process
+Static toUDPPacketGenerated using TypeDoc
Optional dataBuffer: BufferBit rate is given in bps for information only. But it can be used internally to limit the bandwidth of +
Optional dataBuffer: BufferBit 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.
-Can be used to define a sub channel (sub text channel) and then manage up to 256 different +
Can be used to define a sub channel (sub text channel) and then manage up to 256 different virtual pipes (ZERO by default).
-Optional datayou can access the raw dataBuffer (if available) to try another decoding
-Text format
-Data type used to store data in the packet (ZERO/VBAN_DATATYPE_BYTE8 per default).
-frameCounter allow checking if you receive frame in order, and without losing them
-not used . Replaced by VBANTEXTPacket.bps
-the name of the current stream . +
Optional datayou can access the raw dataBuffer (if available) to try another decoding
+Text format
+Data type used to store data in the packet (ZERO/VBAN_DATATYPE_BYTE8 per default).
+frameCounter allow checking if you receive frame in order, and without losing them
+not used . Replaced by VBANTEXTPacket.bps
+the name of the current stream . Voicemeeter rely on it to allow a packet or not
-the subProtocol of this packet +
the subProtocol of this packet ESubProtocol
-if data can be decoded, it will be decoded in text
-Static Readonly frameStatic subStatic checkEXPERIMENTAL - DO NOT USE
-Static Protected convertConvert a VBANPacket to a UDP packet
-Optional sampleRate: numberStatic fromUDPPacketStatic getStatic prepareExtract headers and data from UDPPacket, each Packet will continue the process
-Static toUDPPacketGenerated using TypeDoc
if data can be decoded, it will be decoded in text
+Static Readonly frameStatic subStatic checkEXPERIMENTAL - DO NOT USE
+Static Protected convertConvert a VBANPacket to a UDP packet
+Optional sampleRate: numberStatic fromUDPPacketStatic getStatic prepareExtract headers and data from UDPPacket, each Packet will continue the process
+Static toUDPPacketGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Set to true if the serial data block requires several VBAN Packets (1436 BYTE max) to be completed.
-PARITY CHECKING:
+PARITY CHECKING:
START BIT
+START BIT
STOP BIT
+STOP BIT
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional frameOptional srGenerated using TypeDoc
Optional frameOptional srGenerated using TypeDoc
Optional frameOptional srGenerated using TypeDoc
Optional frameOptional srGenerated using TypeDoc
Optional frameOptional srGenerated using TypeDoc
Optional frameOptional srGenerated using TypeDoc
Optional frameOptional srGenerated using TypeDoc
Optional frameOptional srGenerated using TypeDoc
Optional frameOptional iscan be 0 for PING0, or 0x80 for REPLY
-Optional srGenerated using TypeDoc
Optional frameOptional iscan be 0 for PING0, or 0x80 for REPLY
+Optional srGenerated using TypeDoc
Optional bpsOptional channelsOptional formatOptional frameOptional srGenerated using TypeDoc
Optional bpsOptional channelsOptional formatOptional frameOptional srGenerated using TypeDoc
Optional applicationOptional GPSPosition?: stringOptional PreferredOptional applicationOptional applicationOptional bitOptional color?: { Optional deviceOptional features?: EServicePINGFeatures[]Optional langOptional manufacturerOptional maxOptional minOptional nOptional userOptional userOptional userOptional autowill auto send a reply when another app will send a ping
-Optional beforeReturn false to stop processing the packet
-Generated using TypeDoc
Optional applicationOptional GPSPosition?: stringOptional PreferredOptional applicationOptional applicationOptional bitOptional color?: { Optional deviceOptional features?: EServicePINGFeatures[]Optional langOptional manufacturerOptional maxOptional minOptional nOptional userOptional userOptional userOptional autowill auto send a reply when another app will send a ping
+Optional beforeReturn false to stop processing the packet
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const the stream name is limited to 16 bytes
-Generated using TypeDoc
Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Const Generated using TypeDoc
Data type used to store audio sample in the packet +