ConnectionTCP | node-vmix

vMix Connection via TCP

Hierarchy

ConnectionTCP

Constructors

constructor

new ConnectionTCP(host?: string, options?: { autoReconnect?: boolean; debug?: boolean; debugBuffers?: boolean; disableAutoConnectOnInit?: boolean; onDataCallback?: Function; port?: number; useDataListenersAsFallback?: boolean }): ConnectionTCP

- Defined in modules/connection-tcp.ts:139
Constructor of ConnectionTCP

The socket automatically attempts to connect by default unless the option 'disableAutoConnectOnInit' is set to true

Parameters
- host: string = DEFAULT_HOST
- options: { autoReconnect?: boolean; debug?: boolean; debugBuffers?: boolean; disableAutoConnectOnInit?: boolean; onDataCallback?: Function; port?: number; useDataListenersAsFallback?: boolean } = {}
  - Optional autoReconnect?: boolean
  - Optional debug?: boolean
  - Optional debugBuffers?: boolean
  - Optional disableAutoConnectOnInit?: boolean
  - Optional onDataCallback?: Function
  - Optional port?: number
  - Optional useDataListenersAsFallback?: boolean
Returns ConnectionTCP

Properties

Protected _autoReconnect

_autoReconnect: boolean = true

Protected _buffer

_buffer: Buffer = ...

Protected _debug

_debug: boolean = false

Protected _debugBuffer

_debugBuffer: boolean = false

Print debug messages regarding buffer

Disabled by default

Protected _host

_host: string = DEFAULT_HOST

Protected _isConnected

_isConnected: boolean = false

Connection state

Protected _isRetrying

_isRetrying: boolean = false

Protected _listeners

_listeners: {} = {}

All listeners

Type declaration

[key: string]: Function[]

Protected _port

_port: number = DEFAULT_TCP_PORT

Protected _reconnectionInterval

_reconnectionInterval: null | Timeout = null

Protected _reconnectionIntervalTimeout

_reconnectionIntervalTimeout: number = 10000

Protected _socket

_socket: Socket = ...

Node TCP socket client to vMix instance

Protected _useDataListenersAsFallback

_useDataListenersAsFallback: boolean = true

Emit vMix messages to listeners registered for data as a fallback solution if no listener is registered in the specific custom-listener-type

Enabled by default

Methods

Protected _emitMessage

_emitMessage(message: string): void

- Defined in modules/connection-tcp.ts:511
Emit generic data message

Parameters
- message: string
Returns void

Protected _emitTallyMessage

_emitTallyMessage(message: string): void

- Defined in modules/connection-tcp.ts:542
Emit Tally message

Parameters
- message: string
Returns void

Protected _emitVersionMessage

_emitVersionMessage(message: string): void

- Defined in modules/connection-tcp.ts:570
Emit Version message

Parameters
- message: string
Returns void

Protected _processBuffer

_processBuffer(): void

- Defined in modules/connection-tcp.ts:327
Process received data that is currently in the buffer

Returns void

Protected _processBufferNonXMLmessage

_processBufferNonXMLmessage(messageType: string, messageStatus: string, firstMessage: string, firstMessageByteLength: number): void

- Defined in modules/connection-tcp.ts:400
Parameters
- messageType: string
- messageStatus: string
- firstMessage: string
- firstMessageByteLength: number
Returns void

Protected _processBufferXMLmessage

_processBufferXMLmessage(firstMessage: string, firstMessageLength: number, firstMessageParts: string[]): void

- Defined in modules/connection-tcp.ts:454
Process buffer XML message

Parameters
- firstMessage: string
- firstMessageLength: number
- firstMessageParts: string[]
Returns void

Protected _sendMessageToSocket

_sendMessageToSocket(message: string): Promise<void>

- Defined in modules/connection-tcp.ts:702
Send message to connection

This must be a string of the complete command to execute

The available commands are listed under: https://www.vmix.com/help23/TCPAPI.html See "Commands section"

Parameters
- message: string
Returns Promise<void>

Protected _setHost

_setHost(host: string): void

- Defined in modules/connection-tcp.ts:301
Set host

Parameters
- host: string
Returns void

Protected _setPort

_setPort(port: number): void

- Defined in modules/connection-tcp.ts:315
Set port

Parameters
- port: number
Returns void

clearAllListeners

clearAllListeners(): void

- Defined in modules/connection-tcp.ts:845
Unregister all listeners

Returns void

connect

connect(host?: string, port?: number): Promise<void>

- Defined in modules/connection-tcp.ts:737
Connect

Attempt to establish connection to socket of vMix instance

Parameters
- Optional host: string
- Optional port: number
Returns Promise<void>

connected

connected(): boolean

- Defined in modules/connection-tcp.ts:892
Is currently connected?

Returns boolean

connecting

connecting(): boolean

- Defined in modules/connection-tcp.ts:902
Is currently connecting?

Returns boolean

Protected emitActivatorsMessage

emitActivatorsMessage(message: string): void

- Defined in modules/connection-tcp.ts:521
Emit Activators message

Parameters
- message: string
Returns void

Protected emitXmlMessage

emitXmlMessage(message: string): void

- Defined in modules/connection-tcp.ts:597
Emit XML message

Parameters
- message: string
Returns void

Protected ensureMessageEnding

ensureMessageEnding(message: string): string

- Defined in modules/connection-tcp.ts:679
Parameters
- message: string
Returns string

Protected functionCommandObjectToString

functionCommandObjectToString(command: vMixApiFunctionCommand): string

- Defined in modules/connection-tcp.ts:623
Convert a function command object to the string to execute

Parameters
- command: vMixApiFunctionCommand
Returns string

off

off(listenerType: string, callbackSignature: Function): void

- Defined in modules/connection-tcp.ts:827
Unregister listeners of specific event-type and with a specific callback function-signature

Parameters
- listenerType: string
- callbackSignature: Function
Returns void

on

on(type: string, callback: Function): void

- Defined in modules/connection-tcp.ts:803
Register listener on a specific event type

Parameters
- type: string
- callback: Function
Returns void

send

send(command: string | string[] | vMixApiFunctionCommand | vMixApiFunctionCommand[]): Promise<void>

- Defined in modules/connection-tcp.ts:778
Send one or more messages to socket connection

Messages are requests or command(s) to perform functions to the API

This must be a string or object, or a array of strings or objects (or a mix of object or strings)

The available commands are listed under: https://www.vmix.com/help24/TCPAPI.html See "Commands section"

Parameters
- command: string | string[] | vMixApiFunctionCommand | vMixApiFunctionCommand[]
Returns Promise<void>

shutdown

shutdown(): void

- Defined in modules/connection-tcp.ts:859
Ask to Shutdown and destroy the TCP socket

Returns void

socket

socket(): Socket

- Defined in modules/connection-tcp.ts:885
Get "raw" TCP socket

Returns Socket
Socket | null

Protected stringifyCommand

stringifyCommand(command: string | vMixApiFunctionCommand): string

- Defined in modules/connection-tcp.ts:651
Stringify commands (if necessary)

Parameters
- command: string | vMixApiFunctionCommand
Returns string

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

host: string = DEFAULT_HOST

options: { autoReconnect?: boolean; debug?: boolean; debugBuffers?: boolean; disableAutoConnectOnInit?: boolean; onDataCallback?: Function; port?: number; useDataListenersAsFallback?: boolean } = {}

Optional autoReconnect?: boolean

Optional debug?: boolean

Optional debugBuffers?: boolean

Optional disableAutoConnectOnInit?: boolean

Optional onDataCallback?: Function

Optional port?: number

Optional useDataListenersAsFallback?: boolean

Returns ConnectionTCP

Properties

Protected _autoReconnect

Protected _buffer

Protected _debug

Protected _debugBuffer

Protected _host

Protected _isConnected

Protected _isRetrying

Protected _listeners

Type declaration

[key: string]: Function[]

Protected _port

Protected _reconnectionInterval

Protected _reconnectionIntervalTimeout

Protected _socket

Protected _useDataListenersAsFallback

Methods

Protected _emitMessage

Parameters

message: string

Returns void

Protected _emitTallyMessage

Parameters

message: string

Returns void

Protected _emitVersionMessage

Parameters

message: string

Returns void

Protected _processBuffer

Returns void

Protected _processBufferNonXMLmessage

Parameters

messageType: string

messageStatus: string

firstMessage: string

firstMessageByteLength: number

Returns void

Protected _processBufferXMLmessage

Parameters

firstMessage: string

firstMessageLength: number

firstMessageParts: string[]

Returns void

Protected _sendMessageToSocket

Parameters

message: string

Returns Promise<void>

Protected _setHost

Parameters

host: string

Returns void

Protected _setPort

Parameters

port: number

Returns void

clearAllListeners

Returns void

connect

Parameters

Optional host: string

Optional port: number