From a4319c0d40db79159544e5a1cfd69dce82c10ccf Mon Sep 17 00:00:00 2001 From: thib3113 Date: Fri, 2 Feb 2024 23:08:23 +0000 Subject: [PATCH] deploy: c0cf115d63c7001e006d8e9fd05dcedd33d81fdc --- classes/VBANAudioPacket.html | 32 +++++++++++++------------- classes/VBANPacket.html | 18 +++++++-------- classes/VBANProtocolFactory.html | 4 ++-- classes/VBANSerialPacket.html | 30 ++++++++++++------------ classes/VBANServer.html | 16 ++++++------- classes/VBANServicePacket.html | 26 ++++++++++----------- classes/VBANTEXTPacket.html | 32 +++++++++++++------------- enums/EBitsResolutions.html | 4 ++-- enums/ECodecs.html | 4 ++-- enums/EFormatBit.html | 4 ++-- enums/ESerialStreamType.html | 4 ++-- enums/EServiceFunction.html | 4 ++-- enums/EServicePINGApplicationType.html | 4 ++-- enums/EServicePINGFeatures.html | 4 ++-- enums/EServiceType.html | 4 ++-- enums/ESubProtocol.html | 4 ++-- enums/ETextEncoding.html | 4 ++-- functions/cleanPacketString.html | 2 +- functions/dec2bin.html | 2 +- functions/prepareStringForPacket.html | 2 +- hierarchy.html | 2 +- index.html | 4 ++-- interfaces/IBitResolution.html | 4 ++-- interfaces/ISerialBitMode.html | 10 ++++---- interfaces/IServicePing.html | 4 ++-- interfaces/IVBANHeader.html | 4 ++-- interfaces/IVBANHeaderAudio.html | 4 ++-- interfaces/IVBANHeaderCommon.html | 4 ++-- interfaces/IVBANHeaderSerial.html | 12 +++++----- interfaces/IVBANHeaderService.html | 6 ++--- interfaces/IVBANHeaderTEXT.html | 4 ++-- interfaces/IVBANServerOptions.html | 8 +++---- interfaces/VBANServerEvents.html | 4 ++-- modules.html | 4 ++-- types/VBANPacketTypes.html | 2 +- variables/BITS_SPEEDS.html | 2 +- variables/MAX_FRAME_COUNTER.html | 2 +- variables/PACKET_IDENTIFICATION.html | 2 +- variables/STREAM_NAME_LENGTH.html | 4 ++-- variables/VBAN_DATA_MAX_SIZE.html | 2 +- variables/VBAN_PACKET_MAX_SIZE.html | 2 +- variables/sampleRates.html | 2 +- variables/serialStopModes.html | 2 +- 43 files changed, 149 insertions(+), 149 deletions(-) diff --git a/classes/VBANAudioPacket.html b/classes/VBANAudioPacket.html index 735f33d4..33c0fcbe 100644 --- a/classes/VBANAudioPacket.html +++ b/classes/VBANAudioPacket.html @@ -1,4 +1,4 @@ -VBANAudioPacket | vban - v1.2.4

Class VBANAudioPacket

Hierarchy (view full)

Constructors

constructor +VBANAudioPacket | vban - v1.2.5

Class VBANAudioPacket

Hierarchy (view full)

Constructors

constructor

Properties

bitResolution bitResolutionObject codec @@ -17,23 +17,23 @@ fromUDPPacket prepareFromUDPPacket toUDPPacket -

Constructors

constructor

Properties

bitResolution

bitResolution: EBitsResolutions

Data type used to store audio sample in the packet +

Constructors

constructor

Properties

bitResolution

bitResolution: EBitsResolutions

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 bitResolutionObject

bitResolutionObject: IBitResolution

the bit resolution selected by the id in VBANAudioPacket.bitResolution

-

codec

codec: ECodecs

Audio codec used

-

data

data: Buffer

current audio

-

frameCounter

frameCounter: number

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

-

nbChannel

nbChannel: number

Number of channel is given by an 8 bits unsigned integer (0 – 255) where 0 means 1 channel +

Readonly bitResolutionObject

bitResolutionObject: IBitResolution

the bit resolution selected by the id in VBANAudioPacket.bitResolution

+

codec

codec: ECodecs

Audio codec used

+

data

data: Buffer

current audio

+

frameCounter

frameCounter: number

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

+

nbChannel

nbChannel: number

Number of channel is given by an 8 bits unsigned integer (0 – 255) where 0 means 1 channel and 255 means 256 channels.

-

nbSample

nbSample: number

Number of sample is given by an 8 bits unsigned integer (0 – 255) where 0 means 1 sample and +

nbSample

nbSample: number

Number of sample is given by an 8 bits unsigned integer (0 – 255) where 0 means 1 sample and 255 means 256 samples

-

sr

sr: number

Sample Rate for this stream

-

streamName

streamName: string

the name of the current stream . +

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 = VBANAudioPacket.subProtocol

the subProtocol of this packet +

subProtocol

subProtocol: ESubProtocol = VBANAudioPacket.subProtocol

the subProtocol of this packet ESubProtocol

-

Static bitResolutions

bitResolutions: Record<number, IBitResolution> = ...

Static Readonly frameCounters

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

Static subProtocol

subProtocol: ESubProtocol = ESubProtocol.AUDIO

VBANAudioPacket.subProtocol

-

Methods

Static checkFrameCounter

Static Protected convertToUDPPacket

Static fromUDPPacket

Static prepareFromUDPPacket

Static toUDPPacket

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Static bitResolutions

bitResolutions: Record<number, IBitResolution> = ...

Static Readonly frameCounters

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

Static subProtocol

subProtocol: ESubProtocol = ESubProtocol.AUDIO

VBANAudioPacket.subProtocol

+

Methods

Static checkFrameCounter

Static Protected convertToUDPPacket

Static fromUDPPacket

Static prepareFromUDPPacket

Static toUDPPacket

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/VBANPacket.html b/classes/VBANPacket.html index d1632d79..e62190fa 100644 --- a/classes/VBANPacket.html +++ b/classes/VBANPacket.html @@ -1,4 +1,4 @@ -VBANPacket | vban - v1.2.4

Class VBANPacket

Hierarchy (view full)

Constructors

constructor +VBANPacket | vban - v1.2.5

Class VBANPacket

Hierarchy (view full)

Constructors

constructor

Properties

frameCounter sr streamName @@ -8,13 +8,13 @@ convertToUDPPacket prepareFromUDPPacket

Constructors

constructor

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 . +

Parameters

Returns VBANPacket

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 +

subProtocol

subProtocol: ESubProtocol = ESubProtocol.AUDIO

the subProtocol of this packet ESubProtocol

-

Static Readonly frameCounters

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

Methods

Static checkFrameCounter

Static Protected convertToUDPPacket

  • convertToUDPPacket(headers, data, sampleRate?): Buffer

  • Convert a VBANPacket to a UDP packet

    -

    Parameters

    Returns Buffer

Static prepareFromUDPPacket

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Static Readonly frameCounters

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

Methods

Static checkFrameCounter

Static Protected convertToUDPPacket

  • convertToUDPPacket(headers, data, sampleRate?): Buffer

  • Convert a VBANPacket to a UDP packet

    +

    Parameters

    Returns Buffer

Static prepareFromUDPPacket

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/VBANProtocolFactory.html b/classes/VBANProtocolFactory.html index 30271fbe..f66f00a5 100644 --- a/classes/VBANProtocolFactory.html +++ b/classes/VBANProtocolFactory.html @@ -1,5 +1,5 @@ -VBANProtocolFactory | vban - v1.2.4

Class VBANProtocolFactory

Constructors

constructor +VBANProtocolFactory | vban - v1.2.5

Class VBANProtocolFactory

Constructors

constructor

Methods

getConstructor processPacket toUDPBuffer -

Constructors

constructor

Methods

Static getConstructor

Static processPacket

Static toUDPBuffer

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

Static getConstructor

Static processPacket

Static toUDPBuffer

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/VBANSerialPacket.html b/classes/VBANSerialPacket.html index 7378f760..6f228cd8 100644 --- a/classes/VBANSerialPacket.html +++ b/classes/VBANSerialPacket.html @@ -1,4 +1,4 @@ -VBANSerialPacket | vban - v1.2.4

Class VBANSerialPacket

Hierarchy (view full)

Constructors

constructor +VBANSerialPacket | vban - v1.2.5

Class VBANSerialPacket

Hierarchy (view full)

Constructors

constructor

Properties

bitMode bps channelsIdents @@ -16,24 +16,24 @@ fromUDPPacket prepareFromUDPPacket toUDPPacket -

Constructors

constructor

Properties

bitMode

bitMode: ISerialBitMode

This field is used to give possible information on COM port and serial transmission mode related +

Constructors

constructor

Properties

bitMode

bitMode: ISerialBitMode

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.

-

bps

bps: number

SR / bps : Bit rate is given in bps for information only. But it can be useful if serial data come from or go to +

bps

bps: number

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.

-

channelsIdents

channelsIdents: number

Can be used to define a sub channel (sub serial link) and then manage up to 256 different +

channelsIdents

channelsIdents: number

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

data: Buffer

formatBit

formatBit: VBAN_DATATYPE_BYTE8

Data type used to store data in the packet (ZERO per default). The index is stored on 3 first bits. +

data

data: Buffer

formatBit

formatBit: VBAN_DATATYPE_BYTE8

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

frameCounter: number

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

-

sr

sr: number = 0

not used . Replaced by VBANSerialPacket.bps

-

streamName

streamName: string

the name of the current stream . +

frameCounter

frameCounter: number

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

+

sr

sr: number = 0

not used . Replaced by VBANSerialPacket.bps

+

streamName

streamName: string

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

-

streamType

streamType: ESerialStreamType

type of stream . MIDI or SERIAL ... But in practice, only serial is used (MIDI is serial)

-

subProtocol

subProtocol: ESubProtocol = VBANSerialPacket.subProtocol

the subProtocol of this packet +

streamType

streamType: ESerialStreamType

type of stream . MIDI or SERIAL ... But in practice, only serial is used (MIDI is serial)

+

subProtocol

subProtocol: ESubProtocol = VBANSerialPacket.subProtocol

the subProtocol of this packet ESubProtocol

-

Static Readonly frameCounters

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

Static subProtocol

subProtocol: ESubProtocol = ESubProtocol.SERIAL

VBANSerialPacket.subProtocol

-

Methods

Static checkFrameCounter

Static Protected convertToUDPPacket

Static fromUDPPacket

Static prepareFromUDPPacket

Static toUDPPacket

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Static Readonly frameCounters

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

Static subProtocol

subProtocol: ESubProtocol = ESubProtocol.SERIAL

VBANSerialPacket.subProtocol

+

Methods

Static checkFrameCounter

Static Protected convertToUDPPacket

Static fromUDPPacket

Static prepareFromUDPPacket

Static toUDPPacket

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/VBANServer.html b/classes/VBANServer.html index e6a736a2..1df6cec6 100644 --- a/classes/VBANServer.html +++ b/classes/VBANServer.html @@ -1,4 +1,4 @@ -VBANServer | vban - v1.2.4

Class VBANServer

Hierarchy

  • EventEmitter
    • VBANServer

Constructors

constructor +VBANServer | vban - v1.2.5

Class VBANServer

Hierarchy

  • EventEmitter
    • VBANServer

Constructors

constructor

Properties

UDPServer frameCounter isListening @@ -38,7 +38,7 @@ on once setMaxListeners -

Constructors

constructor

Properties

Readonly UDPServer

UDPServer: Socket

Private frameCounter

frameCounter: Map<ESubProtocol, number> = ...

isListening

isListening: boolean = false

Private options

options: IVBANServerOptions

Private os

os: {
    hostname: (() => string);
}

Type declaration

  • hostname: (() => string)
      • (): string

      • Returns string

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Value: Symbol.for('nodejs.rejection')

+

Constructors

constructor

Properties

Readonly UDPServer

UDPServer: Socket

Private frameCounter

frameCounter: Map<ESubProtocol, number> = ...

isListening

isListening: boolean = false

Private options

options: IVBANServerOptions

Private os

os: {
    hostname: (() => string);
}

Type declaration

  • hostname: (() => string)
      • (): string

      • Returns string

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Value: Symbol.for('nodejs.rejection')

See how to write a custom rejection handler.

Since

v13.4.0, v12.16.0

Static captureRejections

captureRejections: boolean

Value: boolean

@@ -72,12 +72,12 @@

Since

v13.6.0, v12.17.0

Methods

Optional [captureRejectionSymbol]

  • [captureRejectionSymbol](error, event, ...args): void

  • Parameters

    • error: Error
    • event: string
    • Rest ...args: any[]

    Returns void

addListener

  • addListener(eventName, listener): this

  • Alias for emitter.on(eventName, listener).

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v0.1.26

    -

address

bind

  • bind(port?, address?, callback?): this

  • Parameters

    • Optional port: number
    • Optional address: string
    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns this

  • bind(port?, callback?): this

  • Parameters

    • Optional port: number
    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns this

  • bind(callback?): this

  • Parameters

    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns this

  • bind(options, callback?): this

  • Parameters

    • options: BindOptions
    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns this

close

  • close(cb?): void

  • Parameters

    • Optional cb: (() => void)
        • (): void

        • Returns void

    Returns void

emit

eventNames

  • eventNames(): (string | symbol)[]

  • Returns an array listing the events for which the emitter has registered +

address

bind

  • bind(port?, address?, callback?): this

  • Parameters

    • Optional port: number
    • Optional address: string
    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns this

  • bind(port?, callback?): this

  • Parameters

    • Optional port: number
    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns this

  • bind(callback?): this

  • Parameters

    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns this

  • bind(options, callback?): this

  • Parameters

    • options: BindOptions
    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns this

close

  • close(cb?): void

  • Parameters

    • Optional cb: (() => void)
        • (): void

        • Returns void

    Returns void

emit

eventNames

  • eventNames(): (string | symbol)[]

  • 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) ]

    Returns (string | symbol)[]

    Since

    v6.0.0

    -

Private getFrameCounter

getMaxListeners

  • getMaxListeners(): number

  • Returns the current max listener value for the EventEmitter which is either +

Private getFrameCounter

getMaxListeners

  • getMaxListeners(): number

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Returns number

    Since

    v1.0.0

listenerCount

  • listenerCount(eventName, listener?): number

  • 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] ]

    Parameters

    • eventName: string | symbol

    Returns Function[]

    Since

    v0.1.26

    -

Private messageHandler

  • messageHandler(msg, sender): void

  • Parameters

    • msg: Buffer
    • sender: RemoteInfo

    Returns void

off

  • off(eventName, listener): this

  • Alias for emitter.removeListener().

    +

Private messageHandler

  • messageHandler(msg, sender): void

  • Parameters

    • msg: Buffer
    • sender: RemoteInfo

    Returns void

off

  • off(eventName, listener): this

  • Alias for emitter.removeListener().

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v10.0.0

    -

on

once

  • once(eventName, listener): this

  • Adds a one-timelistener function for the event named eventName. The +

on

once

  • once(eventName, listener): this

  • 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!');
    });
    @@ -157,7 +157,7 @@

    Returns a reference to the EventEmitter, so that calls can be chained.

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v0.1.26

    -

send

sendPing

  • sendPing(sender, isReply?): void

  • Parameters

    • sender: {
          address: string;
          port: number;
      }
      • address: string
      • port: number
    • isReply: boolean = false

    Returns void

setMaxListeners

  • setMaxListeners(n): this

  • By default EventEmitters will print a warning if more than 10 listeners are +

send

sendPing

  • sendPing(sender, isReply?): void

  • Parameters

    • sender: {
          address: string;
          port: number;
      }
      • address: string
      • port: number
    • isReply: boolean = false

    Returns void

setMaxListeners

  • setMaxListeners(n): this

  • 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.

    @@ -234,4 +234,4 @@

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    Parameters

    • Optional n: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]

    Returns void

    Since

    v15.4.0

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/VBANServicePacket.html b/classes/VBANServicePacket.html index b1e84eba..25a1ea53 100644 --- a/classes/VBANServicePacket.html +++ b/classes/VBANServicePacket.html @@ -1,4 +1,4 @@ -VBANServicePacket | vban - v1.2.4

Class VBANServicePacket

Hierarchy (view full)

Constructors

constructor +VBANServicePacket | vban - v1.2.5

Class VBANServicePacket

Hierarchy (view full)

Constructors

constructor

Properties

data frameCounter isReply @@ -14,18 +14,18 @@ fromUDPPacket prepareFromUDPPacket toUDPPacket -

Constructors

constructor

Properties

data

data: IServicePing

frameCounter

frameCounter: number

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

-

isReply

isReply: boolean = false

answer is a reply to another request

-

service

service: EServiceType

Sub Type of the service packet +

Constructors

constructor

Properties

data

data: IServicePing

frameCounter

frameCounter: number

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

+

isReply

isReply: boolean = false

answer is a reply to another request

+

service

service: EServiceType

Sub Type of the service packet EServiceType

-

serviceFunction

serviceFunction: EServiceFunction

current function for this function

-

sr

sr: number = 0

not used .

-

streamName

streamName: string

the name of the current stream . +

serviceFunction

serviceFunction: EServiceFunction

current function for this function

+

sr

sr: number = 0

not used .

+

streamName

streamName: string

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

-

subProtocol

subProtocol: ESubProtocol = VBANServicePacket.subProtocol

the subProtocol of this packet +

subProtocol

subProtocol: ESubProtocol = VBANServicePacket.subProtocol

the subProtocol of this packet ESubProtocol

-

Static Readonly frameCounters

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

Static subProtocol

subProtocol: ESubProtocol = ESubProtocol.SERVICE

VBANServicePacket.subProtocol

-

Methods

Static checkFrameCounter

Static Protected convertToUDPPacket

Static fromUDPPacket

Static prepareFromUDPPacket

Static toUDPPacket

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Static Readonly frameCounters

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

Static subProtocol

subProtocol: ESubProtocol = ESubProtocol.SERVICE

VBANServicePacket.subProtocol

+

Methods

Static checkFrameCounter

Static Protected convertToUDPPacket

Static fromUDPPacket

Static prepareFromUDPPacket

Static toUDPPacket

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/VBANTEXTPacket.html b/classes/VBANTEXTPacket.html index 1393edaf..51cc6876 100644 --- a/classes/VBANTEXTPacket.html +++ b/classes/VBANTEXTPacket.html @@ -1,4 +1,4 @@ -VBANTEXTPacket | vban - v1.2.4

Class VBANTEXTPacket

Hierarchy (view full)

Constructors

constructor +VBANTEXTPacket | vban - v1.2.5

Class VBANTEXTPacket

Hierarchy (view full)

Constructors

constructor

Properties

bps channelsIdents dataBuffer? @@ -17,23 +17,23 @@ getEncoding prepareFromUDPPacket toUDPPacket -

Constructors

constructor

Properties

bps

bps: number

Bit rate is given in bps for information only. But it can be used internally to limit the bandwidth of +

Constructors

constructor

Properties

bps

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

channelsIdents: number

Can be used to define a sub channel (sub text channel) and then manage up to 256 different +

channelsIdents

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).

-

Optional dataBuffer

dataBuffer?: Buffer

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

-

encoding

encoding: ETextEncoding

Text format

-

formatBit

formatBit: VBAN_DATATYPE_BYTE8

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

-

frameCounter

frameCounter: number

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

-

sr

sr: number

not used . Replaced by VBANTEXTPacket.bps

-

streamName

streamName: string

the name of the current stream . +

Optional dataBuffer

dataBuffer?: Buffer

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

+

encoding

encoding: ETextEncoding

Text format

+

formatBit

formatBit: VBAN_DATATYPE_BYTE8

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

+

frameCounter

frameCounter: number

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

+

sr

sr: number

not used . Replaced by VBANTEXTPacket.bps

+

streamName

streamName: string

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

-

subProtocol

subProtocol: ESubProtocol = VBANTEXTPacket.subProtocol

the subProtocol of this packet +

subProtocol

subProtocol: ESubProtocol = VBANTEXTPacket.subProtocol

the subProtocol of this packet ESubProtocol

-

text

text: string

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

-

Static Readonly frameCounters

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

Static subProtocol

subProtocol: ESubProtocol = ESubProtocol.TEXT

VBANTEXTPacket.subProtocol

-

Methods

Static checkFrameCounter

Static Protected convertToUDPPacket

Static fromUDPPacket

Static getEncoding

Static prepareFromUDPPacket

Static toUDPPacket

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

text

text: string

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

+

Static Readonly frameCounters

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

Static subProtocol

subProtocol: ESubProtocol = ESubProtocol.TEXT

VBANTEXTPacket.subProtocol

+

Methods

Static checkFrameCounter

Static Protected convertToUDPPacket

Static fromUDPPacket

Static getEncoding

Static prepareFromUDPPacket

Static toUDPPacket

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/EBitsResolutions.html b/enums/EBitsResolutions.html index cb2001c5..7406760e 100644 --- a/enums/EBitsResolutions.html +++ b/enums/EBitsResolutions.html @@ -1,4 +1,4 @@ -EBitsResolutions | vban - v1.2.4

Enumeration EBitsResolutions

Enumeration Members

VBAN_DATATYPE_10BITS +EBitsResolutions | vban - v1.2.5

Enumeration EBitsResolutions

Enumeration Members

VBAN_DATATYPE_10BITS VBAN_DATATYPE_12BITS VBAN_DATATYPE_BYTE8 VBAN_DATATYPE_FLOAT32 @@ -6,4 +6,4 @@ VBAN_DATATYPE_INT16 VBAN_DATATYPE_INT24 VBAN_DATATYPE_INT32 -

Enumeration Members

VBAN_DATATYPE_10BITS

VBAN_DATATYPE_10BITS: 7

VBAN_DATATYPE_12BITS

VBAN_DATATYPE_12BITS: 6

VBAN_DATATYPE_BYTE8

VBAN_DATATYPE_BYTE8: 0

VBAN_DATATYPE_FLOAT32

VBAN_DATATYPE_FLOAT32: 4

VBAN_DATATYPE_FLOAT64

VBAN_DATATYPE_FLOAT64: 5

VBAN_DATATYPE_INT16

VBAN_DATATYPE_INT16: 1

VBAN_DATATYPE_INT24

VBAN_DATATYPE_INT24: 2

VBAN_DATATYPE_INT32

VBAN_DATATYPE_INT32: 3

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

VBAN_DATATYPE_10BITS

VBAN_DATATYPE_10BITS: 7

VBAN_DATATYPE_12BITS

VBAN_DATATYPE_12BITS: 6

VBAN_DATATYPE_BYTE8

VBAN_DATATYPE_BYTE8: 0

VBAN_DATATYPE_FLOAT32

VBAN_DATATYPE_FLOAT32: 4

VBAN_DATATYPE_FLOAT64

VBAN_DATATYPE_FLOAT64: 5

VBAN_DATATYPE_INT16

VBAN_DATATYPE_INT16: 1

VBAN_DATATYPE_INT24

VBAN_DATATYPE_INT24: 2

VBAN_DATATYPE_INT32

VBAN_DATATYPE_INT32: 3

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/ECodecs.html b/enums/ECodecs.html index ba8eb72f..79ff12cf 100644 --- a/enums/ECodecs.html +++ b/enums/ECodecs.html @@ -1,4 +1,4 @@ -ECodecs | vban - v1.2.4

Enumeration ECodecs

Enumeration Members

VBAN_CODEC_PCM +ECodecs | vban - v1.2.5

Enumeration ECodecs

Enumeration Members

VBAN_CODEC_PCM VBAN_CODEC_UNDEFINED_1 VBAN_CODEC_UNDEFINED_10 VBAN_CODEC_UNDEFINED_11 @@ -14,4 +14,4 @@ VBAN_CODEC_USER VBAN_CODEC_VBCA VBAN_CODEC_VBCV -

Enumeration Members

VBAN_CODEC_PCM

VBAN_CODEC_PCM: 0

VBAN_CODEC_UNDEFINED_1

VBAN_CODEC_UNDEFINED_1: 48

VBAN_CODEC_UNDEFINED_10

VBAN_CODEC_UNDEFINED_10: 192

VBAN_CODEC_UNDEFINED_11

VBAN_CODEC_UNDEFINED_11: 208

VBAN_CODEC_UNDEFINED_12

VBAN_CODEC_UNDEFINED_12: 224

VBAN_CODEC_UNDEFINED_2

VBAN_CODEC_UNDEFINED_2: 64

VBAN_CODEC_UNDEFINED_3

VBAN_CODEC_UNDEFINED_3: 80

VBAN_CODEC_UNDEFINED_4

VBAN_CODEC_UNDEFINED_4: 96

VBAN_CODEC_UNDEFINED_5

VBAN_CODEC_UNDEFINED_5: 112

VBAN_CODEC_UNDEFINED_6

VBAN_CODEC_UNDEFINED_6: 128

VBAN_CODEC_UNDEFINED_7

VBAN_CODEC_UNDEFINED_7: 144

VBAN_CODEC_UNDEFINED_8

VBAN_CODEC_UNDEFINED_8: 160

VBAN_CODEC_UNDEFINED_9

VBAN_CODEC_UNDEFINED_9: 176

VBAN_CODEC_USER

VBAN_CODEC_USER: 240

VBAN_CODEC_VBCA

VBAN_CODEC_VBCA: 16

VBAN_CODEC_VBCV

VBAN_CODEC_VBCV: 32

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

VBAN_CODEC_PCM

VBAN_CODEC_PCM: 0

VBAN_CODEC_UNDEFINED_1

VBAN_CODEC_UNDEFINED_1: 48

VBAN_CODEC_UNDEFINED_10

VBAN_CODEC_UNDEFINED_10: 192

VBAN_CODEC_UNDEFINED_11

VBAN_CODEC_UNDEFINED_11: 208

VBAN_CODEC_UNDEFINED_12

VBAN_CODEC_UNDEFINED_12: 224

VBAN_CODEC_UNDEFINED_2

VBAN_CODEC_UNDEFINED_2: 64

VBAN_CODEC_UNDEFINED_3

VBAN_CODEC_UNDEFINED_3: 80

VBAN_CODEC_UNDEFINED_4

VBAN_CODEC_UNDEFINED_4: 96

VBAN_CODEC_UNDEFINED_5

VBAN_CODEC_UNDEFINED_5: 112

VBAN_CODEC_UNDEFINED_6

VBAN_CODEC_UNDEFINED_6: 128

VBAN_CODEC_UNDEFINED_7

VBAN_CODEC_UNDEFINED_7: 144

VBAN_CODEC_UNDEFINED_8

VBAN_CODEC_UNDEFINED_8: 160

VBAN_CODEC_UNDEFINED_9

VBAN_CODEC_UNDEFINED_9: 176

VBAN_CODEC_USER

VBAN_CODEC_USER: 240

VBAN_CODEC_VBCA

VBAN_CODEC_VBCA: 16

VBAN_CODEC_VBCV

VBAN_CODEC_VBCV: 32

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/EFormatBit.html b/enums/EFormatBit.html index cf129d2a..86e14cd9 100644 --- a/enums/EFormatBit.html +++ b/enums/EFormatBit.html @@ -1,3 +1,3 @@ -EFormatBit | vban - v1.2.4

Enumeration EFormatBit

Enumeration Members

VBAN_DATATYPE_BYTE8 +EFormatBit | vban - v1.2.5

Enumeration EFormatBit

Enumeration Members

VBAN_DATATYPE_BYTE8

Enumeration Members

VBAN_DATATYPE_BYTE8

VBAN_DATATYPE_BYTE8: 0

0 to 255

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/ESerialStreamType.html b/enums/ESerialStreamType.html index 05ad6a52..e02d1c39 100644 --- a/enums/ESerialStreamType.html +++ b/enums/ESerialStreamType.html @@ -1,4 +1,4 @@ -ESerialStreamType | vban - v1.2.4

Enumeration ESerialStreamType

Enumeration Members

VBAN_SERIAL_GENERIC +ESerialStreamType | vban - v1.2.5

Enumeration ESerialStreamType

Enumeration Members

VBAN_SERIAL_GENERIC VBAN_SERIAL_MIDI VBAN_SERIAL_UNDEFINED_10 VBAN_SERIAL_UNDEFINED_11 @@ -14,4 +14,4 @@ VBAN_SERIAL_UNDEFINED_8 VBAN_SERIAL_UNDEFINED_9 VBAN_SERIAL_USER -

Enumeration Members

VBAN_SERIAL_GENERIC

VBAN_SERIAL_GENERIC: 0

VBAN_SERIAL_MIDI

VBAN_SERIAL_MIDI: 16

VBAN_SERIAL_UNDEFINED_10

VBAN_SERIAL_UNDEFINED_10: 160

VBAN_SERIAL_UNDEFINED_11

VBAN_SERIAL_UNDEFINED_11: 176

VBAN_SERIAL_UNDEFINED_12

VBAN_SERIAL_UNDEFINED_12: 192

VBAN_SERIAL_UNDEFINED_13

VBAN_SERIAL_UNDEFINED_13: 208

VBAN_SERIAL_UNDEFINED_14

VBAN_SERIAL_UNDEFINED_14: 224

VBAN_SERIAL_UNDEFINED_2

VBAN_SERIAL_UNDEFINED_2: 32

VBAN_SERIAL_UNDEFINED_3

VBAN_SERIAL_UNDEFINED_3: 48

VBAN_SERIAL_UNDEFINED_4

VBAN_SERIAL_UNDEFINED_4: 64

VBAN_SERIAL_UNDEFINED_5

VBAN_SERIAL_UNDEFINED_5: 80

VBAN_SERIAL_UNDEFINED_6

VBAN_SERIAL_UNDEFINED_6: 96

VBAN_SERIAL_UNDEFINED_7

VBAN_SERIAL_UNDEFINED_7: 112

VBAN_SERIAL_UNDEFINED_8

VBAN_SERIAL_UNDEFINED_8: 128

VBAN_SERIAL_UNDEFINED_9

VBAN_SERIAL_UNDEFINED_9: 144

VBAN_SERIAL_USER

VBAN_SERIAL_USER: 240

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

VBAN_SERIAL_GENERIC

VBAN_SERIAL_GENERIC: 0

VBAN_SERIAL_MIDI

VBAN_SERIAL_MIDI: 16

VBAN_SERIAL_UNDEFINED_10

VBAN_SERIAL_UNDEFINED_10: 160

VBAN_SERIAL_UNDEFINED_11

VBAN_SERIAL_UNDEFINED_11: 176

VBAN_SERIAL_UNDEFINED_12

VBAN_SERIAL_UNDEFINED_12: 192

VBAN_SERIAL_UNDEFINED_13

VBAN_SERIAL_UNDEFINED_13: 208

VBAN_SERIAL_UNDEFINED_14

VBAN_SERIAL_UNDEFINED_14: 224

VBAN_SERIAL_UNDEFINED_2

VBAN_SERIAL_UNDEFINED_2: 32

VBAN_SERIAL_UNDEFINED_3

VBAN_SERIAL_UNDEFINED_3: 48

VBAN_SERIAL_UNDEFINED_4

VBAN_SERIAL_UNDEFINED_4: 64

VBAN_SERIAL_UNDEFINED_5

VBAN_SERIAL_UNDEFINED_5: 80

VBAN_SERIAL_UNDEFINED_6

VBAN_SERIAL_UNDEFINED_6: 96

VBAN_SERIAL_UNDEFINED_7

VBAN_SERIAL_UNDEFINED_7: 112

VBAN_SERIAL_UNDEFINED_8

VBAN_SERIAL_UNDEFINED_8: 128

VBAN_SERIAL_UNDEFINED_9

VBAN_SERIAL_UNDEFINED_9: 144

VBAN_SERIAL_USER

VBAN_SERIAL_USER: 240

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/EServiceFunction.html b/enums/EServiceFunction.html index 6ca136d3..940cbc0c 100644 --- a/enums/EServiceFunction.html +++ b/enums/EServiceFunction.html @@ -1,3 +1,3 @@ -EServiceFunction | vban - v1.2.4

Enumeration EServiceFunction

Enumeration Members

PING0 +EServiceFunction | vban - v1.2.5

Enumeration EServiceFunction

Enumeration Members

PING0 REPLY -

Enumeration Members

PING0

PING0: 0

REPLY

REPLY: 128

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

PING0

PING0: 0

REPLY

REPLY: 128

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/EServicePINGApplicationType.html b/enums/EServicePINGApplicationType.html index 2f4c218c..ac9cc9c2 100644 --- a/enums/EServicePINGApplicationType.html +++ b/enums/EServicePINGApplicationType.html @@ -1,4 +1,4 @@ -EServicePINGApplicationType | vban - v1.2.4

Enumeration EServicePINGApplicationType

Enumeration Members

DAW +EServicePINGApplicationType | vban - v1.2.5

Enumeration EServicePINGApplicationType

Enumeration Members

DAW MATRIX RECEPTOR RECEPTORSPOT @@ -8,4 +8,4 @@ UNKNOWN VIRTUALDEVICE VIRTUALMIXER -

Enumeration Members

DAW

DAW: 128

MATRIX

MATRIX: 64

RECEPTOR

RECEPTOR: 1

RECEPTORSPOT

RECEPTORSPOT: 4

SERVER

SERVER: 16777216

TRANSMITTER

TRANSMITTER: 2

TRANSMITTERSPOT

TRANSMITTERSPOT: 8

UNKNOWN

UNKNOWN: 0

VIRTUALDEVICE

VIRTUALDEVICE: 16

VIRTUALMIXER

VIRTUALMIXER: 32

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

DAW

DAW: 128

MATRIX

MATRIX: 64

RECEPTOR

RECEPTOR: 1

RECEPTORSPOT

RECEPTORSPOT: 4

SERVER

SERVER: 16777216

TRANSMITTER

TRANSMITTER: 2

TRANSMITTERSPOT

TRANSMITTERSPOT: 8

UNKNOWN

UNKNOWN: 0

VIRTUALDEVICE

VIRTUALDEVICE: 16

VIRTUALMIXER

VIRTUALMIXER: 32

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/EServicePINGFeatures.html b/enums/EServicePINGFeatures.html index c9b0643f..7232420c 100644 --- a/enums/EServicePINGFeatures.html +++ b/enums/EServicePINGFeatures.html @@ -1,8 +1,8 @@ -EServicePINGFeatures | vban - v1.2.4

Enumeration EServicePINGFeatures

Enumeration Members

AOIP +EServicePINGFeatures | vban - v1.2.5

Enumeration EServicePINGFeatures

Enumeration Members

AOIP AUDIO FRAME MIDI SERIAL TXT VOIP -

Enumeration Members

AOIP

AOIP: 2

AUDIO

AUDIO: 1

FRAME

FRAME: 4096

MIDI

MIDI: 768

SERIAL

SERIAL: 256

TXT

TXT: 65536

VOIP

VOIP: 4

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

AOIP

AOIP: 2

AUDIO

AUDIO: 1

FRAME

FRAME: 4096

MIDI

MIDI: 768

SERIAL

SERIAL: 256

TXT

TXT: 65536

VOIP

VOIP: 4

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/EServiceType.html b/enums/EServiceType.html index 0a845516..4ab880fd 100644 --- a/enums/EServiceType.html +++ b/enums/EServiceType.html @@ -1,5 +1,5 @@ -EServiceType | vban - v1.2.4

Enumeration EServiceType

Enumeration Members

CHATUTF8 +EServiceType | vban - v1.2.5

Enumeration EServiceType

Enumeration Members

CHATUTF8 IDENTIFICATION RTPACKET RTPACKETREGISTER -

Enumeration Members

CHATUTF8

CHATUTF8: 1

IDENTIFICATION

IDENTIFICATION: 0

RTPACKET

RTPACKET: 33

RTPACKETREGISTER

RTPACKETREGISTER: 32

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

CHATUTF8

CHATUTF8: 1

IDENTIFICATION

IDENTIFICATION: 0

RTPACKET

RTPACKET: 33

RTPACKETREGISTER

RTPACKETREGISTER: 32

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/ESubProtocol.html b/enums/ESubProtocol.html index cc91bb00..4c0a1de1 100644 --- a/enums/ESubProtocol.html +++ b/enums/ESubProtocol.html @@ -1,5 +1,5 @@ -ESubProtocol | vban - v1.2.4

Enumeration ESubProtocol

Enumeration Members

AUDIO +ESubProtocol | vban - v1.2.5

Enumeration ESubProtocol

Enumeration Members

AUDIO SERIAL SERVICE TEXT -

Enumeration Members

AUDIO

AUDIO: 0

SERIAL

SERIAL: 32

SERVICE

SERVICE: 96

TEXT

TEXT: 64

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

AUDIO

AUDIO: 0

SERIAL

SERIAL: 32

SERVICE

SERVICE: 96

TEXT

TEXT: 64

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/ETextEncoding.html b/enums/ETextEncoding.html index c6ff5443..613c2d10 100644 --- a/enums/ETextEncoding.html +++ b/enums/ETextEncoding.html @@ -1,4 +1,4 @@ -ETextEncoding | vban - v1.2.4

Enumeration ETextEncoding

Enumeration Members

VBAN_SERIAL_UNDEFINED_10 +ETextEncoding | vban - v1.2.5

Enumeration ETextEncoding

Enumeration Members

VBAN_SERIAL_UNDEFINED_10 VBAN_SERIAL_UNDEFINED_11 VBAN_SERIAL_UNDEFINED_12 VBAN_SERIAL_UNDEFINED_13 @@ -14,4 +14,4 @@ VBAN_TXT_ASCII VBAN_TXT_UTF8 VBAN_TXT_WCHAR -

Enumeration Members

VBAN_SERIAL_UNDEFINED_10

VBAN_SERIAL_UNDEFINED_10: 160

VBAN_SERIAL_UNDEFINED_11

VBAN_SERIAL_UNDEFINED_11: 176

VBAN_SERIAL_UNDEFINED_12

VBAN_SERIAL_UNDEFINED_12: 192

VBAN_SERIAL_UNDEFINED_13

VBAN_SERIAL_UNDEFINED_13: 208

VBAN_SERIAL_UNDEFINED_14

VBAN_SERIAL_UNDEFINED_14: 224

VBAN_SERIAL_UNDEFINED_3

VBAN_SERIAL_UNDEFINED_3: 48

VBAN_SERIAL_UNDEFINED_4

VBAN_SERIAL_UNDEFINED_4: 64

VBAN_SERIAL_UNDEFINED_5

VBAN_SERIAL_UNDEFINED_5: 80

VBAN_SERIAL_UNDEFINED_6

VBAN_SERIAL_UNDEFINED_6: 96

VBAN_SERIAL_UNDEFINED_7

VBAN_SERIAL_UNDEFINED_7: 112

VBAN_SERIAL_UNDEFINED_8

VBAN_SERIAL_UNDEFINED_8: 128

VBAN_SERIAL_UNDEFINED_9

VBAN_SERIAL_UNDEFINED_9: 144

VBAN_SERIAL_USER

VBAN_SERIAL_USER: 240

VBAN_TXT_ASCII

VBAN_TXT_ASCII: 0

VBAN_TXT_UTF8

VBAN_TXT_UTF8: 16

VBAN_TXT_WCHAR

VBAN_TXT_WCHAR: 32

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

VBAN_SERIAL_UNDEFINED_10

VBAN_SERIAL_UNDEFINED_10: 160

VBAN_SERIAL_UNDEFINED_11

VBAN_SERIAL_UNDEFINED_11: 176

VBAN_SERIAL_UNDEFINED_12

VBAN_SERIAL_UNDEFINED_12: 192

VBAN_SERIAL_UNDEFINED_13

VBAN_SERIAL_UNDEFINED_13: 208

VBAN_SERIAL_UNDEFINED_14

VBAN_SERIAL_UNDEFINED_14: 224

VBAN_SERIAL_UNDEFINED_3

VBAN_SERIAL_UNDEFINED_3: 48

VBAN_SERIAL_UNDEFINED_4

VBAN_SERIAL_UNDEFINED_4: 64

VBAN_SERIAL_UNDEFINED_5

VBAN_SERIAL_UNDEFINED_5: 80

VBAN_SERIAL_UNDEFINED_6

VBAN_SERIAL_UNDEFINED_6: 96

VBAN_SERIAL_UNDEFINED_7

VBAN_SERIAL_UNDEFINED_7: 112

VBAN_SERIAL_UNDEFINED_8

VBAN_SERIAL_UNDEFINED_8: 128

VBAN_SERIAL_UNDEFINED_9

VBAN_SERIAL_UNDEFINED_9: 144

VBAN_SERIAL_USER

VBAN_SERIAL_USER: 240

VBAN_TXT_ASCII

VBAN_TXT_ASCII: 0

VBAN_TXT_UTF8

VBAN_TXT_UTF8: 16

VBAN_TXT_WCHAR

VBAN_TXT_WCHAR: 32

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/cleanPacketString.html b/functions/cleanPacketString.html index a1e3ca1c..f50f43a5 100644 --- a/functions/cleanPacketString.html +++ b/functions/cleanPacketString.html @@ -1 +1 @@ -cleanPacketString | vban - v1.2.4

Function cleanPacketString

  • cleanPacketString(str): string

  • Parameters

    • str: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +cleanPacketString | vban - v1.2.5

Function cleanPacketString

  • cleanPacketString(str): string

  • Parameters

    • str: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/dec2bin.html b/functions/dec2bin.html index bd1d82f3..cc63b6cb 100644 --- a/functions/dec2bin.html +++ b/functions/dec2bin.html @@ -1 +1 @@ -dec2bin | vban - v1.2.4

Function dec2bin

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +dec2bin | vban - v1.2.5

Function dec2bin

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/prepareStringForPacket.html b/functions/prepareStringForPacket.html index 9888a121..341e286a 100644 --- a/functions/prepareStringForPacket.html +++ b/functions/prepareStringForPacket.html @@ -1 +1 @@ -prepareStringForPacket | vban - v1.2.4

Function prepareStringForPacket

  • prepareStringForPacket(str, maxLength): string

  • Parameters

    • str: string
    • maxLength: number

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +prepareStringForPacket | vban - v1.2.5

Function prepareStringForPacket

  • prepareStringForPacket(str, maxLength): string

  • Parameters

    • str: string
    • maxLength: number

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/hierarchy.html b/hierarchy.html index e674d347..9e9858f2 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -vban - v1.2.4

vban - v1.2.4

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +vban - v1.2.5

vban - v1.2.5

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index 59fb3ce9..39a62d6a 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -vban - v1.2.4

vban - v1.2.4

VBAN

NPM version +vban - v1.2.5

vban - v1.2.5

VBAN

NPM version CI codecov Downloads @@ -39,4 +39,4 @@ He does the job for audio part, and the example .

And a big thanks to VB-Audio, for the VBAN protocol

Donations

If you want to do a donations, please do it on the VBAN creator website : https://vb-audio.com/Services/licensing.htm

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IBitResolution.html b/interfaces/IBitResolution.html index f55cf804..cb30869a 100644 --- a/interfaces/IBitResolution.html +++ b/interfaces/IBitResolution.html @@ -1,4 +1,4 @@ -IBitResolution | vban - v1.2.4

Interface IBitResolution

interface IBitResolution {
    bitDepth: number;
    float: boolean;
    signed: boolean;
}

Properties

bitDepth +IBitResolution | vban - v1.2.5

Interface IBitResolution

interface IBitResolution {
    bitDepth: number;
    float: boolean;
    signed: boolean;
}

Properties

bitDepth float signed -

Properties

bitDepth

bitDepth: number

float

float: boolean

signed

signed: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

bitDepth

bitDepth: number

float

float: boolean

signed

signed: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/ISerialBitMode.html b/interfaces/ISerialBitMode.html index cb7c8505..a997c03a 100644 --- a/interfaces/ISerialBitMode.html +++ b/interfaces/ISerialBitMode.html @@ -1,24 +1,24 @@ -ISerialBitMode | vban - v1.2.4

Interface ISerialBitMode

interface ISerialBitMode {
    multipart: boolean;
    parity: boolean;
    start: boolean;
    stop: null | number;
}

Properties

multipart +ISerialBitMode | vban - v1.2.5

Interface ISerialBitMode

interface ISerialBitMode {
    multipart: boolean;
    parity: boolean;
    start: boolean;
    stop: null | number;
}

Properties

multipart parity start stop

Properties

multipart

multipart: boolean

Set to true if the serial data block requires several VBAN Packets (1436 BYTE max) to be completed.

-

parity

parity: boolean

PARITY CHECKING:

+

parity

parity: boolean

PARITY CHECKING:

  • false : no parity checking
  • true : parity checking.
-

start

start: boolean

START BIT

+

start

start: boolean

START BIT

  • false : no start bit
  • true : start bit.
-

stop

stop: null | number

STOP BIT

+

stop

stop: null | number

STOP BIT

  • 1 stop bit
  • 1,5 stop bit.
  • 2 stop bit.
  • null : unused
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IServicePing.html b/interfaces/IServicePing.html index d2479146..18f0fd98 100644 --- a/interfaces/IServicePing.html +++ b/interfaces/IServicePing.html @@ -1,4 +1,4 @@ -IServicePing | vban - v1.2.4

Interface IServicePing

interface IServicePing {
    GPSPosition: string;
    PreferredRate: number;
    applicationName: string;
    applicationType: EServicePINGApplicationType;
    bitFeatureEx: number;
    color: {
        blue: number;
        green: number;
        red: number;
    };
    deviceName: string;
    features: EServicePINGFeatures[];
    langCode: string;
    manufacturerName: string;
    maxRate: number;
    minRate: number;
    nVersion: number;
    reservedASCII: string;
    reservedEx: string;
    reservedEx2: string;
    reservedLongASCII: string;
    userComment: string;
    userName: string;
    userPosition: string;
}

Properties

GPSPosition +IServicePing | vban - v1.2.5

Interface IServicePing

interface IServicePing {
    GPSPosition: string;
    PreferredRate: number;
    applicationName: string;
    applicationType: EServicePINGApplicationType;
    bitFeatureEx: number;
    color: {
        blue: number;
        green: number;
        red: number;
    };
    deviceName: string;
    features: EServicePINGFeatures[];
    langCode: string;
    manufacturerName: string;
    maxRate: number;
    minRate: number;
    nVersion: number;
    reservedASCII: string;
    reservedEx: string;
    reservedEx2: string;
    reservedLongASCII: string;
    userComment: string;
    userName: string;
    userPosition: string;
}

Properties

GPSPosition PreferredRate applicationName applicationType @@ -18,4 +18,4 @@ userComment userName userPosition -

Properties

GPSPosition

GPSPosition: string

PreferredRate

PreferredRate: number

applicationName

applicationName: string

applicationType

applicationType: EServicePINGApplicationType

bitFeatureEx

bitFeatureEx: number

color

color: {
    blue: number;
    green: number;
    red: number;
}

Type declaration

  • blue: number
  • green: number
  • red: number

deviceName

deviceName: string

features

features: EServicePINGFeatures[]

langCode

langCode: string

manufacturerName

manufacturerName: string

maxRate

maxRate: number

minRate

minRate: number

nVersion

nVersion: number

reservedASCII

reservedASCII: string

reservedEx

reservedEx: string

reservedEx2

reservedEx2: string

reservedLongASCII

reservedLongASCII: string

userComment

userComment: string

userName

userName: string

userPosition

userPosition: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

GPSPosition

GPSPosition: string

PreferredRate

PreferredRate: number

applicationName

applicationName: string

applicationType

applicationType: EServicePINGApplicationType

bitFeatureEx

bitFeatureEx: number

color

color: {
    blue: number;
    green: number;
    red: number;
}

Type declaration

  • blue: number
  • green: number
  • red: number

deviceName

deviceName: string

features

features: EServicePINGFeatures[]

langCode

langCode: string

manufacturerName

manufacturerName: string

maxRate

maxRate: number

minRate

minRate: number

nVersion

nVersion: number

reservedASCII

reservedASCII: string

reservedEx

reservedEx: string

reservedEx2

reservedEx2: string

reservedLongASCII

reservedLongASCII: string

userComment

userComment: string

userName

userName: string

userPosition

userPosition: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IVBANHeader.html b/interfaces/IVBANHeader.html index d6d43b16..205551b1 100644 --- a/interfaces/IVBANHeader.html +++ b/interfaces/IVBANHeader.html @@ -1,6 +1,6 @@ -IVBANHeader | vban - v1.2.4

Interface IVBANHeader

interface IVBANHeader {
    frameCounter?: number;
    sp: ESubProtocol;
    sr: number;
    srIndex?: number;
    streamName: string;
}

Hierarchy (view full)

Properties

frameCounter? +IVBANHeader | vban - v1.2.5

Interface IVBANHeader

interface IVBANHeader {
    frameCounter?: number;
    sp: ESubProtocol;
    sr: number;
    srIndex?: number;
    streamName: string;
}

Hierarchy (view full)

Properties

frameCounter? sp sr srIndex? streamName -

Properties

Optional frameCounter

frameCounter?: number

sp

sp: ESubProtocol

sr

sr: number

Optional srIndex

srIndex?: number

streamName

streamName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional frameCounter

frameCounter?: number

sp

sp: ESubProtocol

sr

sr: number

Optional srIndex

srIndex?: number

streamName

streamName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IVBANHeaderAudio.html b/interfaces/IVBANHeaderAudio.html index 969fbfe3..7418e724 100644 --- a/interfaces/IVBANHeaderAudio.html +++ b/interfaces/IVBANHeaderAudio.html @@ -1,4 +1,4 @@ -IVBANHeaderAudio | vban - v1.2.4

Interface IVBANHeaderAudio

interface IVBANHeaderAudio {
    bitResolution: number;
    codec: number;
    frameCounter?: number;
    nbChannel: number;
    nbSample: number;
    sr: number;
    srIndex?: number;
    streamName: string;
}

Hierarchy

Properties

bitResolution +IVBANHeaderAudio | vban - v1.2.5

Interface IVBANHeaderAudio

interface IVBANHeaderAudio {
    bitResolution: number;
    codec: number;
    frameCounter?: number;
    nbChannel: number;
    nbSample: number;
    sr: number;
    srIndex?: number;
    streamName: string;
}

Hierarchy

Properties

bitResolution codec frameCounter? nbChannel @@ -6,4 +6,4 @@ sr srIndex? streamName -

Properties

bitResolution

bitResolution: number

codec

codec: number

Optional frameCounter

frameCounter?: number

nbChannel

nbChannel: number

nbSample

nbSample: number

sr

sr: number

Optional srIndex

srIndex?: number

streamName

streamName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

bitResolution

bitResolution: number

codec

codec: number

Optional frameCounter

frameCounter?: number

nbChannel

nbChannel: number

nbSample

nbSample: number

sr

sr: number

Optional srIndex

srIndex?: number

streamName

streamName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IVBANHeaderCommon.html b/interfaces/IVBANHeaderCommon.html index bc69171c..c8cff048 100644 --- a/interfaces/IVBANHeaderCommon.html +++ b/interfaces/IVBANHeaderCommon.html @@ -1,4 +1,4 @@ -IVBANHeaderCommon | vban - v1.2.4

Interface IVBANHeaderCommon

interface IVBANHeaderCommon {
    frameCounter?: number;
    part1: number;
    part2: number;
    part3: number;
    sp: ESubProtocol;
    sr: number;
    srIndex?: number;
    streamName: string;
}

Hierarchy (view full)

Properties

frameCounter? +IVBANHeaderCommon | vban - v1.2.5

Interface IVBANHeaderCommon

interface IVBANHeaderCommon {
    frameCounter?: number;
    part1: number;
    part2: number;
    part3: number;
    sp: ESubProtocol;
    sr: number;
    srIndex?: number;
    streamName: string;
}

Hierarchy (view full)

Properties

frameCounter? part1 part2 part3 @@ -6,4 +6,4 @@ sr srIndex? streamName -

Properties

Optional frameCounter

frameCounter?: number

part1

part1: number

part2

part2: number

part3

part3: number

sp

sp: ESubProtocol

sr

sr: number

Optional srIndex

srIndex?: number

streamName

streamName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional frameCounter

frameCounter?: number

part1

part1: number

part2

part2: number

part3

part3: number

sp

sp: ESubProtocol

sr

sr: number

Optional srIndex

srIndex?: number

streamName

streamName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IVBANHeaderSerial.html b/interfaces/IVBANHeaderSerial.html index 070c5697..9693a51a 100644 --- a/interfaces/IVBANHeaderSerial.html +++ b/interfaces/IVBANHeaderSerial.html @@ -1,4 +1,4 @@ -IVBANHeaderSerial | vban - v1.2.4

Interface IVBANHeaderSerial

interface IVBANHeaderSerial {
    bitMode: ISerialBitMode;
    bps: number;
    channelsIdents: number;
    formatBit: VBAN_DATATYPE_BYTE8;
    frameCounter?: number;
    srIndex?: number;
    streamName: string;
    streamType: ESerialStreamType;
}

Hierarchy

Properties

bitMode +IVBANHeaderSerial | vban - v1.2.5

Interface IVBANHeaderSerial

interface IVBANHeaderSerial {
    bitMode: ISerialBitMode;
    bps: number;
    channelsIdents: number;
    formatBit: VBAN_DATATYPE_BYTE8;
    frameCounter?: number;
    srIndex?: number;
    streamName: string;
    streamType: ESerialStreamType;
}

Hierarchy

Properties

bitMode bps channelsIdents formatBit @@ -7,8 +7,8 @@ streamName streamType

Properties

bitMode

bitMode: ISerialBitMode

VBANSerialPacket.bitMode

-

bps

bps: number

VBANSerialPacket.bps

-

channelsIdents

channelsIdents: number

VBANSerialPacket.channelsIdents

-

formatBit

formatBit: VBAN_DATATYPE_BYTE8

VBANSerialPacket.formatBit

-

Optional frameCounter

frameCounter?: number

Optional srIndex

srIndex?: number

streamName

streamName: string

streamType

streamType: ESerialStreamType

VBANSerialPacket.streamType

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

bps

bps: number

VBANSerialPacket.bps

+

channelsIdents

channelsIdents: number

VBANSerialPacket.channelsIdents

+

formatBit

formatBit: VBAN_DATATYPE_BYTE8

VBANSerialPacket.formatBit

+

Optional frameCounter

frameCounter?: number

Optional srIndex

srIndex?: number

streamName

streamName: string

streamType

streamType: ESerialStreamType

VBANSerialPacket.streamType

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IVBANHeaderService.html b/interfaces/IVBANHeaderService.html index 98a8a00e..296311fd 100644 --- a/interfaces/IVBANHeaderService.html +++ b/interfaces/IVBANHeaderService.html @@ -1,8 +1,8 @@ -IVBANHeaderService | vban - v1.2.4

Interface IVBANHeaderService

interface IVBANHeaderService {
    frameCounter?: number;
    isReply?: boolean;
    service: EServiceType;
    serviceFunction: EServiceFunction;
    srIndex?: number;
    streamName: string;
}

Hierarchy

Properties

frameCounter? +IVBANHeaderService | vban - v1.2.5

Interface IVBANHeaderService

interface IVBANHeaderService {
    frameCounter?: number;
    isReply?: boolean;
    service: EServiceType;
    serviceFunction: EServiceFunction;
    srIndex?: number;
    streamName: string;
}

Hierarchy

Properties

frameCounter? isReply? service serviceFunction srIndex? streamName -

Properties

Optional frameCounter

frameCounter?: number

Optional isReply

isReply?: boolean

service

service: EServiceType

serviceFunction

serviceFunction: EServiceFunction

can be 0 for PING0, or 0x80 for REPLY

-

Optional srIndex

srIndex?: number

streamName

streamName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional frameCounter

frameCounter?: number

Optional isReply

isReply?: boolean

service

service: EServiceType

serviceFunction

serviceFunction: EServiceFunction

can be 0 for PING0, or 0x80 for REPLY

+

Optional srIndex

srIndex?: number

streamName

streamName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IVBANHeaderTEXT.html b/interfaces/IVBANHeaderTEXT.html index d50c8d36..e87d752b 100644 --- a/interfaces/IVBANHeaderTEXT.html +++ b/interfaces/IVBANHeaderTEXT.html @@ -1,8 +1,8 @@ -IVBANHeaderTEXT | vban - v1.2.4

Interface IVBANHeaderTEXT

interface IVBANHeaderTEXT {
    bps?: number;
    channelsIdents?: number;
    encoding: ETextEncoding;
    formatBit?: VBAN_DATATYPE_BYTE8;
    frameCounter?: number;
    srIndex?: number;
    streamName: string;
}

Hierarchy

Properties

bps? +IVBANHeaderTEXT | vban - v1.2.5

Interface IVBANHeaderTEXT

interface IVBANHeaderTEXT {
    bps?: number;
    channelsIdents?: number;
    encoding: ETextEncoding;
    formatBit?: VBAN_DATATYPE_BYTE8;
    frameCounter?: number;
    srIndex?: number;
    streamName: string;
}

Hierarchy

Properties

bps? channelsIdents? encoding formatBit? frameCounter? srIndex? streamName -

Properties

Optional bps

bps?: number

Optional channelsIdents

channelsIdents?: number

encoding

encoding: ETextEncoding

Optional formatBit

formatBit?: VBAN_DATATYPE_BYTE8

Optional frameCounter

frameCounter?: number

Optional srIndex

srIndex?: number

streamName

streamName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional bps

bps?: number

Optional channelsIdents

channelsIdents?: number

encoding

encoding: ETextEncoding

Optional formatBit

formatBit?: VBAN_DATATYPE_BYTE8

Optional frameCounter

frameCounter?: number

Optional srIndex

srIndex?: number

streamName

streamName: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IVBANServerOptions.html b/interfaces/IVBANServerOptions.html index d1bb6ec8..3cc80cd1 100644 --- a/interfaces/IVBANServerOptions.html +++ b/interfaces/IVBANServerOptions.html @@ -1,7 +1,7 @@ -IVBANServerOptions | vban - v1.2.4

Interface IVBANServerOptions

interface IVBANServerOptions {
    application?: {
        GPSPosition?: string;
        PreferredRate?: number;
        applicationName?: string;
        applicationType?: EServicePINGApplicationType;
        bitFeatureEx?: number;
        color?: {
            blue: number;
            green: number;
            red: number;
        };
        deviceName?: string;
        features?: EServicePINGFeatures[];
        langCode?: string;
        manufacturerName?: string;
        maxRate?: number;
        minRate?: number;
        nVersion?: number;
        userComment?: string;
        userName?: string;
        userPosition?: string;
    };
    autoReplyToPing?: boolean;
    beforeProcessPacket?: ((msg, sender) => boolean);
}

Properties

application? +IVBANServerOptions | vban - v1.2.5

Interface IVBANServerOptions

interface IVBANServerOptions {
    application?: {
        GPSPosition?: string;
        PreferredRate?: number;
        applicationName?: string;
        applicationType?: EServicePINGApplicationType;
        bitFeatureEx?: number;
        color?: {
            blue: number;
            green: number;
            red: number;
        };
        deviceName?: string;
        features?: EServicePINGFeatures[];
        langCode?: string;
        manufacturerName?: string;
        maxRate?: number;
        minRate?: number;
        nVersion?: number;
        userComment?: string;
        userName?: string;
        userPosition?: string;
    };
    autoReplyToPing?: boolean;
    beforeProcessPacket?: ((msg, sender) => boolean);
}

Properties

application? autoReplyToPing? beforeProcessPacket? -

Properties

Optional application

application?: {
    GPSPosition?: string;
    PreferredRate?: number;
    applicationName?: string;
    applicationType?: EServicePINGApplicationType;
    bitFeatureEx?: number;
    color?: {
        blue: number;
        green: number;
        red: number;
    };
    deviceName?: string;
    features?: EServicePINGFeatures[];
    langCode?: string;
    manufacturerName?: string;
    maxRate?: number;
    minRate?: number;
    nVersion?: number;
    userComment?: string;
    userName?: string;
    userPosition?: string;
}

Type declaration

  • Optional GPSPosition?: string
  • Optional PreferredRate?: number
  • Optional applicationName?: string
  • Optional applicationType?: EServicePINGApplicationType
  • Optional bitFeatureEx?: number
  • Optional color?: {
        blue: number;
        green: number;
        red: number;
    }
    • blue: number
    • green: number
    • red: number
  • Optional deviceName?: string
  • Optional features?: EServicePINGFeatures[]
  • Optional langCode?: string
  • Optional manufacturerName?: string
  • Optional maxRate?: number
  • Optional minRate?: number
  • Optional nVersion?: number
  • Optional userComment?: string
  • Optional userName?: string
  • Optional userPosition?: string

Optional autoReplyToPing

autoReplyToPing?: boolean

will auto send a reply when another app will send a ping

-

Optional beforeProcessPacket

beforeProcessPacket?: ((msg, sender) => boolean)

Return false to stop processing the packet

+

Properties

Optional application

application?: {
    GPSPosition?: string;
    PreferredRate?: number;
    applicationName?: string;
    applicationType?: EServicePINGApplicationType;
    bitFeatureEx?: number;
    color?: {
        blue: number;
        green: number;
        red: number;
    };
    deviceName?: string;
    features?: EServicePINGFeatures[];
    langCode?: string;
    manufacturerName?: string;
    maxRate?: number;
    minRate?: number;
    nVersion?: number;
    userComment?: string;
    userName?: string;
    userPosition?: string;
}

Type declaration

  • Optional GPSPosition?: string
  • Optional PreferredRate?: number
  • Optional applicationName?: string
  • Optional applicationType?: EServicePINGApplicationType
  • Optional bitFeatureEx?: number
  • Optional color?: {
        blue: number;
        green: number;
        red: number;
    }
    • blue: number
    • green: number
    • red: number
  • Optional deviceName?: string
  • Optional features?: EServicePINGFeatures[]
  • Optional langCode?: string
  • Optional manufacturerName?: string
  • Optional maxRate?: number
  • Optional minRate?: number
  • Optional nVersion?: number
  • Optional userComment?: string
  • Optional userName?: string
  • Optional userPosition?: string

Optional autoReplyToPing

autoReplyToPing?: boolean

will auto send a reply when another app will send a ping

+

Optional beforeProcessPacket

beforeProcessPacket?: ((msg, sender) => boolean)

Return false to stop processing the packet

Type declaration

    • (msg, sender): boolean

    • Return false to stop processing the packet

      -

      Parameters

      • msg: Buffer
      • sender: RemoteInfo

      Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/VBANServerEvents.html b/interfaces/VBANServerEvents.html index 2a6f56c8..d4b09052 100644 --- a/interfaces/VBANServerEvents.html +++ b/interfaces/VBANServerEvents.html @@ -1,4 +1,4 @@ -VBANServerEvents | vban - v1.2.4

Interface VBANServerEvents

interface VBANServerEvents {
    error: ((err) => void);
    listening: (() => void);
    message: ((packet, sender) => void);
}

Properties

error +VBANServerEvents | vban - v1.2.5

Interface VBANServerEvents

interface VBANServerEvents {
    error: ((err) => void);
    listening: (() => void);
    message: ((packet, sender) => void);
}

Properties

error listening message -

Properties

error

error: ((err) => void)

Type declaration

    • (err): void

    • Parameters

      • err: Error

      Returns void

listening

listening: (() => void)

Type declaration

    • (): void

    • Returns void

message

message: ((packet, sender) => void)

Type declaration

    • (packet, sender): void

    • Parameters

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

error

error: ((err) => void)

Type declaration

    • (err): void

    • Parameters

      • err: Error

      Returns void

listening

listening: (() => void)

Type declaration

    • (): void

    • Returns void

message

message: ((packet, sender) => void)

Type declaration

    • (packet, sender): void

    • Parameters

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/modules.html b/modules.html index c2e25f1c..fba73292 100644 --- a/modules.html +++ b/modules.html @@ -1,4 +1,4 @@ -vban - v1.2.4

vban - v1.2.4

Index

Enumerations

EBitsResolutions +vban - v1.2.5

vban - v1.2.5

Index

Enumerations

EBitsResolutions ECodecs EFormatBit ESerialStreamType @@ -38,4 +38,4 @@

Functions

cleanPacketString dec2bin prepareStringForPacket -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/VBANPacketTypes.html b/types/VBANPacketTypes.html index 7a8fe233..83bc484f 100644 --- a/types/VBANPacketTypes.html +++ b/types/VBANPacketTypes.html @@ -1 +1 @@ -VBANPacketTypes | vban - v1.2.4

Type alias VBANPacketTypes

VBANPacketTypes: VBANAudioPacket | VBANSerialPacket | VBANTEXTPacket | VBANServicePacket

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +VBANPacketTypes | vban - v1.2.5

Type alias VBANPacketTypes

VBANPacketTypes: VBANAudioPacket | VBANSerialPacket | VBANTEXTPacket | VBANServicePacket

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/BITS_SPEEDS.html b/variables/BITS_SPEEDS.html index f3d1fb55..377bf33e 100644 --- a/variables/BITS_SPEEDS.html +++ b/variables/BITS_SPEEDS.html @@ -1 +1 @@ -BITS_SPEEDS | vban - v1.2.4

Variable BITS_SPEEDSConst

BITS_SPEEDS: Record<number, number> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +BITS_SPEEDS | vban - v1.2.5

Variable BITS_SPEEDSConst

BITS_SPEEDS: Record<number, number> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/MAX_FRAME_COUNTER.html b/variables/MAX_FRAME_COUNTER.html index a94c1ab4..739af161 100644 --- a/variables/MAX_FRAME_COUNTER.html +++ b/variables/MAX_FRAME_COUNTER.html @@ -1 +1 @@ -MAX_FRAME_COUNTER | vban - v1.2.4

Variable MAX_FRAME_COUNTERConst

MAX_FRAME_COUNTER: 4294967295 = 4294967295

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +MAX_FRAME_COUNTER | vban - v1.2.5

Variable MAX_FRAME_COUNTERConst

MAX_FRAME_COUNTER: 4294967295 = 4294967295

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/PACKET_IDENTIFICATION.html b/variables/PACKET_IDENTIFICATION.html index 0b8d32be..07400255 100644 --- a/variables/PACKET_IDENTIFICATION.html +++ b/variables/PACKET_IDENTIFICATION.html @@ -1 +1 @@ -PACKET_IDENTIFICATION | vban - v1.2.4

Variable PACKET_IDENTIFICATIONConst

PACKET_IDENTIFICATION: "VBAN" = 'VBAN'

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +PACKET_IDENTIFICATION | vban - v1.2.5

Variable PACKET_IDENTIFICATIONConst

PACKET_IDENTIFICATION: "VBAN" = 'VBAN'

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/STREAM_NAME_LENGTH.html b/variables/STREAM_NAME_LENGTH.html index eabb2171..0c088e74 100644 --- a/variables/STREAM_NAME_LENGTH.html +++ b/variables/STREAM_NAME_LENGTH.html @@ -1,2 +1,2 @@ -STREAM_NAME_LENGTH | vban - v1.2.4

Variable STREAM_NAME_LENGTHConst

STREAM_NAME_LENGTH: 16 = 16

the stream name is limited to 16 bytes

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +STREAM_NAME_LENGTH | vban - v1.2.5

Variable STREAM_NAME_LENGTHConst

STREAM_NAME_LENGTH: 16 = 16

the stream name is limited to 16 bytes

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/VBAN_DATA_MAX_SIZE.html b/variables/VBAN_DATA_MAX_SIZE.html index 550380a3..7a69a052 100644 --- a/variables/VBAN_DATA_MAX_SIZE.html +++ b/variables/VBAN_DATA_MAX_SIZE.html @@ -1 +1 @@ -VBAN_DATA_MAX_SIZE | vban - v1.2.4

Variable VBAN_DATA_MAX_SIZEConst

VBAN_DATA_MAX_SIZE: 1436 = 1436

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +VBAN_DATA_MAX_SIZE | vban - v1.2.5

Variable VBAN_DATA_MAX_SIZEConst

VBAN_DATA_MAX_SIZE: 1436 = 1436

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/VBAN_PACKET_MAX_SIZE.html b/variables/VBAN_PACKET_MAX_SIZE.html index 35dd78ab..5ae6006d 100644 --- a/variables/VBAN_PACKET_MAX_SIZE.html +++ b/variables/VBAN_PACKET_MAX_SIZE.html @@ -1 +1 @@ -VBAN_PACKET_MAX_SIZE | vban - v1.2.4

Variable VBAN_PACKET_MAX_SIZEConst

VBAN_PACKET_MAX_SIZE: 1464 = 1464

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +VBAN_PACKET_MAX_SIZE | vban - v1.2.5

Variable VBAN_PACKET_MAX_SIZEConst

VBAN_PACKET_MAX_SIZE: 1464 = 1464

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/sampleRates.html b/variables/sampleRates.html index b35bd5b9..e1c6d7ce 100644 --- a/variables/sampleRates.html +++ b/variables/sampleRates.html @@ -1 +1 @@ -sampleRates | vban - v1.2.4

Variable sampleRatesConst

sampleRates: Record<number, number> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +sampleRates | vban - v1.2.5

Variable sampleRatesConst

sampleRates: Record<number, number> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/serialStopModes.html b/variables/serialStopModes.html index 8a769222..c0c7a8bf 100644 --- a/variables/serialStopModes.html +++ b/variables/serialStopModes.html @@ -1 +1 @@ -serialStopModes | vban - v1.2.4

Variable serialStopModesConst

serialStopModes: {
    mode: number;
    stop: number | null;
}[] = ...

Type declaration

  • mode: number
  • stop: number | null

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +serialStopModes | vban - v1.2.5

Variable serialStopModesConst

serialStopModes: {
    mode: number;
    stop: number | null;
}[] = ...

Type declaration

  • mode: number
  • stop: number | null

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file