Class: Device

Members

ip :String

The ip address of the ATEM

Type:

• String

Source:

• index.js, line 173

state :ConnectionState

The current state of the connection. For more information about the possible values see ConnectionState

Type:

• ConnectionState

Source:

• index.js, line 200

(inner) commandQueue :Array.<Command>

Commands we need to send to the atem

Type:

• Array.<Command>

Source:

• index.js, line 248

(inner) commandTimer :Timeout

A timer to ensure commands are sent within 16 milliseconds

Type:

• Timeout

Source:

• index.js, line 253

(inner) communicationTimeout

The timeout of the last received ATEM packet. Used to detect connection loss.

Source:

• index.js, line 262

(inner) incomingPackets :Array.<AtemPacket>

Packets the ATEM sent and have yet to be acknowledged

Type:

• Array.<AtemPacket>

Source:

• index.js, line 243

(inner) ls :Number

The current local sequence number. Local sequence numbers are used to identify sync packets we send to the ATEM.

Type:

• Number

Source:

• index.js, line 233

(inner) pendingPackets :Array.<UserPacket>

Packets we sent to the ATEM but for which we received no acknowledgement yet.

Type:

• Array.<UserPacket>

Source:

• index.js, line 238

(inner) socket

Create a UDP v4 socket

Source:

• index.js, line 168

(inner) syncInterval :Timer

A timer to assure there is a sync message sent every 600 milliseconds.

Type:

• Timer

Source:

• index.js, line 258

(inner) uid :number

Unique identifier A temporary uid is generated to make a connection. When connected, the ATEM will provide another uid for us

Type:

• number

Source:

• index.js, line 227

Methods

changeSourceConfiguration(sourceID, options)

Changes the specified options of the Source Configuration. Note that you don't need to specify all the properties of SourceConfiguration.

Parameters:

Name	Type	Description
sourceID	SourceID
options	SourceConfiguration

Source:

• index.js, line 576

connect()

Initiate a new connection. If already connected it will first disconnect.

Source:

• index.js, line 793

cut()

Performs a cut transition between preview and program

Source:

• index.js, line 566

setPreview(sourceID)

Sets the desired source in preview

Parameters:

Name	Type	Description
sourceID	SourceID	the ID of the source

Source:

• index.js, line 638

setProgram(sourceID)

Sets the desired source in program. (cut transition)

Parameters:

Name	Type	Description
sourceID	SourceID	the ID of the source

Source:

• index.js, line 625

(inner) getPendingPacket(ls) → {UserPacket}

Find a pending packet by local sequence number

Parameters:

Name	Type	Description
ls	Number	Local sequence number

Source:

• index.js, line 278

Returns:

The packet

Type

UserPacket

(inner) handleQueue()

Sends a packet with all the remaining command of the commandQueue

Source:

• index.js, line 540

(inner) sync()

Create and transmit a sync packet to the ATEM.

Source:

• index.js, line 288

Events

auxiliaryOutput

When an auxiliary output changes, this event will be fired.

Properties:

Name	Type	Description
aux	SourceID	The id of the auxiliary output
source	SourceID	The id of the source that is assigned to the auxiliary output

Source:

• index.js, line 776

connectionLost

When the connection with the atem is lost, this event will be fired.

Source:

• index.js, line 850

connectionStateChange

Properties:

Name	Type	Description
state	ConnectionState	The new state

Source:

• index.js, line 211

error

When an error is encountered during communication, this event will be fired.

Type:

• Error

Properties:

Name	Type	Description
Message	String

Source:

• index.js, line 266

inputTally

When the input tally changes, this event will be fired.
By input tally we mean the state (which is: live, preview or neither of them) of one of the camera inputs

Properties:

Name	Type	Description
inputNumber	Number	the index of the input
state	SourceState

Source:

• index.js, line 709

messageTimeout

When a sync message is sent to the atem and the ATEM does not respond in x milliseconds, this event will be fired.

Type:

• Error

Properties:

Name	Type	Description
message	String	The error message

Source:

• index.js, line 383

previewBus

When the selected preview bus changes this event will be fired.

Properties:

Name	Type	Description
source	SourceID	The new preview source

Source:

• index.js, line 750

programBus

When the selected program bus changes this event will be fired.

Properties:

Name	Type	Description
source	SourceID	The new program source

Source:

• index.js, line 763

rawCommand

Type:

• Command

Source:

• index.js, line 474

sourceConfiguration

When the Source Configuration changes, for example: if the display name of input 2 changes, this event will be fired

Properties:

Name	Type	Description
sourceID	SourceID	the identifier of the source
sourceConfiguration	SourceConfiguration	the new configuration of the source

Source:

• index.js, line 692

sourceTally

When the source tally changes, this event will be fired.

Properties:

Name	Type	Description
sourceID	Number	the id of the source
state	SourceState

Source:

• index.js, line 728